Communicating between two ports via a plain-text protocol. More...

#include <yarp/os/impl/TextCarrier.h>

Inheritance diagram for yarp::os::impl::TextCarrier:

Public Member Functions
	TextCarrier (bool ackVariant=false)

Carrier *	create () const override
	Factory method. More...

std::string	getName () const override
	Get the name of this connection type ("tcp", "mcast", "shmem", ...) More...

virtual std::string	getSpecifierName () const

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. More...

void	getHeader (Bytes &header) const override
	Provide 8 bytes describing this connection sufficiently to allow the other side of a connection to select it. More...

bool	requireAck () const override
	Check if carrier has flow control, requiring sent messages to be acknowledged by recipient. More...

bool	isTextMode () const override
	Check if carrier is textual in nature. More...

bool	supportReply () const override
	This flag is used by YARP to determine whether the connection can carry RPC traffic, that is, messages with replies. More...

bool	sendHeader (ConnectionState &proto) override
	Write a header appropriate to the carrier to the connection, followed by any carrier-specific data. More...

bool	expectReplyToHeader (ConnectionState &proto) override
	Process reply to header, if one is expected for this carrier. More...

bool	expectSenderSpecifier (ConnectionState &proto) override
	Expect the name of the sending port. More...

bool	sendIndex (ConnectionState &proto, SizedWriter &writer) override

bool	expectIndex (ConnectionState &proto) override
	Expect a message header, if there is one for this carrier. More...

bool	sendAck (ConnectionState &proto) override
	Send an acknowledgement, if needed for this carrier. More...

bool	expectAck (ConnectionState &proto) override
	Receive an acknowledgement, if expected for this carrier. More...

bool	respondToHeader (ConnectionState &proto) override
	Respond to the header. More...

Public Member Functions inherited from yarp::os::impl::TcpCarrier
	TcpCarrier (bool requireAckFlag=true)

virtual int	getSpecifierCode () const

void	setParameters (const yarp::os::Bytes &header) override
	Configure this carrier based on the first 8 bytes of the connection. More...

bool	isConnectionless () const override
	Check if this carrier is connectionless (like udp, mcast) or connection based (like tcp). More...

Public Member Functions inherited from yarp::os::AbstractCarrier
void	setCarrierParams (const yarp::os::Property &params) override
	Configure carrier from port administrative commands. More...

void	getCarrierParams (yarp::os::Property &params) const override
	Get carrier configuration and deliver it by port administrative commands. More...

bool	canAccept () const override
	Check if reading is implemented for this carrier. More...

bool	canOffer () const override
	Check if writing is implemented for this carrier. More...

bool	canEscape () const override
	Check if carrier can encode administrative messages, as opposed to just user data. More...

bool	isLocal () const override
	Check if carrier operates within a single process. More...

std::string	toString () const override
	Get name of carrier. More...

bool	isActive () const override
	Check if carrier is alive and error free. More...

bool	prepareSend (ConnectionState &proto) override
	Perform any initialization needed before writing on a connection. More...

bool	expectExtraHeader (ConnectionState &proto) override
	Receive any carrier-specific header. More...

bool	defaultSendHeader (ConnectionState &proto)
	Default implementation for the sendHeader method. More...

bool	defaultExpectIndex (ConnectionState &proto)
	Default implementation for the expectIndex method. More...

bool	defaultSendIndex (ConnectionState &proto, SizedWriter &writer)
	Default implementation for the sendIndex method. More...

bool	defaultExpectAck (ConnectionState &proto)
	Default implementation for the expectAck method. More...

bool	defaultSendAck (ConnectionState &proto)
	Default implementation for the sendAck method. More...

int	readYarpInt (ConnectionState &proto)
	Read 8 bytes and interpret them as a YARP number. More...

void	writeYarpInt (int n, ConnectionState &proto)
	Write `n` as an 8 bytes yarp number. More...

Public Member Functions inherited from yarp::os::Carrier
bool	isBroadcast () const override
	Check if this carrier uses a broadcast mechanism. More...

