YARP  2.3.68+225-20170329.5+gitb0d3289
Yet Another Robot Platform
yarp::os::MpiCarrier Class Referenceabstract

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

#include <mpi_carrier/include/yarp/os/MpiCarrier.h>

+ Inheritance diagram for yarp::os::MpiCarrier:

Public Member Functions

 MpiCarrier ()
 
virtual ~MpiCarrier ()
 
virtual void close ()=0
 Close the carrier. More...
 
virtual Carriercreate ()=0
 Factory method. More...
 
virtual ConstString getName ()=0
 Get the name of this connection type ("tcp", "mcast", "shmem", ...) More...
 
virtual void createStream (bool sender)=0
 
virtual bool isConnectionless ()
 Check if this carrier is connectionless (like udp, mcast) or connection based (like tcp). More...
 
virtual bool canEscape ()
 Check if carrier can encode administrative messages, as opposed to just user data. More...
 
virtual bool supportReply ()=0
 This flag is used by YARP to determine whether the connection can carry RPC traffic, that is, messages with replies. More...
 
virtual void getHeader (const Bytes &header)
 Provide 8 bytes describing this connection sufficiently to allow the other side of a connection to select it. More...
 
virtual bool checkHeader (const Bytes &header)
 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 bool sendHeader (ConnectionState &proto)
 Write a header appropriate to the carrier to the connection, followed by any carrier-specific data. More...
 
virtual bool expectSenderSpecifier (ConnectionState &proto)
 Expect the name of the sending port. More...
 
virtual bool respondToHeader (ConnectionState &proto)
 Respond to the header. More...
 
virtual bool expectReplyToHeader (ConnectionState &proto)
 Process reply to header, if one is expected for this carrier. More...
 
bool write (ConnectionState &proto, SizedWriter &writer)
 Write a message. More...
 
virtual bool sendIndex (ConnectionState &proto, SizedWriter &writer)
 
virtual bool expectIndex (ConnectionState &proto)
 Expect a message header, if there is one for this carrier. More...
 
virtual bool sendAck (ConnectionState &proto)
 Send an acknowledgement, if needed for this carrier. More...
 
virtual bool expectAck (ConnectionState &proto)
 Receive an acknowledgement, if expected for this carrier. More...
 
- Public Member Functions inherited from yarp::os::AbstractCarrier
virtual void setParameters (const yarp::os::Bytes &header)
 Configure this carrier based on the first 8 bytes of the connection. More...
 
virtual bool canAccept ()
 Check if reading is implemented for this carrier. More...
 
virtual bool canOffer ()
 Check if writing is implemented for this carrier. More...
 
virtual bool isTextMode ()
 Check if carrier is textual in nature. More...
 
virtual bool requireAck ()
 Check if carrier has flow control, requiring sent messages to be acknowledged by recipient. More...
 
virtual bool isLocal ()
 Check if carrier operates within a single process. More...
 
virtual ConstString toString ()
 Get name of carrier. More...
 
virtual bool prepareSend (ConnectionState &proto)
 Perform any initialization needed before writing on a connection. More...
 
virtual bool expectExtraHeader (ConnectionState &proto)
 Receive any carrier-specific header. More...
 
virtual bool isActive ()
 Check if carrier is alive and error free. More...
 
virtual void setCarrierParams (const yarp::os::Property &params)
 Configure carrier from port administrative commands. More...
 
virtual void getCarrierParams (yarp::os::Property &params)
 Get carrier configuration and deliver it by port administrative commands. More...
 
bool defaultSendHeader (ConnectionState &proto)
 
bool defaultExpectIndex (ConnectionState &proto)
 
bool defaultSendIndex (ConnectionState &proto, SizedWriter &writer)
 
bool defaultExpectAck (ConnectionState &proto)
 
bool defaultSendAck (ConnectionState &proto)
 
int readYarpInt (ConnectionState &proto)
 
void writeYarpInt (int n, ConnectionState &proto)
 
- Public Member Functions inherited from yarp::os::Carrier
virtual bool isBroadcast ()
 Check if this carrier uses a broadcast mechanism. More...
 
