iCub-main
Public Member Functions | List of all members
IRpcServer Class Reference

IRpcServer Interface for an example module. More...

#include <IRpcServer.h>

+ Inheritance diagram for IRpcServer:

Public Member Functions

 IRpcServer ()
 
virtual std::int32_t get_answer ()
 Get answer from server. More...
 
virtual bool set_answer (const std::int32_t rightAnswer)
 Set value for future answers. More...
 
virtual std::int32_t add_int (const std::int32_t x)
 Add one integer to future answers. More...
 
virtual bool start ()
 Start service. More...
 
virtual bool stop ()
 Stop service. More...
 
virtual bool is_running ()
 Check is service is running. More...
 
virtual std::vector< std::string > help (const std::string &functionName="--all")
 
bool read (yarp::os::ConnectionReader &connection) override
 

Detailed Description

IRpcServer Interface for an example module.

Definition at line 24 of file IRpcServer.h.

Constructor & Destructor Documentation

◆ IRpcServer()

IRpcServer::IRpcServer ( )

Definition at line 289 of file IRpcServer.cpp.

Member Function Documentation

◆ add_int()

std::int32_t IRpcServer::add_int ( const std::int32_t  x)
virtual

Add one integer to future answers.

Parameters
xvalue to add
Returns
new value

Definition at line 314 of file IRpcServer.cpp.

◆ get_answer()

std::int32_t IRpcServer::get_answer ( )
virtual

Get answer from server.

Returns
the answer

Reimplemented in RpcServerImpl.

Definition at line 294 of file IRpcServer.cpp.

◆ help()

std::vector< std::string > IRpcServer::help ( const std::string &  functionName = "--all")
virtual

Definition at line 355 of file IRpcServer.cpp.

◆ is_running()

bool IRpcServer::is_running ( )
virtual

Check is service is running.

Returns
true/false if service is/is not running

Reimplemented in RpcServerImpl.

Definition at line 344 of file IRpcServer.cpp.

◆ read()

bool IRpcServer::read ( yarp::os::ConnectionReader &  connection)
override

Definition at line 415 of file IRpcServer.cpp.

◆ set_answer()

bool IRpcServer::set_answer ( const std::int32_t  rightAnswer)
virtual

Set value for future answers.

Parameters
rightAnswernew answer
Returns
true if connection was successful

Definition at line 304 of file IRpcServer.cpp.

◆ start()

bool IRpcServer::start ( )
virtual

Start service.

Returns
true if service started correctly

Reimplemented in RpcServerImpl.

Definition at line 324 of file IRpcServer.cpp.

◆ stop()

bool IRpcServer::stop ( )
virtual

Stop service.

Returns
true if service stopped correctly

Reimplemented in RpcServerImpl.

Definition at line 334 of file IRpcServer.cpp.


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