Communicating between two ports via a variant plain-text protocol originally designed for the yarp name server. More...
#include <yarp/os/impl/NameserCarrier.h>
Public Member Functions | |
NameserCarrier () | |
std::string | getName () const override |
Get the name of this connection type ("tcp", "mcast", "shmem", ...) | |
std::string | getSpecifierName () const |
Carrier * | create () const override |
Factory method. | |
bool | checkHeader (const Bytes &header) override |
Given the first 8 bytes received on a connection, decide if this is the right carrier type to use for the rest of the connection. | |
void | getHeader (Bytes &header) const override |
Provide 8 bytes describing this connection sufficiently to allow the other side of a connection to select it. | |
bool | requireAck () const override |
Check if carrier has flow control, requiring sent messages to be acknowledged by recipient. | |
bool | isTextMode () const override |
Check if carrier is textual in nature. | |
bool | supportReply () const override |
This flag is used by YARP to determine whether the connection can carry RPC traffic, that is, messages with replies. | |
bool | canEscape () const override |
Check if carrier can encode administrative messages, as opposed to just user data. | |
bool | sendHeader (ConnectionState &proto) override |
Write a header appropriate to the carrier to the connection, followed by any carrier-specific data. | |
bool | expectSenderSpecifier (ConnectionState &proto) override |
Expect the name of the sending port. | |
bool | expectIndex (ConnectionState &proto) override |
Expect a message header, if there is one for this carrier. | |
bool | sendAck (ConnectionState &proto) override |
Send an acknowledgement, if needed for this carrier. | |
bool | expectAck (ConnectionState &proto) override |
Receive an acknowledgement, if expected for this carrier. | |
bool | respondToHeader (ConnectionState &proto) override |
Respond to the header. | |
bool | expectReplyToHeader (ConnectionState &proto) override |
Process reply to header, if one is expected for this carrier. | |
bool | write (ConnectionState &proto, SizedWriter &writer) override |
Write a message. | |
Public Member Functions inherited from yarp::os::impl::TcpCarrier | |
TcpCarrier (bool requireAckFlag=true) | |
Carrier * | create () const override |
Factory method. | |
std::string | getName () const override |
Get the name of this connection type ("tcp", "mcast", "shmem", ...) | |
virtual int | getSpecifierCode () const |
bool | checkHeader (const yarp::os::Bytes &header) override |
Given the first 8 bytes received on a connection, decide if this is the right carrier type to use for the rest of the connection. | |
void | getHeader (yarp::os::Bytes &header) const override |
Provide 8 bytes describing this connection sufficiently to allow the other side of a connection to select it. | |
void | setParameters (const yarp::os::Bytes &header) override |
Configure this carrier based on the first 8 bytes of the connection. | |
bool | requireAck () const override |
Check if carrier has flow control, requiring sent messages to be acknowledged by recipient. | |
bool | isConnectionless () const override |
Check if this carrier is connectionless (like udp, mcast) or connection based (like tcp). | |
bool | respondToHeader (yarp::os::ConnectionState &proto) override |
Respond to the header. | |
bool | expectReplyToHeader (yarp::os::ConnectionState &proto) override |
Process reply to header, if one is expected for this carrier. | |
Public Member Functions inherited from yarp::os::AbstractCarrier | |
void | setCarrierParams (const yarp::os::Property ¶ms) override |
Configure carrier from port administrative commands. | |
void | getCarrierParams (yarp::os::Property ¶ms) const override |
Get carrier configuration and deliver it by port administrative commands. | |
bool | canAccept () const override |
Check if reading is implemented for this carrier. | |
bool | canOffer () const override |
Check if writing is implemented for this carrier. | |
bool | isLocal () const override |
Check if carrier operates within a single process. | |
std::string | toString () const override |
Get name of carrier. | |
bool | isActive () const override |
Check if carrier is alive and error free. | |
bool | prepareSend (ConnectionState &proto) override |
Perform any initialization needed before writing on a connection. | |
virtual bool | sendIndex (ConnectionState &proto, SizedWriter &writer) |
bool | expectExtraHeader (ConnectionState &proto) override |
Receive any carrier-specific header. | |
bool | defaultSendHeader (ConnectionState &proto) |
Default implementation for the sendHeader method. | |
bool | defaultExpectIndex (ConnectionState &proto) |
Default implementation for the expectIndex method. | |
bool | defaultSendIndex (ConnectionState &proto, SizedWriter &writer) |
Default implementation for the sendIndex method. | |
bool | defaultExpectAck (ConnectionState &proto) |
Default implementation for the expectAck method. | |
bool | defaultSendAck (ConnectionState &proto) |
Default implementation for the sendAck method. | |
int | readYarpInt (ConnectionState &proto) |
Read 8 bytes and interpret them as a YARP number. | |
void | writeYarpInt (int n, ConnectionState &proto) |
Write n as an 8 bytes yarp number. | |
Public Member Functions inherited from yarp::os::Carrier | |
bool | isBroadcast () const override |
Check if this carrier uses a broadcast mechanism. | |
void | handleEnvelope (const std::string &envelope) override |
Carriers that do not distinguish data from administrative headers (i.e. | |
bool | isPush () const override |
Check if carrier is "push" or "pull" style. | |
virtual bool | reply (ConnectionState &proto, SizedWriter &writer) |
void | prepareDisconnect () override |
Do cleanup and preparation for the coming disconnect, if necessary. | |
virtual void | close () |
Close the carrier. | |
virtual | ~Carrier () |
Destructor. | |
virtual std::string | getBootstrapCarrierName () const |
Get the name of the carrier that should be used prior to handshaking, if a port is registered with this carrier as its default carrier. | |
virtual int | connect (const Contact &src, const Contact &dest, const ContactStyle &style, int mode, bool reversed) |
Some carrier types may require special connection logic. | |
bool | modifiesIncomingData () const override |
Check if this carrier modifies incoming data through the Carrier::modifyIncomingData method. | |
ConnectionReader & | modifyIncomingData (ConnectionReader &reader) override |
Modify incoming payload data, if appropriate. | |
bool | acceptIncomingData (ConnectionReader &reader) override |
Determine whether incoming data should be accepted. | |
bool | modifiesOutgoingData () const override |
Check if this carrier modifies outgoing data through the Carrier::modifyOutgoingData method. | |
const PortWriter & | modifyOutgoingData (const PortWriter &writer) override |
Modify outgoing payload data, if appropriate. | |
bool | modifiesReply () const override |
Check if this carrier modifies outgoing data through the Carrier::modifyReply method. | |
PortReader & | modifyReply (PortReader &reader) override |
Modify reply payload data, if appropriate. | |
bool | acceptOutgoingData (const PortWriter &writer) override |
Determine whether outgoing data should be accepted. | |
virtual bool | configure (ConnectionState &proto) |
Give carrier a shot at looking at how the connection is set up. | |
virtual bool | configureFromProperty (yarp::os::Property &options) |
void | setCarrierParams (const Property ¶ms) override |
Configure carrier from port administrative commands. | |
void | getCarrierParams (Property ¶ms) const override |
Get carrier configuration and deliver it by port administrative commands. | |
virtual yarp::os::Face * | createFace () const |
Create new Face object that the carrier needs. | |
Public Member Functions inherited from yarp::os::Connection | |
virtual | ~Connection () |
Destructor. | |
virtual bool | isValid () const |
Check if this object is really a connection, or just an empty placeholder. | |
virtual bool | isBareMode () const |
Check if carrier excludes type information from payload. | |
Additional Inherited Members | |
Protected Member Functions inherited from yarp::os::AbstractCarrier | |
int | getSpecifier (const Bytes &b) const |
void | createStandardHeader (int specifier, yarp::os::Bytes &header) const |
bool | sendConnectionStateSpecifier (ConnectionState &proto) |
bool | sendSenderSpecifier (ConnectionState &proto) |
Static Protected Member Functions inherited from yarp::os::AbstractCarrier | |
static int | interpretYarpNumber (const yarp::os::Bytes &b) |
static void | createYarpNumber (int x, yarp::os::Bytes &header) |
Communicating between two ports via a variant plain-text protocol originally designed for the yarp name server.
For backwards compatibility
Definition at line 56 of file NameserCarrier.h.
yarp::os::impl::NameserCarrier::NameserCarrier | ( | ) |
Definition at line 110 of file NameserCarrier.cpp.
|
overridevirtual |
Check if carrier can encode administrative messages, as opposed to just user data.
The word escape is used in the sense of escape character or escape sequence here.
Reimplemented from yarp::os::AbstractCarrier.
Definition at line 170 of file NameserCarrier.cpp.
Given the first 8 bytes received on a connection, decide if this is the right carrier type to use for the rest of the connection.
For example the "text" carrier looks for the 8-byte sequence "CONNECT ". See the YARP protocol documentation for all the sequences in use here. In general you are free to add your own.
header | a buffer holding the first 8 bytes received on the connection |
Implements yarp::os::AbstractCarrier.
Definition at line 130 of file NameserCarrier.cpp.
|
overridevirtual |
Factory method.
Get a new object of the same type as this one.
Implements yarp::os::AbstractCarrier.
Definition at line 125 of file NameserCarrier.cpp.
|
overridevirtual |
Receive an acknowledgement, if expected for this carrier.
proto | the protocol object, which tracks connection state |
Reimplemented from yarp::os::AbstractCarrier.
Definition at line 204 of file NameserCarrier.cpp.
|
overridevirtual |
Expect a message header, if there is one for this carrier.
proto | the protocol object, which tracks connection state |
Reimplemented from yarp::os::AbstractCarrier.
Definition at line 192 of file NameserCarrier.cpp.
|
overridevirtual |
Process reply to header, if one is expected for this carrier.
proto | the protocol object, which tracks connection state |
Reimplemented from yarp::os::AbstractCarrier.
Definition at line 218 of file NameserCarrier.cpp.
|
overridevirtual |
Expect the name of the sending port.
proto | the protocol object, which tracks connection state |
Reimplemented from yarp::os::AbstractCarrier.
Definition at line 184 of file NameserCarrier.cpp.
Provide 8 bytes describing this connection sufficiently to allow the other side of a connection to select it.
header | a buffer to hold the first 8 bytes to send on a connection |
Implements yarp::os::AbstractCarrier.
Definition at line 144 of file NameserCarrier.cpp.
|
overridevirtual |
Get the name of this connection type ("tcp", "mcast", "shmem", ...)
Implements yarp::os::AbstractCarrier.
Definition at line 115 of file NameserCarrier.cpp.
std::string yarp::os::impl::NameserCarrier::getSpecifierName | ( | ) | const |
Definition at line 120 of file NameserCarrier.cpp.
|
overridevirtual |
Check if carrier is textual in nature.
Reimplemented from yarp::os::AbstractCarrier.
Definition at line 160 of file NameserCarrier.cpp.
|
overridevirtual |
Check if carrier has flow control, requiring sent messages to be acknowledged by recipient.
Reimplemented from yarp::os::AbstractCarrier.
Definition at line 155 of file NameserCarrier.cpp.
|
overridevirtual |
Respond to the header.
proto | the protocol object, which tracks connection state |
Implements yarp::os::AbstractCarrier.
Definition at line 210 of file NameserCarrier.cpp.
|
overridevirtual |
Send an acknowledgement, if needed for this carrier.
proto | the protocol object, which tracks connection state |
Reimplemented from yarp::os::AbstractCarrier.
Definition at line 198 of file NameserCarrier.cpp.
|
overridevirtual |
Write a header appropriate to the carrier to the connection, followed by any carrier-specific data.
Must communicate at least the name of the originating port, if there is one.
proto | the protocol object, which tracks connection state |
Reimplemented from yarp::os::AbstractCarrier.
Definition at line 175 of file NameserCarrier.cpp.
|
overridevirtual |
This flag is used by YARP to determine whether the connection can carry RPC traffic, that is, messages with replies.
Reimplemented from yarp::os::AbstractCarrier.
Definition at line 165 of file NameserCarrier.cpp.
|
overridevirtual |
Write a message.
proto | the protocol object, which tracks connection state |
Reimplemented from yarp::os::AbstractCarrier.
Definition at line 225 of file NameserCarrier.cpp.