org.ros.internal.transport.ClientHandshake Interface Reference

Inheritance diagram for org.ros.internal.transport.ClientHandshake:

List of all members.

Public Member Functions
String	getErrorMessage ()
ConnectionHeader	getOutgoingConnectionHeader ()
boolean	handshake (ConnectionHeader incommingConnectionHeader)

---

Detailed Description

Encapsulates client-side transport handshake logic.

Author:

damonkohler@google.com (Damon Kohler)

Definition at line 24 of file ClientHandshake.java.

---

Member Function Documentation

String org.ros.internal.transport.ClientHandshake.getErrorMessage

(

)

Returns:

the error String returned by the server if an error occurs,

 null 

otherwise

Implemented in org.ros.internal.node.BaseClientHandshake.

ConnectionHeader org.ros.internal.transport.ClientHandshake.getOutgoingConnectionHeader

(

)

Returns:

the outgoing ConnectionHeader

Implemented in org.ros.internal.node.BaseClientHandshake.

boolean org.ros.internal.transport.ClientHandshake.handshake

(

ConnectionHeader

incommingConnectionHeader

)

Parameters:

incommingConnectionHeader

the ConnectionHeader sent by the server

Returns:

 true 

if the handshake is successful,

 false 

otherwise

Implemented in org.ros.internal.node.topic.SubscriberHandshake, and org.ros.internal.node.service.ServiceClientHandshake.

---

The documentation for this interface was generated from the following file:

• ClientHandshake.java