void	handleEnvelope (const std::string &envelope) override
	Carriers that do not distinguish data from administrative headers (i.e. More...

bool	isPush () const override
	Check if carrier is "push" or "pull" style. More...

virtual bool	reply (ConnectionState &proto, SizedWriter &writer)

void	prepareDisconnect () override
	Do cleanup and preparation for the coming disconnect, if necessary. More...

virtual void	close ()
	Close the carrier. More...

virtual	~Carrier ()
	Destructor. More...

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. More...

virtual int	connect (const Contact &src, const Contact &dest, const ContactStyle &style, int mode, bool reversed)
	Some carrier types may require special connection logic. More...

bool	modifiesIncomingData () const override
	Check if this carrier modifies incoming data through the Carrier::modifyIncomingData method. More...

ConnectionReader &	modifyIncomingData (ConnectionReader &reader) override
	Modify incoming payload data, if appropriate. More...

bool	acceptIncomingData (ConnectionReader &reader) override
	Determine whether incoming data should be accepted. More...

bool	modifiesOutgoingData () const override
	Check if this carrier modifies outgoing data through the Carrier::modifyOutgoingData method. More...

const PortWriter &	modifyOutgoingData (const PortWriter &writer) override
	Modify outgoing payload data, if appropriate. More...

bool	modifiesReply () const override
	Check if this carrier modifies outgoing data through the Carrier::modifyReply method. More...

PortReader &	modifyReply (PortReader &reader) override
	Modify reply payload data, if appropriate. More...

bool	acceptOutgoingData (const PortWriter &writer) override
	Determine whether outgoing data should be accepted. More...

virtual bool	configure (ConnectionState &proto)
	Give carrier a shot at looking at how the connection is set up. More...

virtual bool	configureFromProperty (yarp::os::Property &options)

void	setCarrierParams (const Property &params) override
	Configure carrier from port administrative commands. More...

void	getCarrierParams (Property &params) const override
	Get carrier configuration and deliver it by port administrative commands. More...

virtual yarp::os::Face *	createFace () const
	Create new Face object that the carrier needs. More...

Public Member Functions inherited from yarp::os::Connection
virtual	~Connection ()
	Destructor. More...

virtual bool	isValid () const
	Check if this object is really a connection, or just an empty placeholder. More...

virtual bool	isBareMode () const
	Check if carrier excludes type information from payload. More...

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	write (ConnectionState &proto, SizedWriter &writer) override
	Write a message. More...

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)

Detailed Description

Communicating between two ports via a plain-text protocol.

Examples: carrier/carrier_stub.cpp.

Definition at line 22 of file TextCarrier.h.

Constructor & Destructor Documentation

◆ TextCarrier()

yarp::os::impl::TextCarrier::TextCarrier ( bool ackVariant = false )

Definition at line 24 of file TextCarrier.cpp.

Member Function Documentation

◆ checkHeader()

bool yarp::os::impl::TextCarrier::checkHeader ( const Bytes & header )

overridevirtual

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.

Parameters

header a buffer holding the first 8 bytes received on the connection

Returns: true if this is the carrier to use.

Reimplemented from yarp::os::impl::TcpCarrier.

Definition at line 45 of file TextCarrier.cpp.

◆ create()

yarp::os::Carrier * yarp::os::impl::TextCarrier::create ( ) const

overridevirtual

Factory method.

Get a new object of the same type as this one.

Returns: a new object of the same type as this one.

Reimplemented from yarp::os::impl::TcpCarrier.

Examples: carrier/carrier_stub.cpp.

Definition at line 69 of file TextCarrier.cpp.

◆ expectAck()

bool yarp::os::impl::TextCarrier::expectAck ( ConnectionState & proto )

overridevirtual

Receive an acknowledgement, if expected for this carrier.

Parameters

proto the protocol object, which tracks connection state

Returns: true on success, false on failure

Reimplemented from yarp::os::AbstractCarrier.

Definition at line 146 of file TextCarrier.cpp.

◆ expectIndex()

bool yarp::os::impl::TextCarrier::expectIndex ( ConnectionState & proto )

overridevirtual

Expect a message header, if there is one for this carrier.

Parameters

proto the protocol object, which tracks connection state

Returns: true on success, false on failure

Reimplemented from yarp::os::AbstractCarrier.

Definition at line 129 of file TextCarrier.cpp.

◆ expectReplyToHeader()

bool yarp::os::impl::TextCarrier::expectReplyToHeader ( ConnectionState & proto )

overridevirtual

Process reply to header, if one is expected for this carrier.

Parameters

proto the protocol object, which tracks connection state

Returns: true on success, false on failure

Reimplemented from yarp::os::impl::TcpCarrier.

Definition at line 104 of file TextCarrier.cpp.