virtual void handleEnvelope (const yarp::os::ConstString &envelope)
 Carriers that do not distinguish data from administrative headers (i.e. More...
 
virtual bool isPush ()
 Check if carrier is "push" or "pull" style. More...
 
virtual bool reply (ConnectionState &proto, SizedWriter &writer)
 
virtual void prepareDisconnect ()
 Do cleanup and preparation for the coming disconnect, if necessary. More...
 
virtual ~Carrier ()
 Destructor. More...
 
virtual ConstString getBootstrapCarrierName ()
 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...
 
virtual bool modifiesIncomingData ()
 Check if this carrier modifies incoming data through the Carrier::modifyIncomingData method. More...
 
virtual ConnectionReadermodifyIncomingData (ConnectionReader &reader)
 Modify incoming payload data, if appropriate. More...
 
virtual bool acceptIncomingData (ConnectionReader &reader)
 Determine whether incoming data should be accepted. More...
 
virtual bool modifiesOutgoingData ()
 Check if this carrier modifies outgoing data through the Carrier::modifyOutgoingData method. More...
 
virtual PortWritermodifyOutgoingData (PortWriter &writer)
 Modify outgoing payload data, if appropriate. More...
 
virtual bool modifiesReply ()
 Check if this carrier modifies outgoing data through the Carrier::modifyReply method. More...
 
virtual PortReadermodifyReply (PortReader &reader)
 Modify reply payload data, if appropriate. More...
 
virtual bool acceptOutgoingData (PortWriter &writer)
 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)
 
- Public Member Functions inherited from yarp::os::Connection
virtual ~Connection ()
 Destructor. More...
 
virtual bool isValid ()
 Check if this object is really a connection, or just an empty placeholder. More...
 
virtual bool isBareMode ()
 Check if carrier excludes type information from payload. More...
 

Protected Attributes

MpiStreamstream
 
MpiCommcomm
 
ConstString port
 
ConstString name
 
ConstString other
 
ConstString route
 
ConstString target
 

Additional Inherited Members

- Protected Member Functions inherited from yarp::os::AbstractCarrier
int getSpecifier (const Bytes &b)
 
void createStandardHeader (int specifier, const yarp::os::Bytes &header)
 
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, const yarp::os::Bytes &header)
 

Detailed Description

Abstract base carrier for managing port communication via MPI.

Definition at line 31 of file MpiCarrier.h.

Constructor & Destructor Documentation

◆ MpiCarrier()

MpiCarrier::MpiCarrier ( )

Definition at line 19 of file MpiCarrier.cpp.

◆ ~MpiCarrier()

MpiCarrier::~MpiCarrier ( )
virtual

Definition at line 25 of file MpiCarrier.cpp.

Member Function Documentation

◆ canEscape()

virtual bool yarp::os::MpiCarrier::canEscape ( )
inlinevirtual

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 51 of file MpiCarrier.h.

◆ checkHeader()

bool MpiCarrier::checkHeader ( const Bytes header)
virtual

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
headera 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 37 of file MpiCarrier.cpp.

◆ close()

virtual void yarp::os::MpiCarrier::close ( void  )
pure virtual

Close the carrier.

Reimplemented from yarp::os::Carrier.

Implemented in yarp::os::MpiBcastCarrier, and yarp::os::MpiP2PCarrier.

◆ create()

virtual Carrier* yarp::os::MpiCarrier::create ( )
pure 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 yarp::os::MpiBcastCarrier, and yarp::os::MpiP2PCarrier.

◆ createStream()

virtual void yarp::os::MpiCarrier::createStream ( bool  sender)
pure virtual

◆ expectAck()

virtual bool yarp::os::MpiCarrier::expectAck ( ConnectionState proto)
inlinevirtual

Receive an acknowledgement, if expected for this carrier.

Parameters
protothe protocol object, which tracks connection state
Returns
true on success, false on failure

Reimplemented from yarp::os::AbstractCarrier.

Definition at line 92 of file MpiCarrier.h.

◆ expectIndex()

virtual bool yarp::os::MpiCarrier::expectIndex ( ConnectionState proto)
inlinevirtual

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

