Abstract base carrier for managing port communication via MPI. More...

#include <mpi_carrier/MpiCarrier.h>

Inheritance diagram for MpiCarrier:

Public Member Functions
	MpiCarrier ()

virtual	~MpiCarrier ()

void	close () override=0
	Close the carrier.

Carrier *	create () const override=0
	Factory method.

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

virtual void	createStream (bool sender)=0

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

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

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.

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

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

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

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

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

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

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

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

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

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	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	requireAck () const override
	Check if carrier has flow control, requiring sent messages to be acknowledged by recipient.

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

Protected Attributes
MpiStream *	stream

MpiComm *	comm

std::string	port

std::string	name

std::string	other

std::string	route

std::string	target

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)

Detailed Description

Abstract base carrier for managing port communication via MPI.

Definition at line 24 of file MpiCarrier.h.

Constructor & Destructor Documentation

◆ MpiCarrier()

MpiCarrier::MpiCarrier ( )

Definition at line 14 of file MpiCarrier.cpp.

◆ ~MpiCarrier()

MpiCarrier::~MpiCarrier ( )

virtual

Definition at line 17 of file MpiCarrier.cpp.

Member Function Documentation

◆ canEscape()

bool MpiCarrier::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

Reimplemented from yarp::os::AbstractCarrier.

Definition at line 46 of file MpiCarrier.h.

◆ checkHeader()

bool MpiCarrier::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 27 of file MpiCarrier.cpp.

◆ close()

void MpiCarrier::close ( )

overridepure virtual

Close the carrier.

Reimplemented from yarp::os::Carrier.

Implemented in MpiBcastCarrier, and MpiP2PCarrier.

◆ create()

Carrier * MpiCarrier::create ( ) const

overridepure virtual

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.

Implemented in MpiBcastCarrier, and MpiP2PCarrier.

◆ createStream()

virtual void MpiCarrier::createStream ( bool sender )

pure virtual

Implemented in MpiBcastCarrier, and MpiP2PCarrier.

◆ expectAck()

bool MpiCarrier::expectAck ( yarp::os::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

Reimplemented from yarp::os::AbstractCarrier.

Definition at line 87 of file MpiCarrier.h.

◆ expectIndex()

bool MpiCarrier::expectIndex ( yarp::os::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

Reimplemented from yarp::os::AbstractCarrier.

Definition at line 76 of file MpiCarrier.h.

◆ expectReplyToHeader()

bool MpiCarrier::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 140 of file MpiCarrier.cpp.

◆ expectSenderSpecifier()

bool MpiCarrier::expectSenderSpecifier ( yarp::os::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 93 of file MpiCarrier.cpp.

◆ getHeader()

void MpiCarrier::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 21 of file MpiCarrier.cpp.

◆ getName()

std::string MpiCarrier::getName ( ) const

overridepure virtual

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

Returns: the name of this connection type

Implements yarp::os::AbstractCarrier.

Implemented in MpiBcastCarrier, and MpiP2PCarrier.

◆ isConnectionless()

bool MpiCarrier::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

Reimplemented from yarp::os::AbstractCarrier.

Definition at line 42 of file MpiCarrier.h.

◆ respondToHeader()

bool MpiCarrier::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 125 of file MpiCarrier.cpp.

◆ sendAck()

bool MpiCarrier::sendAck ( yarp::os::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

Reimplemented from yarp::os::AbstractCarrier.

Definition at line 83 of file MpiCarrier.h.

◆ sendHeader()

bool MpiCarrier::sendHeader ( yarp::os::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 39 of file MpiCarrier.cpp.

◆ sendIndex()

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

inlineoverridevirtual

Reimplemented from yarp::os::AbstractCarrier.

Definition at line 72 of file MpiCarrier.h.

◆ supportReply()

bool MpiCarrier::supportReply ( ) const

overridepure virtual

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.

Implemented in MpiBcastCarrier, and MpiP2PCarrier.

◆ write()

bool MpiCarrier::write	(	yarp::os::ConnectionState &	proto,
		yarp::os::SizedWriter &	writer
	)

inlineoverridevirtual

Write a message.

Parameters

proto the protocol object, which tracks connection state

Returns: true on success, false on failure

Reimplemented from yarp::os::AbstractCarrier.

Definition at line 67 of file MpiCarrier.h.

Member Data Documentation

◆ comm

MpiComm* MpiCarrier::comm

protected

Definition at line 29 of file MpiCarrier.h.

◆ name

std::string MpiCarrier::name

protected

Definition at line 31 of file MpiCarrier.h.

◆ other

std::string MpiCarrier::other

protected

Definition at line 31 of file MpiCarrier.h.

◆ port

std::string MpiCarrier::port

protected

Definition at line 30 of file MpiCarrier.h.

◆ route

std::string MpiCarrier::route

protected

Definition at line 31 of file MpiCarrier.h.

◆ stream

MpiStream* MpiCarrier::stream

protected

Definition at line 28 of file MpiCarrier.h.

◆ target

std::string MpiCarrier::target

protected

Definition at line 32 of file MpiCarrier.h.

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

src/carriers/mpi_carrier/MpiCarrier.h
src/carriers/mpi_carrier/MpiCarrier.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MpiCarrier()

◆ ~MpiCarrier()

Member Function Documentation

◆ canEscape()

◆ checkHeader()

◆ close()

◆ create()

◆ createStream()

◆ expectAck()

◆ expectIndex()

◆ expectReplyToHeader()

◆ expectSenderSpecifier()

◆ getHeader()

◆ getName()

◆ isConnectionless()

◆ respondToHeader()

◆ sendAck()

◆ sendHeader()

◆ sendIndex()

◆ supportReply()

◆ write()

Member Data Documentation

◆ comm

◆ name

◆ other

◆ port

◆ route

◆ stream

◆ target