◆ expectSenderSpecifier()

bool yarp::os::impl::TextCarrier::expectSenderSpecifier ( ConnectionState & proto )

overridevirtual

Expect the name of the sending port.

Parameters

proto the protocol object, which tracks connection state

Returns: true on success, false on failure

Reimplemented from yarp::os::AbstractCarrier.

Definition at line 113 of file TextCarrier.cpp.

◆ getHeader()

void yarp::os::impl::TextCarrier::getHeader ( Bytes & header ) const

overridevirtual

Provide 8 bytes describing this connection sufficiently to allow the other side of a connection to select it.

Parameters

header a buffer to hold the first 8 bytes to send on a connection

Reimplemented from yarp::os::impl::TcpCarrier.

Definition at line 59 of file TextCarrier.cpp.

◆ getName()

std::string yarp::os::impl::TextCarrier::getName ( ) const

overridevirtual

Get the name of this connection type ("tcp", "mcast", "shmem", ...)

Returns: the name of this connection type

Reimplemented from yarp::os::impl::TcpCarrier.

Examples: carrier/carrier_stub.cpp.

Definition at line 29 of file TextCarrier.cpp.

◆ getSpecifierName()

std::string yarp::os::impl::TextCarrier::getSpecifierName ( ) const

virtual

Examples: carrier/carrier_stub.cpp.

Definition at line 37 of file TextCarrier.cpp.

◆ isTextMode()

bool yarp::os::impl::TextCarrier::isTextMode ( ) const

overridevirtual

Check if carrier is textual in nature.

Returns: true if carrier is text-based

Reimplemented from yarp::os::AbstractCarrier.

Definition at line 79 of file TextCarrier.cpp.

◆ requireAck()

bool yarp::os::impl::TextCarrier::requireAck ( ) const

overridevirtual

Check if carrier has flow control, requiring sent messages to be acknowledged by recipient.

Returns: true if carrier requires acknowledgement.

Reimplemented from yarp::os::impl::TcpCarrier.

Definition at line 74 of file TextCarrier.cpp.

◆ respondToHeader()

bool yarp::os::impl::TextCarrier::respondToHeader ( ConnectionState & proto )

overridevirtual

Respond to the header.

Parameters

proto the protocol object, which tracks connection state

Returns: true on success, false on failure

Reimplemented from yarp::os::impl::TcpCarrier.

Definition at line 155 of file TextCarrier.cpp.

◆ sendAck()

bool yarp::os::impl::TextCarrier::sendAck ( ConnectionState & proto )

overridevirtual

Send an acknowledgement, if needed for this carrier.

Parameters

proto the protocol object, which tracks connection state

Returns: true on success, false on failure

Reimplemented from yarp::os::AbstractCarrier.

Definition at line 135 of file TextCarrier.cpp.

◆ sendHeader()

bool yarp::os::impl::TextCarrier::sendHeader ( ConnectionState & proto )

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.

Parameters

proto the protocol object, which tracks connection state

Returns: true on success, false on failure

Reimplemented from yarp::os::AbstractCarrier.

Definition at line 90 of file TextCarrier.cpp.

◆ sendIndex()

bool yarp::os::impl::TextCarrier::sendIndex	(	ConnectionState &	proto,
		SizedWriter &	writer
	)

overridevirtual

Reimplemented from yarp::os::AbstractCarrier.

Definition at line 122 of file TextCarrier.cpp.

◆ supportReply()

bool yarp::os::impl::TextCarrier::supportReply ( ) const

overridevirtual

This flag is used by YARP to determine whether the connection can carry RPC traffic, that is, messages with replies.

Returns: true if carrier supports replies

Reimplemented from yarp::os::AbstractCarrier.

Definition at line 85 of file TextCarrier.cpp.

The documentation for this class was generated from the following files:

src/libYARP_os/src/yarp/os/impl/TextCarrier.h
src/libYARP_os/src/yarp/os/impl/TextCarrier.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TextCarrier()

Member Function Documentation

◆ checkHeader()

◆ create()

◆ expectAck()

◆ expectIndex()

◆ expectReplyToHeader()

◆ expectSenderSpecifier()

◆ getHeader()

◆ getName()

◆ getSpecifierName()

◆ isTextMode()

◆ requireAck()

◆ respondToHeader()

◆ sendAck()

◆ sendHeader()

◆ sendIndex()

◆ supportReply()