A port that is specialized as an RPC server. More...
#include <yarp/os/RpcServer.h>
Public Member Functions | |
RpcServer () | |
Constructor. | |
~RpcServer () override | |
Destructor. | |
virtual bool | write (const PortWriter &writer, const PortWriter *callback=nullptr) const override |
Write cannot be called by RPCServer. | |
virtual bool | write (const PortWriter &writer, PortReader &reader, const PortWriter *callback=nullptr) const override |
Write cannot be called by RPCServer. | |
bool | read (PortReader &reader, bool willReply=true) override |
Read an object from the port. | |
void | setInputMode (bool expectInput) override |
Configure the port to allow or forbid inputs. | |
void | setOutputMode (bool expectOutput) override |
Configure the port to allow or forbid outputs. | |
void | setRpcMode (bool expectRpc) override |
Configure the port to be RPC only. | |
Port & | asPort () override |
Get the concrete Port being used for communication. | |
const Port & | asPort () const override |
Get the concrete Port being used for communication, const version. | |
Public Member Functions inherited from yarp::os::AbstractContactable | |
bool | open (const std::string &name) override |
Start port operation, with a specific name, with automatically-chosen network parameters. | |
bool | open (const Contact &contact, bool registerName=true) override |
Start port operation with user-chosen network parameters. | |
bool | addOutput (const std::string &name) override |
Add an output connection to the specified port. | |
bool | addOutput (const std::string &name, const std::string &carrier) override |
Add an output connection to the specified port, using a specified carrier. | |
bool | addOutput (const Contact &contact) override |
Add an output connection to the specified port, using specified network parameters. | |
void | close () override |
Stop port activity. | |
void | interrupt () override |
Interrupt any current reads or writes attached to the port. | |
void | resume () override |
Put the port back in an operative state after interrupt() has been called. | |
Contact | where () const override |
Returns information about how this port can be reached. | |
std::string | getName () const override |
Get name of port. | |
bool | setEnvelope (PortWriter &envelope) override |
Set an envelope (e.g., a timestamp) to the next message which will be sent. | |
bool | getEnvelope (PortReader &envelope) override |
Get the envelope information (e.g., a timestamp) from the last message received on the port. | |
int | getInputCount () override |
Determine how many connections are arriving into this port. | |
int | getOutputCount () override |
Determine how many output connections this port has. | |
void | getReport (PortReport &reporter) override |
Get information on the state of the port - connections etc. | |
void | setReporter (PortReport &reporter) override |
Set a callback to be called upon any future connections and disconnections to/from the port. | |
void | resetReporter () override |
Remove the callback which is called upon any future connections and disconnections to/from the port. | |
bool | isWriting () override |
Report whether the port is currently writing data. | |
void | setReader (PortReader &reader) override |
Set an external reader for port data. | |
void | setAdminReader (PortReader &reader) override |
Set an external reader for unrecognized administrative port messages. | |
Type | getType () override |
Get the type of data the port has committed to send/receive. | |
void | promiseType (const Type &typ) override |
Commit the port to a particular type of data. | |
Property * | acquireProperties (bool readOnly) override |
Access unstructured port properties. | |
void | releaseProperties (Property *prop) override |
End access unstructured port properties. | |
bool | reply (PortWriter &writer) override |
Send an object as a reply to an object read from the port. | |
bool | replyAndDrop (PortWriter &writer) override |
Same as reply(), but closes connection after reply. | |
void | includeNodeInName (bool flag) override |
Choose whether to prepend a node name (if one is available) to the port's name. | |
bool | setCallbackLock (std::mutex *mutex=nullptr) override |
Add a lock to use when invoking callbacks. | |
bool | removeCallbackLock () override |
Remove a lock on callbacks added with setCallbackLock() | |
bool | lockCallback () override |
Lock callbacks until unlockCallback() is called. | |
bool | tryLockCallback () override |
Try to lock callbacks until unlockCallback() is called. | |
void | unlockCallback () override |
Unlock callbacks. | |
Public Member Functions inherited from yarp::os::Contactable | |
virtual | ~Contactable () |
Destructor. | |
void | setReadOnly () |
Shorthand for setInputMode(true), setOutputMode(false), setRpcMode(false) | |
void | setWriteOnly () |
Shorthand for setInputMode(false), setOutputMode(true), setRpcMode(false) | |
void | setRpcServer () |
Shorthand for setInputMode(true), setOutputMode(false), setRpcMode(true) | |
void | setRpcClient () |
Shorthand for setInputMode(false), setOutputMode(true), setRpcMode(true) | |
A port that is specialized as an RPC server.
That is, it expects to receive connections from multiple clients, and to reply to them via those connections.
Definition at line 22 of file RpcServer.h.
RpcServer::RpcServer | ( | ) |
Constructor.
Definition at line 18 of file RpcServer.cpp.
|
override |
Destructor.
Definition at line 25 of file RpcServer.cpp.
Get the concrete Port being used for communication, const version.
Implements yarp::os::AbstractContactable.
Definition at line 60 of file RpcServer.h.
|
inlineoverridevirtual |
Get the concrete Port being used for communication.
Implements yarp::os::AbstractContactable.
Definition at line 55 of file RpcServer.h.
|
overridevirtual |
Read an object from the port.
reader | any object that knows how to read itself from a network connection - see for example Bottle |
willReply | you must set this to true if you intend to call reply() |
Reimplemented from yarp::os::AbstractContactable.
Definition at line 49 of file RpcServer.cpp.
Configure the port to allow or forbid inputs.
By default, ports allow anything.
expectInput | set to true if this port will be used for input |
Reimplemented from yarp::os::AbstractContactable.
Definition at line 59 of file RpcServer.cpp.
Configure the port to allow or forbid outputs.
By default, ports allow anything.
expectOutput | set to true if this port will be used for output |
Reimplemented from yarp::os::AbstractContactable.
Definition at line 65 of file RpcServer.cpp.
Configure the port to be RPC only.
By default all ports can be used for RPC or streaming communication.
expectRpc | set to true if this port will be used for RPC only |
Reimplemented from yarp::os::AbstractContactable.
Definition at line 71 of file RpcServer.cpp.
|
overridevirtual |
Write cannot be called by RPCServer.
Reimplemented from yarp::os::AbstractContactable.
Definition at line 30 of file RpcServer.cpp.
|
overridevirtual |
Write cannot be called by RPCServer.
Reimplemented from yarp::os::AbstractContactable.
Definition at line 38 of file RpcServer.cpp.