 |
YARP
Yet Another Robot Platform
|
|
|
YARP
Yet Another Robot Platform
|
|
Carrier for port communicating via MPI point-to-point send/receive. More...
#include <mpi_carrier/MpiP2PCarrier.h>
Inheritance diagram for MpiP2PCarrier:Public Member Functions | |
| MpiP2PCarrier () | |
| virtual | ~MpiP2PCarrier () |
| void | close () override |
| Close the carrier. More... | |
| Carrier * | create () const override |
| Factory method. More... | |
| void | createStream (bool sender) override |
| std::string | getName () const override |
| Get the name of this connection type ("tcp", "mcast", "shmem", ...) 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... | |
| Public Member Functions inherited from MpiCarrier | |
| MpiCarrier () | |
| virtual | ~MpiCarrier () |
| bool | isConnectionless () const override |
| Check if this carrier is connectionless (like udp, mcast) or connection based (like tcp). More... | |
| bool | canEscape () const override |
| Check if carrier can encode administrative messages, as opposed to just user data. 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... | |
| 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... | |
| bool | sendHeader (yarp::os::ConnectionState &proto) override |
| Write a header appropriate to the carrier to the connection, followed by any carrier-specific data. More... | |
| bool | expectSenderSpecifier (yarp::os::ConnectionState &proto) override |
| Expect the name of the sending port. More... | |
| bool | respondToHeader (yarp::os::ConnectionState &proto) override |
| Respond to the header. More... | |
| bool | expectReplyToHeader (yarp::os::ConnectionState &proto) override |
| Process reply to header, if one is expected for this carrier. More... | |
| bool | write (yarp::os::ConnectionState &proto, yarp::os::SizedWriter &writer) override |
| Write a message. More... | |
| 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. More... | |
| bool | sendAck (yarp::os::ConnectionState &proto) override |
| Send an acknowledgement, if needed for this carrier. More... | |
| bool | expectAck (yarp::os::ConnectionState &proto) override |
| Receive an acknowledgement, if expected for this carrier. More... | |
| 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. More... | |
| void | setCarrierParams (const yarp::os::Property ¶ms) override |
| Configure carrier from port administrative commands. More... | |
| void | getCarrierParams (yarp::os::Property ¶ms) 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 | isTextMode () const override |
| Check if carrier is textual in nature. More... | |
| bool | requireAck () const override |
| Check if carrier has flow control, requiring sent messages to be acknowledged by recipient. 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 | ~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 ¶ms) override |
| Configure carrier from port administrative commands. More... | |
| void | getCarrierParams (Property ¶ms) 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 | 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) |
| Protected Attributes inherited from MpiCarrier | |
| MpiStream * | stream |
| MpiComm * | comm |
| std::string | port |
| std::string | name |
| std::string | other |
| std::string | route |
| std::string | target |
Carrier for port communicating via MPI point-to-point send/receive.
Generic communication for arbitrary topology. Allows replies.
Definition at line 25 of file MpiP2PCarrier.h.
|
inline |
Definition at line 29 of file MpiP2PCarrier.h.
|
inlinevirtual |
Definition at line 35 of file MpiP2PCarrier.h.
|
inlineoverridevirtual |
|
inlineoverridevirtual |
Factory method.
Get a new object of the same type as this one.
Implements MpiCarrier.
Definition at line 43 of file MpiP2PCarrier.h.
|
inlineoverridevirtual |
Implements MpiCarrier.
Definition at line 47 of file MpiP2PCarrier.h.
|
inlineoverridevirtual |
Get the name of this connection type ("tcp", "mcast", "shmem", ...)
Implements MpiCarrier.
Definition at line 52 of file MpiP2PCarrier.h.
|
inlineoverridevirtual |
This flag is used by YARP to determine whether the connection can carry RPC traffic, that is, messages with replies.
Implements MpiCarrier.
Definition at line 56 of file MpiP2PCarrier.h.
1.8.20 