Inheritance diagram for ForwardingCarrier:

Public Member Functions
	ForwardingCarrier ()

	ForwardingCarrier (SharedLibraryClassFactory< Carrier > factory, Carrier owner)

	~ForwardingCarrier () override

virtual Carrier &	getContent ()

virtual const Carrier &	getContent () const

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

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

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

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

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

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

bool	requireAck () const override
	Check if carrier has flow control, requiring sent messages to be acknowledged by recipient. 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	isLocal () const override
	Check if carrier operates within a single process. More...

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

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

bool	isBroadcast () const override
	Check if this carrier uses a broadcast mechanism. More...

bool	isActive () const override
	Check if carrier is alive and error free. 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	acceptOutgoingData (const PortWriter &writer) override
	Determine whether outgoing data should be accepted. 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...

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

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

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

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

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

void	setParameters (const yarp::os::Bytes &header) override
	Configure this carrier based on the first 8 bytes of the connection. 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	prepareSend (ConnectionState &proto) override
	Perform any initialization needed before writing on a connection. 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	write (ConnectionState &proto, SizedWriter &writer) override
	Write a message. More...

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

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

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

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

bool	expectSenderSpecifier (ConnectionState &proto) override
	Expect the name of the sending port. 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...

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

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

std::string	getBootstrapCarrierName () const override
	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...

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

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

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

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

Public Member Functions inherited from yarp::os::Carrier
virtual Carrier *	create () const =0
	Factory method. More...

virtual bool	checkHeader (const Bytes &header)=0
	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...

virtual void	setParameters (const Bytes &header)=0
	Configure this carrier based on the first 8 bytes of the connection. More...

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

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

bool	isBroadcast () const override
	Check if this carrier uses a broadcast mechanism. More...

virtual bool	canAccept () const =0
	Check if reading is implemented for this carrier. More...

virtual bool	canOffer () const =0
	Check if writing is implemented for this carrier. More...

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

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

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

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

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

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

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

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

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

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

virtual bool	write (ConnectionState &proto, SizedWriter &writer)=0
	Write a message. More...

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

virtual bool	expectExtraHeader (ConnectionState &proto)=0
	Receive any carrier-specific header. More...

virtual bool	respondToHeader (ConnectionState &proto)=0
	Respond to the header. More...

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

virtual bool	expectSenderSpecifier (ConnectionState &proto)=0
	Expect the name of the sending port. More...

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

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

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

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

virtual std::string	toString () const =0
	Get name of carrier. 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	isTextMode () const =0
	Check if carrier is textual in nature. More...

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

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

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

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

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

virtual bool	isLocal () const =0
	Check if carrier operates within a single process. More...

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

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

virtual bool	isBroadcast () const =0
	Check if this carrier uses a broadcast mechanism. More...

virtual bool	isActive () const =0
	Check if carrier is alive and error free. More...

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

virtual yarp::os::ConnectionReader &	modifyIncomingData (yarp::os::ConnectionReader &reader)=0
	Modify incoming payload data, if appropriate. More...

virtual bool	acceptIncomingData (yarp::os::ConnectionReader &reader)=0
	Determine whether incoming data should be accepted. More...

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

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

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

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

virtual PortReader &	modifyReply (PortReader &reader)=0
	Modify reply payload data, if appropriate. More...

virtual void	setCarrierParams (const yarp::os::Property &params)=0
	Configure carrier from port administrative commands. More...

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

virtual void	getHeader (yarp::os::Bytes &header) const =0
	Provide 8 bytes describing this connection sufficiently to allow the other side of a connection to select it. More...

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

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

Public Attributes
SharedLibraryClassFactory< Carrier > *	factory

SharedLibraryClass< Carrier >	car

Carrier *	owner

Detailed Description

Definition at line 1560 of file Network.cpp.

Constructor & Destructor Documentation

◆ ForwardingCarrier() [1/2]

ForwardingCarrier::ForwardingCarrier ( )

inline

Definition at line 1567 of file Network.cpp.

◆ ForwardingCarrier() [2/2]

ForwardingCarrier::ForwardingCarrier	(	SharedLibraryClassFactory< Carrier > *	factory,
		Carrier *	owner
	)

inline

Definition at line 1573 of file Network.cpp.

◆ ~ForwardingCarrier()

ForwardingCarrier::~ForwardingCarrier ( )

inlineoverride

Definition at line 1582 of file Network.cpp.

Member Function Documentation

◆ acceptIncomingData()

bool ForwardingCarrier::acceptIncomingData ( ConnectionReader & reader )

