This carrier enables XML/RPC message transmission. More...

#include <xmlrpc_carrier/XmlRpcCarrier.h>

Inheritance diagram for XmlRpcCarrier:

Public Member Functions
	XmlRpcCarrier ()

Carrier *	create () const override
	Factory method. More...

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

bool	isConnectionless () const override
	Check if this carrier is connectionless (like udp, mcast) or connection based (like tcp). 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	canEscape () const override
	Check if carrier can encode administrative messages, as opposed to just user data. More...

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

bool	isLocal () const override
	Check if carrier operates within a single process. More...

std::string	toString () const override
	Get name of carrier. 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...

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

bool	prepareSend (yarp::os::ConnectionState &proto) override
	Perform any initialization needed before writing on a 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	expectExtraHeader (yarp::os::ConnectionState &proto) override
	Receive any carrier-specific header. 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	isActive () const override
	Check if carrier is alive and error free. More...

bool	write (yarp::os::ConnectionState &proto, yarp::os::SizedWriter &writer) override
	Write a message. More...

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

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

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

std::string	getBootstrapCarrierName () const override
	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...

Public Member Functions inherited from yarp::os::Carrier
virtual Carrier *	create () const =0
	Factory method. More...

virtual bool	checkHeader (const Bytes &header)=0
	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)=0
	Configure this carrier based on the first 8 bytes of the connection. More...

void	getHeader (Bytes &header) const override=0
	Provide 8 bytes describing this connection sufficiently to allow the other side of a connection to select it. More...

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

bool	isBroadcast () const override
	Check if this carrier uses a broadcast mechanism. More...

virtual bool	canAccept () const =0
	Check if reading is implemented for this carrier. More...

virtual bool	canOffer () const =0
	Check if writing is implemented for this carrier. More...

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

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

void	handleEnvelope (const std::string &envelope) override
	Carriers that do not distinguish data from administrative headers (i.e. More...

bool	requireAck () const override=0
	Check if carrier has flow control, requiring sent messages to be acknowledged by recipient. More...

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

bool	isLocal () const override=0
	Check if carrier operates within a single process. More...

bool	isPush () const override
	Check if carrier is "push" or "pull" style. More...

virtual bool	prepareSend (ConnectionState &proto)=0
	Perform any initialization needed before writing on a connection. More...

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

virtual bool	expectReplyToHeader (ConnectionState &proto)=0
	Process reply to header, if one is expected for this carrier. More...

virtual bool	write (ConnectionState &proto, SizedWriter &writer)=0
	Write a message. More...

virtual bool	reply (ConnectionState &proto, SizedWriter &writer)

virtual bool	expectExtraHeader (ConnectionState &proto)=0
	Receive any carrier-specific header. More...

virtual bool	respondToHeader (ConnectionState &proto)=0
	Respond to the header. More...

virtual bool	expectIndex (ConnectionState &proto)=0
	Expect a message header, if there is one for this carrier. More...

virtual bool	expectSenderSpecifier (ConnectionState &proto)=0
	Expect the name of the sending port. More...

virtual bool	sendAck (ConnectionState &proto)=0
	Send an acknowledgement, if needed for this carrier. More...

virtual bool	expectAck (ConnectionState &proto)=0
	Receive an acknowledgement, if expected for this carrier. More...

bool	isActive () const override=0
	Check if carrier is alive and error free. More...

void	prepareDisconnect () override
	Do cleanup and preparation for the coming disconnect, if necessary. More...

virtual std::string	toString () const =0
	Get name of carrier. More...

virtual void	close ()
	Close the carrier. 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 &params) override
	Configure carrier from port administrative commands. More...

void	getCarrierParams (Property &params) 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	isTextMode () const =0
	Check if carrier is textual in nature. More...

virtual bool	isBareMode () const
	Check if carrier excludes type information from payload. More...

