Communicating between two ports(IPC) via Unix Socket. More...

#include <unix/UnixSocketCarrier.h>

Inheritance diagram for UnixSocketCarrier:

Public Member Functions
	UnixSocketCarrier ()=default

	UnixSocketCarrier (const UnixSocketCarrier &)=delete

	UnixSocketCarrier (UnixSocketCarrier &&)=delete

UnixSocketCarrier &	operator= (const UnixSocketCarrier &)=delete

UnixSocketCarrier &	operator= (UnixSocketCarrier &&)=delete

	~UnixSocketCarrier () override=default

yarp::os::Carrier *	create () const override
	Factory method.

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

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

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.

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

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

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

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

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

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

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

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

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

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	canAccept () const override
	Check if reading is implemented for this carrier.

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

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

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

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.

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

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

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

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.

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

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

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(IPC) via Unix Socket.

Definition at line 24 of file UnixSocketCarrier.h.

Constructor & Destructor Documentation

◆ UnixSocketCarrier() [1/3]

UnixSocketCarrier::UnixSocketCarrier ( )

default

◆ UnixSocketCarrier() [2/3]

UnixSocketCarrier::UnixSocketCarrier ( const UnixSocketCarrier & )

delete

◆ UnixSocketCarrier() [3/3]

UnixSocketCarrier::UnixSocketCarrier ( UnixSocketCarrier && )

delete

◆ ~UnixSocketCarrier()

UnixSocketCarrier::~UnixSocketCarrier ( )

overridedefault

Member Function Documentation

◆ checkHeader()

bool UnixSocketCarrier::checkHeader ( const yarp::os::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.

Implements yarp::os::AbstractCarrier.

Definition at line 104 of file UnixSocketCarrier.cpp.

◆ configure()

bool UnixSocketCarrier::configure ( yarp::os::ConnectionState & proto )

overridevirtual

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 237 of file UnixSocketCarrier.cpp.

◆ configureFromProperty()

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

overridevirtual

Reimplemented from yarp::os::Carrier.

Definition at line 244 of file UnixSocketCarrier.cpp.

◆ create()

yarp::os::Carrier * UnixSocketCarrier::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.

Implements yarp::os::AbstractCarrier.

Definition at line 84 of file UnixSocketCarrier.cpp.

◆ expectAck()

bool UnixSocketCarrier::expectAck ( yarp::os::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 159 of file UnixSocketCarrier.cpp.

◆ expectIndex()

bool UnixSocketCarrier::expectIndex ( yarp::os::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 143 of file UnixSocketCarrier.cpp.

◆ expectReplyToHeader()

bool UnixSocketCarrier::expectReplyToHeader ( yarp::os::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::AbstractCarrier.

Definition at line 187 of file UnixSocketCarrier.cpp.

◆ getHeader()

void UnixSocketCarrier::getHeader ( yarp::os::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

Implements yarp::os::AbstractCarrier.

Definition at line 127 of file UnixSocketCarrier.cpp.

◆ getName()

std::string UnixSocketCarrier::getName ( ) const

overridevirtual

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

Returns: the name of this connection type

Implements yarp::os::AbstractCarrier.

Definition at line 89 of file UnixSocketCarrier.cpp.

◆ isConnectionless()

bool UnixSocketCarrier::isConnectionless ( ) const

overridevirtual

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

Reimplemented from yarp::os::AbstractCarrier.

Definition at line 99 of file UnixSocketCarrier.cpp.

◆ operator=() [1/2]

UnixSocketCarrier & UnixSocketCarrier::operator= ( const UnixSocketCarrier & )

delete

◆ operator=() [2/2]

UnixSocketCarrier & UnixSocketCarrier::operator= ( UnixSocketCarrier && )

delete

◆ requireAck()

bool UnixSocketCarrier::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::AbstractCarrier.

Definition at line 94 of file UnixSocketCarrier.cpp.

◆ respondToHeader()

bool UnixSocketCarrier::respondToHeader ( yarp::os::ConnectionState & proto )

overridevirtual

Respond to the header.

Parameters

proto the protocol object, which tracks connection state

Returns: true on success, false on failure

Implements yarp::os::AbstractCarrier.

Definition at line 181 of file UnixSocketCarrier.cpp.

◆ sendAck()

bool UnixSocketCarrier::sendAck ( yarp::os::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 150 of file UnixSocketCarrier.cpp.

◆ sendIndex()

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

overridevirtual

Reimplemented from yarp::os::AbstractCarrier.

Definition at line 135 of file UnixSocketCarrier.cpp.

◆ setParameters()

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

overridevirtual

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

Reimplemented from yarp::os::AbstractCarrier.

Definition at line 253 of file UnixSocketCarrier.cpp.

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

src/carriers/unix/UnixSocketCarrier.h
src/carriers/unix/UnixSocketCarrier.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UnixSocketCarrier() [1/3]

◆ UnixSocketCarrier() [2/3]

◆ UnixSocketCarrier() [3/3]

◆ ~UnixSocketCarrier()

Member Function Documentation

◆ checkHeader()

◆ configure()

◆ configureFromProperty()

◆ create()

◆ expectAck()

◆ expectIndex()

◆ expectReplyToHeader()

◆ getHeader()

◆ getName()

◆ isConnectionless()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ requireAck()

◆ respondToHeader()

◆ sendAck()

◆ sendIndex()

◆ setParameters()