Parameters
protothe protocol object, which tracks connection state
Returns
true on success, false on failure

Reimplemented from yarp::os::AbstractCarrier.

Definition at line 81 of file MpiCarrier.h.

◆ expectReplyToHeader()

bool MpiCarrier::expectReplyToHeader ( ConnectionState proto)
virtual

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

Parameters
protothe protocol object, which tracks connection state
Returns
true on success, false on failure

Reimplemented from yarp::os::AbstractCarrier.

Reimplemented in yarp::os::MpiBcastCarrier.

Definition at line 152 of file MpiCarrier.cpp.

◆ expectSenderSpecifier()

bool MpiCarrier::expectSenderSpecifier ( ConnectionState proto)
virtual

Expect the name of the sending port.

Parameters
protothe protocol object, which tracks connection state
Returns
true on success, false on failure

Reimplemented from yarp::os::AbstractCarrier.

Definition at line 103 of file MpiCarrier.cpp.

◆ getHeader()

void MpiCarrier::getHeader ( const Bytes header)
virtual

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

Parameters
headera buffer to hold the first 8 bytes to send on a connection

Implements yarp::os::AbstractCarrier.

Definition at line 31 of file MpiCarrier.cpp.

◆ getName()

virtual ConstString yarp::os::MpiCarrier::getName ( )
pure virtual

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

Returns
the name of this connection type

Implements yarp::os::AbstractCarrier.

Implemented in yarp::os::MpiBcastCarrier, and yarp::os::MpiP2PCarrier.

◆ isConnectionless()

virtual bool yarp::os::MpiCarrier::isConnectionless ( )
inlinevirtual

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 47 of file MpiCarrier.h.

◆ respondToHeader()

bool MpiCarrier::respondToHeader ( ConnectionState proto)
virtual

Respond to the header.

Parameters
protothe protocol object, which tracks connection state
Returns
true on success, false on failure

Implements yarp::os::AbstractCarrier.

Definition at line 133 of file MpiCarrier.cpp.

◆ sendAck()

virtual bool yarp::os::MpiCarrier::sendAck ( ConnectionState proto)
inlinevirtual

Send an acknowledgement, if needed for this carrier.

Parameters
protothe protocol object, which tracks connection state
Returns
true on success, false on failure

Reimplemented from yarp::os::AbstractCarrier.

Definition at line 88 of file MpiCarrier.h.

◆ sendHeader()

bool MpiCarrier::sendHeader ( ConnectionState proto)
virtual

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
protothe protocol object, which tracks connection state
Returns
true on success, false on failure

Reimplemented from yarp::os::AbstractCarrier.

Definition at line 49 of file MpiCarrier.cpp.

◆ sendIndex()

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

Reimplemented from yarp::os::AbstractCarrier.

Definition at line 77 of file MpiCarrier.h.

◆ supportReply()

virtual bool yarp::os::MpiCarrier::supportReply ( )
pure 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 yarp::os::MpiBcastCarrier, and yarp::os::MpiP2PCarrier.

◆ write()

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

Write a message.

Parameters
protothe protocol object, which tracks connection state
Returns
true on success, false on failure

Reimplemented from yarp::os::AbstractCarrier.

Definition at line 72 of file MpiCarrier.h.

Member Data Documentation

◆ comm

MpiComm* yarp::os::MpiCarrier::comm
protected

Definition at line 34 of file MpiCarrier.h.

◆ name

ConstString yarp::os::MpiCarrier::name
protected

Definition at line 36 of file MpiCarrier.h.

◆ other

ConstString yarp::os::MpiCarrier::other
protected

Definition at line 36 of file MpiCarrier.h.

◆ port

ConstString yarp::os::MpiCarrier::port
protected

Definition at line 35 of file MpiCarrier.h.

◆ route

ConstString yarp::os::MpiCarrier::route
protected

Definition at line 36 of file MpiCarrier.h.

◆ stream

MpiStream* yarp::os::MpiCarrier::stream
protected

Definition at line 33 of file MpiCarrier.h.

◆ target

ConstString yarp::os::MpiCarrier::target
protected

Definition at line 37 of file MpiCarrier.h.


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