inlineoverridevirtual

Determine whether incoming data should be accepted.

Parameters

reader for incoming data.

Returns: true if data should be accepted, false if it should be discarded.

Reimplemented from yarp::os::Carrier.

Definition at line 1683 of file Network.cpp.

◆ acceptOutgoingData()

bool ForwardingCarrier::acceptOutgoingData ( const PortWriter & writer )

inlineoverridevirtual

Determine whether outgoing data should be accepted.

Parameters

writer for outgoing data.

Returns: true if data should be accepted, false if it should be discarded.

Reimplemented from yarp::os::Carrier.

Definition at line 1698 of file Network.cpp.

◆ canAccept()

bool ForwardingCarrier::canAccept ( ) const

inlineoverridevirtual

Check if reading is implemented for this carrier.

Returns: true if carrier can read messages

Implements yarp::os::Carrier.

Definition at line 1751 of file Network.cpp.

◆ canEscape()

bool ForwardingCarrier::canEscape ( ) const

inlineoverridevirtual

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.

Returns: true if carrier can encode administrative messages

Implements yarp::os::Carrier.

Definition at line 1628 of file Network.cpp.

◆ canOffer()

bool ForwardingCarrier::canOffer ( ) const

inlineoverridevirtual

Check if writing is implemented for this carrier.

Returns: true if carrier can write messages

Implements yarp::os::Carrier.

Definition at line 1756 of file Network.cpp.

◆ checkHeader()

bool ForwardingCarrier::checkHeader ( const yarp::os::Bytes & header )

inlineoverridevirtual

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.

Implements yarp::os::Carrier.

Definition at line 1741 of file Network.cpp.

◆ close()

void ForwardingCarrier::close ( )

inlineoverridevirtual

Close the carrier.

Reimplemented from yarp::os::Carrier.

Definition at line 1821 of file Network.cpp.

◆ configure()

bool ForwardingCarrier::configure ( ConnectionState & proto )

inlineoverridevirtual

Give carrier a shot at looking at how the connection is set up.

Returns: true if the carrier was correctly configured.

Reimplemented from yarp::os::Carrier.

Definition at line 1840 of file Network.cpp.

◆ configureFromProperty()

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

inlineoverridevirtual

Reimplemented from yarp::os::Carrier.

Definition at line 1844 of file Network.cpp.

◆ connect()

int ForwardingCarrier::connect	(	const yarp::os::Contact &	src,
		const yarp::os::Contact &	dest,
		const yarp::os::ContactStyle &	style,
		int	mode,
		bool	reversed
	)

inlineoverridevirtual

Some carrier types may require special connection logic.

This can be implemented here. Normally this is not necessary.

Parameters

src	Initiator of the connection.
dest	Destination of the connection.
style	Options for connection.
mode	YARP_ENACT_CONNECT / YARP_ENACT_DISCONNECT / YARP_ENACT_EXISTS.
reversed	true for pull connections, false for push connections.

Returns: -1 if no attempt made to connect, 0 on success, 1 on failure.

Reimplemented from yarp::os::Carrier.

Definition at line 1831 of file Network.cpp.

◆ create()

Carrier * ForwardingCarrier::create ( ) const

inlineoverridevirtual

Factory method.

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

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

Implements yarp::os::Carrier.

Reimplemented in StubCarrier.

Definition at line 1605 of file Network.cpp.

◆ createFace()

yarp::os::Face * ForwardingCarrier::createFace ( ) const

inlineoverridevirtual

Create new Face object that the carrier needs.

Reimplemented from yarp::os::Carrier.

Definition at line 1849 of file Network.cpp.

◆ expectAck()

bool ForwardingCarrier::expectAck ( ConnectionState & proto )

inlineoverridevirtual

Receive an acknowledgement, if expected for this carrier.

Parameters

proto the protocol object, which tracks connection state

Returns: true on success, false on failure

Implements yarp::os::Carrier.

Definition at line 1811 of file Network.cpp.

◆ expectExtraHeader()

bool ForwardingCarrier::expectExtraHeader ( ConnectionState & proto )

inlineoverridevirtual

Receive any carrier-specific header.

Parameters

proto the protocol object, which tracks connection state

Returns: true on success, false on failure

Implements yarp::os::Carrier.

Definition at line 1786 of file Network.cpp.

◆ expectIndex()

bool ForwardingCarrier::expectIndex ( ConnectionState & proto )

inlineoverridevirtual

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

Implements yarp::os::Carrier.

Definition at line 1796 of file Network.cpp.

◆ expectReplyToHeader()