virtual void	handleEnvelope (const std::string &envelope)=0
	Carriers that do not distinguish data from administrative headers (i.e. More...

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

virtual bool	requireAck () const =0
	Check if carrier has flow control, requiring sent messages to be acknowledged by recipient. More...

virtual bool	supportReply () const =0
	This flag is used by YARP to determine whether the connection can carry RPC traffic, that is, messages with replies. More...

virtual bool	isLocal () const =0
	Check if carrier operates within a single process. More...

virtual bool	isPush () const =0
	Check if carrier is "push" or "pull" style. More...

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

virtual bool	isBroadcast () const =0
	Check if this carrier uses a broadcast mechanism. More...

virtual bool	isActive () const =0
	Check if carrier is alive and error free. More...

virtual bool	modifiesIncomingData () const =0
	Check if this carrier modifies incoming data through the Carrier::modifyIncomingData method. More...

virtual yarp::os::ConnectionReader &	modifyIncomingData (yarp::os::ConnectionReader &reader)=0
	Modify incoming payload data, if appropriate. More...

virtual bool	acceptIncomingData (yarp::os::ConnectionReader &reader)=0
	Determine whether incoming data should be accepted. More...

virtual bool	modifiesOutgoingData () const =0
	Check if this carrier modifies outgoing data through the Carrier::modifyOutgoingData method. More...

virtual const PortWriter &	modifyOutgoingData (const PortWriter &writer)=0
	Modify outgoing payload data, if appropriate. More...

virtual bool	acceptOutgoingData (const PortWriter &writer)=0
	Determine whether outgoing data should be accepted. More...

virtual bool	modifiesReply () const =0
	Check if this carrier modifies outgoing data through the Carrier::modifyReply method. More...

virtual PortReader &	modifyReply (PortReader &reader)=0
	Modify reply payload data, if appropriate. More...

virtual void	setCarrierParams (const yarp::os::Property &params)=0
	Configure carrier from port administrative commands. More...

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

virtual void	getHeader (yarp::os::Bytes &header) const =0
	Provide 8 bytes describing this connection sufficiently to allow the other side of a connection to select it. More...

virtual void	prepareDisconnect ()=0
	Do cleanup and preparation for the coming disconnect, if necessary. More...

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

Detailed Description

This carrier enables XML/RPC message transmission.

Example: at the time of writing, there is a public XML/RPC server at http://phpxmlrpc.sourceforge.net/server.php which has several methods. One is called "examples.addtwo" and expects two integers and returns an integer. So we can do:

yarp name register /webserve xmlrpc+path.server.php phpxmlrpc.sourceforge.net 80

The "80" corresponds to the usual http port number. The "xmlrpc+path.server.php" means "use xmlrpc carrier, and use a request path of server.php". Often this path can be omitted, but is important for this particular server.

Then: $ yarp rpc /webserve examples.addtwo 10 20 will produce the output "30" if the server still exists.

Definition at line 35 of file XmlRpcCarrier.h.

Constructor & Destructor Documentation

◆ XmlRpcCarrier()

XmlRpcCarrier::XmlRpcCarrier ( )

inline

Definition at line 45 of file XmlRpcCarrier.h.

Member Function Documentation

◆ canAccept()

bool XmlRpcCarrier::canAccept ( ) const

inlineoverridevirtual

Check if reading is implemented for this carrier.

Returns: true if carrier can read messages

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ XmlRpcCarrier()

Member Function Documentation

◆ canAccept()

◆ canEscape()

◆ canOffer()

◆ checkHeader()

◆ create()

◆ expectAck()

◆ expectExtraHeader()

◆ expectIndex()

◆ expectReplyToHeader()

◆ expectSenderSpecifier()

◆ getBootstrapCarrierName()

◆ getHeader()

◆ getName()

◆ isActive()

◆ isConnectionless()

◆ isLocal()

◆ isTextMode()

◆ prepareSend()

◆ reply()

◆ requireAck()

◆ respondToHeader()

◆ sendAck()

◆ sendHeader()

◆ sendIndex()

◆ setParameters()

◆ supportReply()

◆ toString()

◆ write()