RpcMonitor Class Reference

rpc_monitor: Documentation to be added More...

#include </home/runner/work/yarp-documentation/yarp-documentation/yarp/src/portmonitors/rpc_monitor/RpcMonitor.h>

Inheritance diagram for RpcMonitor:

Public Member Functions
bool	create (const yarp::os::Property &options) override
	This will be called when the dll is properly loaded by the portmonitor carrier.
yarp::os::Things &	update (yarp::os::Things &thing) override
	After data get accpeted in the accept() callback, an instance of that is given to the update function where the data can be accessed and modified.
yarp::os::Things &	updateReply (yarp::os::Things &thing) override
	The updateReply makes it possible to modify a reply from a port when the portmonitor object is attached to a two-ways connection (e.g., RPC).
Public Member Functions inherited from yarp::os::MonitorObject
virtual	~MonitorObject ()
virtual void	destroy ()
	This will be called when the portmonitor object destroyes.
virtual bool	setparam (const yarp::os::Property &params)
	This will be called when the portmonitor carrier parameters are set via YARP admin port.
virtual bool	getparam (yarp::os::Property &params)
	This will be called when the portmonitor carrier parameters are requested via YARP admin port.
virtual void	trig ()
	This will be called when one of the peer connections to the same import port receives data.
virtual bool	accept (yarp::os::Things &thing)
	This will be called when the data reach the portmonitor object.

Detailed Description

rpc_monitor: Documentation to be added

Definition at line 19 of file RpcMonitor.h.

Member Function Documentation

create()

bool RpcMonitor::create ( const yarp::os::Property &  options )

overridevirtual

This will be called when the dll is properly loaded by the portmonitor carrier.

Parameters

options

A set of useful information of the current connection which the monitor object is attached.

Returns

Returning false will stop the portmonitor object to procced

Reimplemented from yarp::os::MonitorObject.

Definition at line 37 of file RpcMonitor.cpp.

update()

yarp::os::Things & RpcMonitor::update ( yarp::os::Things &  thing )

overridevirtual

After data get accpeted in the accept() callback, an instance of that is given to the update function where the data can be accessed and modified.

Parameters

thing

An instance of yarp::os::Thing object which can be used to typecast the data to the correct type.

Returns

An instance of modified data in form of Thing

Reimplemented from yarp::os::MonitorObject.

Definition at line 68 of file RpcMonitor.cpp.

updateReply()

yarp::os::Things & RpcMonitor::updateReply ( yarp::os::Things &  thing )

overridevirtual

The updateReply makes it possible to modify a reply from a port when the portmonitor object is attached to a two-ways connection (e.g., RPC).

Parameters

thing

An instance of yarp::os::Thing object which can be used to typecast the data to the correct type.

Returns

An instance of modified data in form of Thing

Reimplemented from yarp::os::MonitorObject.

Definition at line 97 of file RpcMonitor.cpp.

---

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

• src/portmonitors/rpc_monitor/RpcMonitor.h
• src/portmonitors/rpc_monitor/RpcMonitor.cpp