bool ForwardingCarrier::expectReplyToHeader ( ConnectionState & proto )

inlineoverridevirtual

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

Implements yarp::os::Carrier.

Definition at line 1771 of file Network.cpp.

◆ expectSenderSpecifier()

bool ForwardingCarrier::expectSenderSpecifier ( ConnectionState & proto )

inlineoverridevirtual

Expect the name of the sending port.

Parameters

proto the protocol object, which tracks connection state

Returns: true on success, false on failure

Implements yarp::os::Carrier.

Definition at line 1801 of file Network.cpp.

◆ getBootstrapCarrierName()

std::string ForwardingCarrier::getBootstrapCarrierName ( ) const

inlineoverridevirtual

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.

Normally, this should be "tcp".

For carriers intended to interoperate with foreign ports not capable of initiating streams, the bootstrap carrier name should be left blank. YARP may use that fact to arrange for alternate methods of initiating a stream.

Returns: the name of the bootstrap carrier.

Reimplemented from yarp::os::Carrier.

Definition at line 1826 of file Network.cpp.

◆ getCarrierParams()

void ForwardingCarrier::getCarrierParams ( Property & params ) const

inlineoverridevirtual

Get carrier configuration and deliver it by port administrative commands.

Parameters

params properties

Reimplemented from yarp::os::Carrier.

Definition at line 1718 of file Network.cpp.

◆ getContent() [1/2]

virtual Carrier & ForwardingCarrier::getContent ( )

inlinevirtual

Reimplemented in StubCarrier.

Definition at line 1595 of file Network.cpp.

◆ getContent() [2/2]

virtual const Carrier & ForwardingCarrier::getContent ( ) const

inlinevirtual

Reimplemented in StubCarrier.

Definition at line 1600 of file Network.cpp.

◆ getHeader()

void ForwardingCarrier::getHeader ( yarp::os::Bytes & header ) const

inlineoverridevirtual

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

Implements yarp::os::Carrier.

Definition at line 1723 of file Network.cpp.

◆ getName()

std::string ForwardingCarrier::getName ( ) const

inlineoverridevirtual

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

Returns: the name of this connection type

Implements yarp::os::Connection.

Definition at line 1733 of file Network.cpp.

◆ handleEnvelope()

void ForwardingCarrier::handleEnvelope ( const std::string & envelope )

inlineoverridevirtual

Carriers that do not distinguish data from administrative headers (i.e.

canEscape returns false), can overload this method to handle the envelope inside the stream. On the receiving side, the InputStream will have to overload the yarp::os::InputStream::setReadEnvelopeCallback method, and execute the callback as soon as the envelope is ready.

Parameters

envelope the envelope to transmit bundled with data.

Reimplemented from yarp::os::Carrier.

Definition at line 1633 of file Network.cpp.

◆ isActive()

bool ForwardingCarrier::isActive ( ) const

inlineoverridevirtual

Check if carrier is alive and error free.

Returns: true if carrier is active.

Implements yarp::os::Carrier.

Definition at line 1668 of file Network.cpp.

◆ isBareMode()

bool ForwardingCarrier::isBareMode ( ) const

inlineoverridevirtual

Check if carrier excludes type information from payload.

Returns: true if carrier is bare

Reimplemented from yarp::os::Connection.

Definition at line 1623 of file Network.cpp.

◆ isBroadcast()

bool ForwardingCarrier::isBroadcast ( ) const

inlineoverridevirtual

Check if this carrier uses a broadcast mechanism.

This flag is used to determine whether it is appropriate to send "kill" messages using a carrier or whether they should be sent "out-of-band"

Returns: true if carrier uses a broadcast mechanism.

Reimplemented from yarp::os::Carrier.

Definition at line 1663 of file Network.cpp.

◆ isConnectionless()

bool ForwardingCarrier::isConnectionless ( ) const

inlineoverridevirtual

Check if this carrier is connectionless (like udp, mcast) or connection based (like tcp).

This flag is used by YARP to determine whether the connection can carry RPC traffic, that is, messages with replies. Replies are not supported by YARP on connectionless carriers.

Returns: true if carrier is connectionless

Implements yarp::os::Carrier.

Definition at line 1658 of file Network.cpp.

◆ isLocal()

bool ForwardingCarrier::isLocal ( ) const

inlineoverridevirtual

Check if carrier operates within a single process.

In such a case, YARP connections may get completely reorganized in order to optimize them.

Returns: true if carrier will only operate within a single process

Implements yarp::os::Carrier.

Definition at line 1648 of file Network.cpp.

