YARP  2.3.68+283-20170530.4+git10f9853
Yet Another Robot Platform
yarp::os::RosSrvCarrier Class Reference

#include <tcpros_carrier/TcpRosCarrier.h>

+ Inheritance diagram for yarp::os::RosSrvCarrier:

Public Member Functions

 RosSrvCarrier ()
 
virtual Carriercreate ()
 Factory method. More...
 
- Public Member Functions inherited from yarp::os::TcpRosCarrier
 TcpRosCarrier ()
 
virtual ConstString getName ()
 Get the name of this connection type ("tcp", "mcast", "shmem", ...) More...
 
virtual bool isConnectionless ()
 Check if this carrier is connectionless (like udp, mcast) or connection based (like tcp). 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 isBareMode ()
 Check if carrier excludes type information from payload. More...
 
virtual bool canEscape ()
 Check if carrier can encode administrative messages, as opposed to just user data. More...
 
virtual bool requireAck ()
 Check if carrier has flow control, requiring sent messages to be acknowledged by recipient. More...
 
virtual bool supportReply ()
 This flag is used by YARP to determine whether the connection can carry RPC traffic, that is, messages with replies. More...
 
virtual bool isPush ()
 Check if carrier is "push" or "pull" style. More...
 
virtual bool isLocal ()
 Check if carrier operates within a single process. More...
 
virtual ConstString toString ()
 Get name of carrier. 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 void setParameters (const Bytes &header)
 Configure this carrier based on the first 8 bytes of the connection. More...
 
virtual bool prepareSend (ConnectionState &proto)
 Perform any initialization needed before writing on a 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 expectExtraHeader (ConnectionState &proto)
 Receive any carrier-specific header. More...
 
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...
 
virtual bool isActive ()
 Check if carrier is alive and error free. More...
 
virtual bool write (ConnectionState &proto, SizedWriter &writer)
 Write a message. More...
 
virtual bool reply (ConnectionState &proto, SizedWriter &writer)
 
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...
 
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 yarp::os::Contact &src, const yarp::os::Contact &dest, const yarp::os::ContactStyle &style, int mode, bool reversed)
 Some carrier types may require special connection logic. More...
 
- 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 void prepareDisconnect ()
 Do cleanup and preparation for the coming disconnect, if necessary. More...
 
virtual void close ()
 Close the carrier. More...
 
virtual ~Carrier ()
 Destructor. 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)
 
virtual void setCarrierParams (const Property &params)
 Configure carrier from port administrative commands. More...
 
virtual void getCarrierParams (Property &params)
 Get carrier configuration and deliver it by port administrative commands. More...
 
- 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...
 

Additional Inherited Members

- Protected Attributes inherited from yarp::os::TcpRosCarrier
bool isService
 

Detailed Description

Definition at line 203 of file TcpRosCarrier.h.

Constructor & Destructor Documentation

◆ RosSrvCarrier()

yarp::os::RosSrvCarrier::RosSrvCarrier ( )
inline

Definition at line 205 of file TcpRosCarrier.h.

Member Function Documentation

◆ create()

virtual Carrier* yarp::os::RosSrvCarrier::create ( )
inlinevirtual

Factory method.

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

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

Reimplemented from yarp::os::TcpRosCarrier.

Definition at line 209 of file TcpRosCarrier.h.


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