◆ isPush()

bool ForwardingCarrier::isPush ( ) const

inlineoverridevirtual

Check if carrier is "push" or "pull" style.

Push means that the side that initiates a connection is also the one that will sending of data or commands. All native YARP connections are like this. A "pull" style is equivalent to automatically sending a "reverse connection" port command at the start of the connection.

Returns: true if carrier is "push" style, false if "pull" style

Reimplemented from yarp::os::Carrier.

Definition at line 1653 of file Network.cpp.

◆ isTextMode()

bool ForwardingCarrier::isTextMode ( ) const

inlineoverridevirtual

Check if carrier is textual in nature.

Returns: true if carrier is text-based

Implements yarp::os::Carrier.

Definition at line 1618 of file Network.cpp.

◆ isValid()

bool ForwardingCarrier::isValid ( ) const

inlineoverridevirtual

Check if this object is really a connection, or just an empty placeholder.

Returns: true if a valid connection

Reimplemented from yarp::os::Connection.

Definition at line 1613 of file Network.cpp.

◆ modifiesIncomingData()

bool ForwardingCarrier::modifiesIncomingData ( ) const

inlineoverridevirtual

Check if this carrier modifies incoming data through the Carrier::modifyIncomingData method.

Returns: true if carrier wants Carrier::modifyIncomingData called.

Reimplemented from yarp::os::Carrier.

Definition at line 1673 of file Network.cpp.

◆ modifiesOutgoingData()

bool ForwardingCarrier::modifiesOutgoingData ( ) const

inlineoverridevirtual

Check if this carrier modifies outgoing data through the Carrier::modifyOutgoingData method.

Returns: true if carrier wants Carrier::modifyOutgoingData called.

Reimplemented from yarp::os::Carrier.

Definition at line 1688 of file Network.cpp.

◆ modifiesReply()

bool ForwardingCarrier::modifiesReply ( ) const

inlineoverridevirtual

Check if this carrier modifies outgoing data through the Carrier::modifyReply method.

Returns: true if carrier wants Carrier::modifyReply called.

Reimplemented from yarp::os::Carrier.

Definition at line 1703 of file Network.cpp.

◆ modifyIncomingData()

ConnectionReader & ForwardingCarrier::modifyIncomingData ( ConnectionReader & reader )

inlineoverridevirtual

Modify incoming payload data, if appropriate.

Doesn't need to be done immediately, it is fine to hold onto a reference to the incoming data reader and use it on demand. This can be handy in order to avoid unnecessary copies.

Parameters

reader for incoming data.

Returns: reader for modified version of incoming data.

Note: If the ConnectionReader returned is not the same as the one in input, the setParentConnectionReader(&reader) should be called for the new one, or the envelope will not be handled correctly.

Reimplemented from yarp::os::Carrier.

Definition at line 1678 of file Network.cpp.

◆ modifyOutgoingData()

const PortWriter & ForwardingCarrier::modifyOutgoingData ( const PortWriter & writer )

inlineoverridevirtual

Modify outgoing payload data, if appropriate.

Doesn't need to be done immediately, it is fine to hold onto a reference to the outgoing data reader and use it on demand. This can be handy in order to avoid unnecessary copies.

Parameters

writer for outgoing data.

Returns: writer for modified version of outgoing data.

Reimplemented from yarp::os::Carrier.

Definition at line 1693 of file Network.cpp.

◆ modifyReply()

PortReader & ForwardingCarrier::modifyReply ( PortReader & reader )

inlineoverridevirtual

Modify reply payload data, if appropriate.

Parameters

reader for the replied message.

Returns: reader for modified version of the replied message.

Reimplemented from yarp::os::Carrier.

Definition at line 1708 of file Network.cpp.

◆ prepareDisconnect()

void ForwardingCarrier::prepareDisconnect ( )

inlineoverridevirtual

Do cleanup and preparation for the coming disconnect, if necessary.

Reimplemented from yarp::os::Carrier.

Definition at line 1728 of file Network.cpp.

◆ prepareSend()

bool ForwardingCarrier::prepareSend ( ConnectionState & proto )

inlineoverridevirtual

Perform any initialization needed before writing on a connection.

Parameters

proto the protocol object, which tracks connection state

Returns: true on success, false on failure

Implements yarp::os::Carrier.

Definition at line 1761 of file Network.cpp.

◆ reply()

bool ForwardingCarrier::reply	(	ConnectionState &	proto,
		SizedWriter &	writer
	)

inlineoverridevirtual

Reimplemented from yarp::os::Carrier.

Definition at line 1781 of file Network.cpp.

◆ requireAck()

bool ForwardingCarrier::requireAck ( ) const

inlineoverridevirtual

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

Returns: true if carrier requires acknowledgement.

Implements yarp::os::Carrier.

Definition at line 1638 of file Network.cpp.

◆ respondToHeader()

bool ForwardingCarrier::respondToHeader ( ConnectionState & proto )

inlineoverridevirtual

Respond to the header.

Parameters

proto the protocol object, which tracks connection state

Returns: true on success, false on failure

Implements yarp::os::Carrier.

Definition at line 1791 of file Network.cpp.

◆ sendAck()

bool ForwardingCarrier::sendAck ( ConnectionState & proto )

inlineoverridevirtual

Send an acknowledgement, if needed for this carrier.

Parameters

proto the protocol object, which tracks connection state

Returns: true on success, false on failure

Implements yarp::os::Carrier.

Definition at line 1806 of file Network.cpp.

◆ sendHeader()

bool ForwardingCarrier::sendHeader ( ConnectionState & proto )

inlineoverridevirtual

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

Implements yarp::os::Carrier.

Definition at line 1766 of file Network.cpp.

◆ setCarrierParams()

void ForwardingCarrier::setCarrierParams ( const Property & params )

inlineoverridevirtual

Configure carrier from port administrative commands.

Parameters

params properties

Reimplemented from yarp::os::Carrier.

Definition at line 1713 of file Network.cpp.

◆ setParameters()

void ForwardingCarrier::setParameters ( const yarp::os::Bytes & header )

inlineoverridevirtual

Configure this carrier based on the first 8 bytes of the connection.

This will only be called if checkHeader passed.

Parameters

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

Implements yarp::os::Carrier.

Definition at line 1746 of file Network.cpp.

◆ supportReply()

bool ForwardingCarrier::supportReply ( ) const

inlineoverridevirtual

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

Implements yarp::os::Carrier.

Definition at line 1643 of file Network.cpp.

◆ toString()

std::string ForwardingCarrier::toString ( ) const

inlineoverridevirtual

Get name of carrier.

Returns: name of carrier.

Implements yarp::os::Carrier.

Definition at line 1816 of file Network.cpp.

◆ write()

bool ForwardingCarrier::write	(	ConnectionState &	proto,
		SizedWriter &	writer
	)

inlineoverridevirtual

Write a message.

Parameters

proto the protocol object, which tracks connection state

Returns: true on success, false on failure

Implements yarp::os::Carrier.

Definition at line 1776 of file Network.cpp.

Member Data Documentation

◆ car

SharedLibraryClass<Carrier> ForwardingCarrier::car

Definition at line 1564 of file Network.cpp.

◆ factory

SharedLibraryClassFactory<Carrier>* ForwardingCarrier::factory

Definition at line 1563 of file Network.cpp.

◆ owner

Carrier* ForwardingCarrier::owner

Definition at line 1565 of file Network.cpp.

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

src/libYARP_os/src/yarp/os/Network.cpp

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ForwardingCarrier() [1/2]

◆ ForwardingCarrier() [2/2]

◆ ~ForwardingCarrier()

Member Function Documentation

◆ acceptIncomingData()

◆ acceptOutgoingData()

◆ canAccept()

◆ canEscape()

◆ canOffer()

◆ checkHeader()

◆ close()

◆ configure()

◆ configureFromProperty()

◆ connect()

◆ create()

◆ createFace()

◆ expectAck()

◆ expectExtraHeader()

◆ expectIndex()

◆ expectReplyToHeader()

◆ expectSenderSpecifier()

◆ getBootstrapCarrierName()

◆ getCarrierParams()

◆ getContent() [1/2]

◆ getContent() [2/2]

◆ getHeader()

◆ getName()

◆ handleEnvelope()

◆ isActive()

◆ isBareMode()

◆ isBroadcast()

◆ isConnectionless()

◆ isLocal()

◆ isPush()

◆ isTextMode()

◆ isValid()

◆ modifiesIncomingData()

◆ modifiesOutgoingData()

◆ modifiesReply()

◆ modifyIncomingData()

◆ modifyOutgoingData()

◆ modifyReply()

◆ prepareDisconnect()

◆ prepareSend()

◆ reply()

◆ requireAck()

◆ respondToHeader()

◆ sendAck()

◆ sendHeader()

◆ setCarrierParams()

◆ setParameters()

◆ supportReply()

◆ toString()

◆ write()

Member Data Documentation

◆ car

◆ factory

◆ owner