#include <vpServer.h>

Inheritance diagram for vpServer:

Public Member Functions
	vpServer ()
	vpServer (const vpServer &server)
VP_EXPLICIT	vpServer (const int &port)
	vpServer (const std::string &adress_serv, const int &port_serv)
vpServer &	operator= (const vpServer &server)
virtual	~vpServer () VP_OVERRIDE
bool	checkForConnections ()
bool	isStarted () const
unsigned int	getMaxNumberOfClients () const
unsigned int	getNumberOfClients () const
void	print ()
bool	start ()
void	setMaxNumberOfClients (const unsigned int &l)
void	addDecodingRequest (vpRequest *)
int	getReceptorIndex (const char *name)
std::string	getRequestIdFromIndex (const int &ind)
unsigned int	getMaxSizeReceivedMessage ()
void	print (const char *id="")
template<typename T>
int	receive (T *object, const unsigned int &sizeOfObject=sizeof(T))
template<typename T>
int	receiveFrom (T *object, const unsigned int &receptorEmitting, const unsigned int &sizeOfObject=sizeof(T))
std::vector< int >	receiveRequest ()
std::vector< int >	receiveRequestFrom (const unsigned int &receptorEmitting)
int	receiveRequestOnce ()
int	receiveRequestOnceFrom (const unsigned int &receptorEmitting)
std::vector< int >	receiveAndDecodeRequest ()
std::vector< int >	receiveAndDecodeRequestFrom (const unsigned int &receptorEmitting)
int	receiveAndDecodeRequestOnce ()
int	receiveAndDecodeRequestOnceFrom (const unsigned int &receptorEmitting)
void	removeDecodingRequest (const char *)
template<typename T>
int	send (T *object, const int unsigned &sizeOfObject=sizeof(T))
template<typename T>
int	send (T *object, const unsigned int &sizeOfObject)
template<typename T>
int	sendTo (T *object, const unsigned int &dest, const unsigned int &sizeOfObject=sizeof(T))
int	sendRequest (vpRequest &req)
int	sendRequestTo (vpRequest &req, const unsigned int &dest)
int	sendAndEncodeRequest (vpRequest &req)
int	sendAndEncodeRequestTo (vpRequest &req, const unsigned int &dest)
void	setMaxSizeReceivedMessage (const unsigned int &s)
void	setTimeoutSec (const long &sec)
void	setTimeoutUSec (const long &usec)
void	setVerbose (const bool &mode)

Protected Attributes
vpEmitter	emitter
std::vector< vpReceptor >	receptor_list
fd_set	readFileDescriptor
int	socketMax
std::vector< vpRequest * >	request_list
unsigned int	max_size_message
std::string	separator
std::string	beginning
std::string	end
std::string	param_sep
std::string	currentMessageReceived
struct timeval	tv
long	tv_sec
long	tv_usec
bool	verboseMode

Detailed Description

This class represents a Transmission Control Protocol (TCP) server.

TCP provides reliable, ordered delivery of a stream of bytes from a program on one computer to another program on another computer.

Example of server's code, receiving and sending basic message. It corresponds to the client used in the first example of vpClient class' documentation.

#include <iostream>
#include <visp3/core/vpServer.h>
 
int main(int argc,const char** argv)
{
  int port = 35000;
  vpServer serv(port); //Launch the server on localhost
  serv.start();
 
  bool run = true;
  int val;
 
  while(run){
    serv.checkForConnections();
 
    if(serv.getNumberOfClients() > 0)
    {
      // Receiving a value from the first client
      if(serv.receive(&val) != sizeof(int))
        std::cout << "Error while receiving" << std::endl;
      else
        std::cout << "Received : " << val << std::endl;
 
      val = val+1;
      // Sending the new value to the first client
      if(serv.send(&val) != sizeof(int))
        std::cout << "Error while sending" << std::endl;
      else
        std::cout << "Sending : " << val << std::endl;
    }
  }
 
  return 0;
}

Example of server's code, receiving a vpImage on request form. It correspond to the client used in the second example of vpClient class' documentation.

#include <visp3/core/vpServer.h>
#include <visp3/gui/vpDisplayGDI.h>
#include <visp3/gui/vpDisplayX.h>
 
#include "vpRequestImage.h" //See vpRequest class documentation
 
int main(int argc,const char** argv)
{
  int port = 35000;
 
  std::cout << "Port: " << port << std::endl;
  vpServer serv(port);
  serv.start();
 
#if defined(VISP_HAVE_X11)
  vpDisplayX display;
#elif defined(VISP_HAVE_GDI) //Win32
  vpDisplayGDI display;
#endif
 
  vpImage<unsigned char> I;
 
  vpRequestImage reqImage(&I);
  serv.addDecodingRequest(&reqImage);
 
  bool run = true;
 
  while(run){
    serv.checkForConnections();
 
    if(serv.getNumberOfClients() > 0)
    {
      int index = serv.receiveAndDecodeRequestOnce();
      std::string id = serv.getRequestIdFromIndex(index);
 
      if(id == reqImage.getId())
      {
#if defined(VISP_HAVE_X11) || defined(VISP_HAVE_GDI)
        if (! display.isInitialised() )
          display.init(I, -1, -1, "Remote display");
#endif
 
        vpDisplay::display(I) ;
        vpDisplay::flush(I);
 
        // A click in the viewer to exit
        if ( vpDisplay::getClick(I, false) )
          run = false;
      }
    }
  }
 
  return 0;
}

See also: vpClient; vpRequest; vpNetwork

Examples: testServer.cpp.

Definition at line 161 of file vpServer.h.

Constructor & Destructor Documentation

◆ vpServer() [1/4]

BEGIN_VISP_NAMESPACE vpServer::vpServer ( )

Construct a server on the machine launching it.

Definition at line 60 of file vpServer.cpp.

References vpNetwork::emitter, and vpERROR_TRACE.

Referenced by operator=(), and vpServer().

◆ vpServer() [2/4]

vpServer::vpServer ( const vpServer & server )

Copy constructor.

Parameters

server : Server to copy.

Definition at line 84 of file vpServer.cpp.

References vpNetwork::vpNetwork(), and vpServer().

◆ vpServer() [3/4]

vpServer::vpServer ( const int & port_serv )

Construct a server on the machine launching it, with a specified port.

Parameters

port_serv : server's port.

Definition at line 107 of file vpServer.cpp.

References vpNetwork::emitter, and vpERROR_TRACE.

◆ vpServer() [4/4]

vpServer::vpServer	(	const std::string &	adress_serv,
		const int &	port_serv )

Construct a server on the machine at a given adress, with a specified port.

Parameters

adress_serv	: server's adress.
port_serv	: server's port.

Definition at line 133 of file vpServer.cpp.

References vpNetwork::emitter, and vpERROR_TRACE.

◆ ~vpServer()

vpServer::~vpServer ( )

virtual

Shutdown the server.

Definition at line 158 of file vpServer.cpp.

References vpNetwork::emitter, and vpNetwork::receptor_list.

Member Function Documentation

◆ addDecodingRequest()

void vpNetwork::addDecodingRequest ( vpRequest * req )

inherited

Add a decoding request to the emitter. This request will be used to decode the received messages. Each request must have a different id.

Warning: vpRequest is a virtual pure class. It has to be implemented according to the way how you want to decode the message received.

See also: vpNetwork::removeDecodingRequest()

Parameters

req	: Request to add.

Definition at line 123 of file vpNetwork.cpp.

References vpRequest::getId(), and request_list.

◆ checkForConnections()

bool vpServer::checkForConnections ( )

Check if a client has connected or deconnected the server

Returns: True if a client connected or deconnected, false otherwise OR server not started yet.

Examples: testServer.cpp.

Definition at line 235 of file vpServer.cpp.

References vpNetwork::emitter, vpNetwork::readFileDescriptor, vpNetwork::receptor_list, vpNetwork::socketMax, start(), vpNetwork::tv, vpNetwork::tv_sec, vpNetwork::tv_usec, and vpERROR_TRACE.

◆ getMaxNumberOfClients()

unsigned int vpServer::getMaxNumberOfClients ( ) const

inline

Get the maximum number of clients that can be connected to the server.

See also: vpServer::setMaxNumberOfClients()

Returns: Maximum number of clients.

Definition at line 199 of file vpServer.h.

◆ getMaxSizeReceivedMessage()

unsigned int vpNetwork::getMaxSizeReceivedMessage ( )

inlineinherited

Get the maximum size that the emitter can receive (in request mode).

See also: vpNetwork::setMaxSizeReceivedMessage()

Returns: Acutal max size value.

Definition at line 214 of file vpNetwork.h.

References max_size_message.

◆ getNumberOfClients()

unsigned int vpServer::getNumberOfClients ( ) const

inline

Get the number of clients connected to the server.

Returns: Number of clients connected.

Examples: testServer.cpp.

Definition at line 206 of file vpServer.h.

References vpNetwork::receptor_list.

◆ getReceptorIndex()

int vpNetwork::getReceptorIndex ( const char * name )

inherited

Get the receptor index from its name. The name can be either the IP, or its name on the network.

Parameters

name	: Name of the receptor.

Returns: Index of the receptor, or -1 if an error occurs.

Definition at line 178 of file vpNetwork.cpp.

References receptor_list, and vpERROR_TRACE.

◆ getRequestIdFromIndex()

std::string vpNetwork::getRequestIdFromIndex ( const int & ind )

inlineinherited

Get the Id of the request at the index ind.

Parameters

ind	: Index of the request.

Returns: Id of the request.

Definition at line 199 of file vpNetwork.h.

References request_list.

◆ isStarted()

bool vpServer::isStarted ( ) const

inline

Check if the server is started.

See also: vpServer::start()

Returns: True if the server is started, false otherwise.

Definition at line 190 of file vpServer.h.

◆ operator=()

vpServer & vpServer::operator= ( const vpServer & server )

Copy operator.

Parameters

server : Server to copy.

Definition at line 93 of file vpServer.cpp.

References vpServer().

◆ print() [1/2]

void vpNetwork::print ( const char * id = "" )

inherited

Print the receptors.

Parameters

id	: Message to display before the receptor's index.

Definition at line 163 of file vpNetwork.cpp.

References receptor_list.

Referenced by vpClient::print(), and vpServer::print().

◆ print() [2/2]

void vpServer::print ( )

Print the connected clients.

Definition at line 324 of file vpServer.cpp.

References vpNetwork::print().

◆ receive()

template<typename T>

int vpNetwork::receive	(	T *	object,
		const unsigned int &	sizeOfObject = sizeof(T) )

inherited

Receives a object. The size of the object received is assumed to correspond to the size of the object type. Note that a message received may correspond to a disconnection signal.

Warning: Using this function means that you know what kind of object you are suppose to receive, and when you are suppose to receive. If the emitter has several receptors. It might be a problem, and in that case you better use the "request" option.

See also: vpNetwork::receiveRequest(); vpNetwork::receiveRequestOnce(); vpNetwork::receiveAndDecodeRequest(); vpNetwork::receiveAndDecodeRequestOnce()

Parameters

object	: Received object.
sizeOfObject	: Size of the received object.

Returns: the number of bytes received, or -1 if an error occurred.

Examples: testClient.cpp, and testServer.cpp.

Definition at line 304 of file vpNetwork.h.

References readFileDescriptor, receptor_list, socketMax, tv, tv_sec, tv_usec, verboseMode, vpERROR_TRACE, and vpTRACE.

◆ receiveAndDecodeRequest()

std::vector< int > vpNetwork::receiveAndDecodeRequest ( )

inherited

Receives and decode requests until there is requests to receive.

Warning: Requests will be received but not decoded.

See also: vpNetwork::receive(); vpNetwork::receiveRequestFrom(); vpNetwork::receiveRequestOnce(); vpNetwork::receiveRequestOnceFrom(); vpNetwork::receiveAndDecodeRequest(); vpNetwork::receiveAndDecodeRequestFrom(); vpNetwork::receiveAndDecodeRequestOnce(); vpNetwork::receiveAndDecodeRequestOnceFrom()

Definition at line 415 of file vpNetwork.cpp.

References receiveRequest(), and request_list.

◆ receiveAndDecodeRequestFrom()

std::vector< int > vpNetwork::receiveAndDecodeRequestFrom ( const unsigned int & receptorEmitting )

inherited

Receives and decode requests, from a specific emitter, until there is request to receive.

Warning: Requests will be received but not decoded.

See also: vpNetwork::receive(); vpNetwork::receiveRequest(); vpNetwork::receiveRequestOnce(); vpNetwork::receiveRequestOnceFrom(); vpNetwork::receiveAndDecodeRequest(); vpNetwork::receiveAndDecodeRequestFrom(); vpNetwork::receiveAndDecodeRequestOnce(); vpNetwork::receiveAndDecodeRequestOnceFrom()

Parameters

receptorEmitting : Index of the receptor emitting the message

Definition at line 442 of file vpNetwork.cpp.

References receiveRequestFrom(), and request_list.

◆ receiveAndDecodeRequestOnce()

int vpNetwork::receiveAndDecodeRequestOnce ( )

inherited

Receives a message once (in the limit of the Maximum message size value). This message can represent an entire request or not. Several calls to this function might be necessary to get the entire request. If it represents an entire request, it decodes the request.

Warning: Requests will be received but not decoded.

See also: vpNetwork::receive(); vpNetwork::receiveRequestFrom(); vpNetwork::receiveRequest(); vpNetwork::receiveRequestOnceFrom(); vpNetwork::receiveAndDecodeRequest(); vpNetwork::receiveAndDecodeRequestFrom(); vpNetwork::receiveAndDecodeRequestOnce(); vpNetwork::receiveAndDecodeRequestOnceFrom()

Returns: The number of bytes received, -1 if an error occurred.

Definition at line 472 of file vpNetwork.cpp.

References receiveRequestOnce(), and request_list.

◆ receiveAndDecodeRequestOnceFrom()

int vpNetwork::receiveAndDecodeRequestOnceFrom ( const unsigned int & receptorEmitting )

inherited

Receives a message once (in the limit of the Maximum message size value), from a specific emitter. This message can represent an entire request or not. Several calls to this function might be necessary to get the entire request. If it represents an entire request, it decodes the request.

Warning: Requests will be received but not decoded.

See also: vpNetwork::receive(); vpNetwork::receiveRequestFrom(); vpNetwork::receiveRequest(); vpNetwork::receiveRequestOnce(); vpNetwork::receiveAndDecodeRequest(); vpNetwork::receiveAndDecodeRequestFrom(); vpNetwork::receiveAndDecodeRequestOnce(); vpNetwork::receiveAndDecodeRequestOnceFrom()

Parameters

receptorEmitting : Index of the receptor emitting the message.

Returns: The number of bytes received, -1 if an error occurred.

Definition at line 502 of file vpNetwork.cpp.

References receiveRequestOnceFrom(), and request_list.

◆ receiveFrom()

template<typename T>

int vpNetwork::receiveFrom	(	T *	object,
		const unsigned int &	receptorEmitting,
		const unsigned int &	sizeOfObject = sizeof(T) )

inherited

Receives a object from a receptor, by specifying its size or not. Note that a received message can correspond to a deconnection signal.

Warning: Using this function means that you know what kind of object you are suppose to receive, and when you are suppose to receive. If the emitter has several receptors. It might be a problem, and in that case you better use the "request" mode.

See also: vpNetwork::getReceptorIndex(); vpNetwork::receiveRequestFrom(); vpNetwork::receiveRequestOnceFrom(); vpNetwork::receiveAndDecodeRequestFrom(); vpNetwork::receiveAndDecodeRequestOnceFrom()

Parameters

object	: Received object.
receptorEmitting	: Index of the receptor emitting the message.
sizeOfObject	: Size of the received object.

Returns: the number of bytes received, or -1 if an error occurred.

Definition at line 388 of file vpNetwork.h.

References readFileDescriptor, receptor_list, socketMax, tv, tv_sec, tv_usec, verboseMode, vpERROR_TRACE, and vpTRACE.

◆ receiveRequest()

std::vector< int > vpNetwork::receiveRequest ( )

inherited

Receive requests until there is requests to receive.

Warning: Requests will be received but not decoded.

See also: vpNetwork::receive(); vpNetwork::receiveRequestFrom(); vpNetwork::receiveRequestOnce(); vpNetwork::receiveRequestOnceFrom(); vpNetwork::receiveAndDecodeRequest(); vpNetwork::receiveAndDecodeRequestFrom(); vpNetwork::receiveAndDecodeRequestOnce(); vpNetwork::receiveAndDecodeRequestOnceFrom()

Definition at line 321 of file vpNetwork.cpp.

Referenced by receiveAndDecodeRequest().

◆ receiveRequestFrom()

std::vector< int > vpNetwork::receiveRequestFrom ( const unsigned int & receptorEmitting )

inherited

Receives requests, from a specific emitter, until there is request to receive.

Warning: Requests will be received but not decoded.

See also: vpNetwork::receive(); vpNetwork::receiveRequest(); vpNetwork::receiveRequestOnce(); vpNetwork::receiveRequestOnceFrom(); vpNetwork::receiveAndDecodeRequest(); vpNetwork::receiveAndDecodeRequestFrom(); vpNetwork::receiveAndDecodeRequestOnce(); vpNetwork::receiveAndDecodeRequestOnceFrom()

Parameters

receptorEmitting : Index of the receptor emitting the message

Definition at line 344 of file vpNetwork.cpp.

Referenced by receiveAndDecodeRequestFrom().

◆ receiveRequestOnce()

int vpNetwork::receiveRequestOnce ( )

inherited

Receives a message once (in the limit of the Maximum message size value). This message can represent an entire request or not. Several calls to this function might be necessary to get the entire request.

Warning: Requests will be received but not decoded.

See also: vpNetwork::receive(); vpNetwork::receiveRequestFrom(); vpNetwork::receiveRequest(); vpNetwork::receiveRequestOnceFrom(); vpNetwork::receiveAndDecodeRequest(); vpNetwork::receiveAndDecodeRequestFrom(); vpNetwork::receiveAndDecodeRequestOnce(); vpNetwork::receiveAndDecodeRequestOnceFrom()

Returns: The number of bytes received, -1 if an error occurred.

Definition at line 368 of file vpNetwork.cpp.

Referenced by receiveAndDecodeRequestOnce().

◆ receiveRequestOnceFrom()

int vpNetwork::receiveRequestOnceFrom ( const unsigned int & receptorEmitting )

inherited

Receives a message once (in the limit of the Maximum message size value), from a specific emitter. This message can represent an entire request or not. Several calls to this function might be necessary to get the entire request.

Warning: Requests will be received but not decoded.

See also: vpNetwork::receive(); vpNetwork::receiveRequestFrom(); vpNetwork::receiveRequest(); vpNetwork::receiveRequestOnce(); vpNetwork::receiveAndDecodeRequest(); vpNetwork::receiveAndDecodeRequestFrom(); vpNetwork::receiveAndDecodeRequestOnce(); vpNetwork::receiveAndDecodeRequestOnceFrom()

Parameters

receptorEmitting : Index of the receptor emitting the message.

Returns: The number of bytes received, -1 if an error occurred.

Definition at line 395 of file vpNetwork.cpp.

Referenced by receiveAndDecodeRequestOnceFrom().

◆ removeDecodingRequest()

void vpNetwork::removeDecodingRequest ( const char * id )

inherited

Delete a decoding request from the emitter.

See also: vpNetwork::addDecodingRequest()

Parameters

id	: Id of the request to delete.

Definition at line 148 of file vpNetwork.cpp.

References request_list.

◆ send() [1/2]

template<typename T>

int vpNetwork::send	(	T *	object,
		const int unsigned &	sizeOfObject = sizeof(T) )

inherited

Examples: testClient.cpp, and testServer.cpp.

References sendAndEncodeRequest(), sendAndEncodeRequestTo(), sendRequest(), sendRequestTo(), and sendTo().

◆ send() [2/2]

template<typename T>

int vpNetwork::send	(	T *	object,
		const unsigned int &	sizeOfObject )

inherited

Send an object. The size of the received object is suppose to be the size of its type. Note that sending object containing pointers, virtual methods, etc, won't probably work.

Warning: Using this function means that, in the other side of the network, it knows what kind of object it is suppose to receive, and when it is suppose to receive. If the emitter has several receptors. It might be a problem, and in that case you better use the "request" option.

See also: vpNetwork::sendTo(); vpNetwork::sendRequest(); vpNetwork::sendRequestTo(); vpNetwork::sendAndEncodeRequest(); vpNetwork::sendAndEncodeRequestTo()

Parameters

object	: Received object.
sizeOfObject	: Size of the object

Returns: The number of bytes sent, or -1 if an error happened.

Definition at line 462 of file vpNetwork.h.

References receptor_list, verboseMode, and vpTRACE.

◆ sendAndEncodeRequest()

int vpNetwork::sendAndEncodeRequest ( vpRequest & req )

inherited

Send and encode a request to the first receptor in the list.

See also: vpNetwork::sendRequestTo(); vpNetwork::sendAndEncodeRequest(); vpNetwork::sendAndEncodeRequestTo(); vpNetwork::send(); vpNetwork::sendTo()

Parameters

req	: Request to send.

Returns: The number of bytes that have been sent, -1 if an error occurred.

Definition at line 281 of file vpNetwork.cpp.

References vpRequest::encode(), and sendRequest().

Referenced by send().

◆ sendAndEncodeRequestTo()

int vpNetwork::sendAndEncodeRequestTo	(	vpRequest &	req,
		const unsigned int &	dest )

inherited

Send and encode a request to a specific receptor.

See also: vpNetwork::sendRequest(); vpNetwork::sendAndEncodeRequest(); vpNetwork::sendAndEncodeRequestTo(); vpNetwork::send(); vpNetwork::sendTo()

Parameters

req	: Request to send.
dest	: Index of the receptor receiving the request.

Returns: The number of bytes that have been sent, -1 if an error occurred.

Definition at line 301 of file vpNetwork.cpp.

References vpRequest::encode(), and sendRequestTo().

Referenced by send().

◆ sendRequest()

int vpNetwork::sendRequest ( vpRequest & req )

inherited

Send a request to the first receptor in the list.

See also: vpNetwork::sendRequestTo(); vpNetwork::sendAndEncodeRequest(); vpNetwork::sendAndEncodeRequestTo(); vpNetwork::send(); vpNetwork::sendTo()

Parameters

req	: Request to send.

Returns: The number of bytes that have been sent, -1 if an error occurred.

Definition at line 213 of file vpNetwork.cpp.

References sendRequestTo().

Referenced by send(), and sendAndEncodeRequest().

◆ sendRequestTo()

int vpNetwork::sendRequestTo	(	vpRequest &	req,
		const unsigned int &	dest )

inherited

Send a request to a specific receptor.

See also: vpNetwork::sendRequest(); vpNetwork::sendAndEncodeRequest(); vpNetwork::sendAndEncodeRequestTo(); vpNetwork::send(); vpNetwork::sendTo()

Parameters

req	: Request to send.
dest	: Index of the receptor receiving the request.

Returns: The number of bytes that have been sent, -1 if an error occurred.

Definition at line 229 of file vpNetwork.cpp.

References beginning, end, vpRequest::getId(), param_sep, receptor_list, separator, vpRequest::size(), verboseMode, and vpTRACE.

Referenced by send(), sendAndEncodeRequestTo(), and sendRequest().

◆ sendTo()

template<typename T>

int vpNetwork::sendTo	(	T *	object,
		const unsigned int &	dest,
		const unsigned int &	sizeOfObject = sizeof(T) )

inherited

Send an object. The size has to be specified.

Warning: Using this function means that, in the other side of the network, it knows what kind of object it is suppose to receive, and when it is suppose to receive. If the emitter has several receptors. It might be a problem, and in that case you better use the "request" option.

See also: vpNetwork::getReceptorIndex(); vpNetwork::send(); vpNetwork::sendRequest(); vpNetwork::sendRequestTo(); vpNetwork::sendAndEncodeRequest(); vpNetwork::sendAndEncodeRequestTo()

Parameters

object	: Object to send.
dest	: Index of the receptor that you are sending the object.
sizeOfObject	: Size of the object.

Returns: The number of bytes sent, or -1 if an error happened.

Definition at line 506 of file vpNetwork.h.

References receptor_list, verboseMode, and vpTRACE.

Referenced by send().

◆ setMaxNumberOfClients()

void vpServer::setMaxNumberOfClients ( const unsigned int & l )

inline

Set the maximum number of clients that can be connected to the server.

See also: vpServer::getMaxNumberOfClients()

Parameters

l	: Maximum number of clients.

Definition at line 219 of file vpServer.h.

◆ setMaxSizeReceivedMessage()

void vpNetwork::setMaxSizeReceivedMessage ( const unsigned int & s )

inlineinherited

Change the maximum size that the emitter can receive (in request mode).

See also: vpNetwork::getMaxSizeReceivedMessage()

Parameters

s	: new maximum size value.

Definition at line 250 of file vpNetwork.h.

References max_size_message.

◆ setTimeoutSec()

void vpNetwork::setTimeoutSec ( const long & sec )

inlineinherited

Change the time the emitter spend to check if he receives a message from a receptor. Initially this value is set to 10usec.

See also: vpNetwork::setTimeoutUSec()

Parameters

sec	: new value in second.

Definition at line 260 of file vpNetwork.h.

References tv_sec.

◆ setTimeoutUSec()

void vpNetwork::setTimeoutUSec ( const long & usec )

inlineinherited

Change the time the emitter spend to check if he receives a message from a receptor. Initially this value is set to 10usec.

See also: vpNetwork::setTimeoutSec()

Parameters

usec	: new value in micro second.

Definition at line 270 of file vpNetwork.h.

References tv_usec.

◆ setVerbose()

void vpNetwork::setVerbose ( const bool & mode )

inlineinherited

Set the verbose mode.

Parameters

mode	: Change the verbose mode. True to turn on, False to turn off.

Definition at line 277 of file vpNetwork.h.

References verboseMode.

◆ start()

bool vpServer::start ( )

Enable the server to wait for clients (on the limit of the maximum limit).

Returns: True if the server has started, false otherwise.

Examples: testServer.cpp.

Definition at line 179 of file vpServer.cpp.

References vpNetwork::emitter, and vpERROR_TRACE.

Referenced by checkForConnections().

Member Data Documentation

◆ beginning

std::string vpNetwork::beginning

protectedinherited

Definition at line 160 of file vpNetwork.h.

Referenced by operator=(), sendRequestTo(), and vpNetwork().

◆ currentMessageReceived

std::string vpNetwork::currentMessageReceived

protectedinherited

Definition at line 164 of file vpNetwork.h.

Referenced by operator=(), and vpNetwork().

◆ emitter

vpEmitter vpNetwork::emitter

protectedinherited

Definition at line 146 of file vpNetwork.h.

Referenced by vpServer::checkForConnections(), operator=(), vpServer::start(), vpNetwork(), vpServer::vpServer(), vpServer::vpServer(), vpServer::vpServer(), and vpServer::~vpServer().

◆ end

std::string vpNetwork::end

protectedinherited

Definition at line 161 of file vpNetwork.h.

Referenced by operator=(), sendRequestTo(), and vpNetwork().

◆ max_size_message

unsigned int vpNetwork::max_size_message

protectedinherited

Definition at line 158 of file vpNetwork.h.

Referenced by getMaxSizeReceivedMessage(), operator=(), setMaxSizeReceivedMessage(), and vpNetwork().

◆ param_sep

std::string vpNetwork::param_sep

protectedinherited

Definition at line 162 of file vpNetwork.h.

Referenced by operator=(), sendRequestTo(), and vpNetwork().

◆ readFileDescriptor

fd_set vpNetwork::readFileDescriptor

protectedinherited

Definition at line 148 of file vpNetwork.h.

Referenced by vpServer::checkForConnections(), operator=(), receive(), receiveFrom(), and vpNetwork().

◆ receptor_list

std::vector<vpReceptor> vpNetwork::receptor_list

protectedinherited

Definition at line 147 of file vpNetwork.h.

Referenced by vpServer::checkForConnections(), vpClient::deconnect(), vpServer::getNumberOfClients(), vpClient::getNumberOfServers(), getReceptorIndex(), operator=(), print(), receive(), receiveFrom(), send(), sendRequestTo(), sendTo(), vpClient::stop(), vpNetwork(), and vpServer::~vpServer().

◆ request_list

std::vector<vpRequest *> vpNetwork::request_list

protectedinherited

Definition at line 156 of file vpNetwork.h.

Referenced by addDecodingRequest(), getRequestIdFromIndex(), operator=(), receiveAndDecodeRequest(), receiveAndDecodeRequestFrom(), receiveAndDecodeRequestOnce(), receiveAndDecodeRequestOnceFrom(), removeDecodingRequest(), and vpNetwork().

◆ separator

std::string vpNetwork::separator

protectedinherited

Definition at line 159 of file vpNetwork.h.

Referenced by operator=(), sendRequestTo(), and vpNetwork().

◆ socketMax

int vpNetwork::socketMax

protectedinherited

Definition at line 150 of file vpNetwork.h.

Referenced by vpServer::checkForConnections(), operator=(), receive(), receiveFrom(), and vpNetwork().

◆ tv

struct timeval vpNetwork::tv

protectedinherited

Definition at line 166 of file vpNetwork.h.

Referenced by vpServer::checkForConnections(), operator=(), receive(), receiveFrom(), and vpNetwork().

◆ tv_sec

long vpNetwork::tv_sec

protectedinherited

Definition at line 167 of file vpNetwork.h.

Referenced by vpServer::checkForConnections(), operator=(), receive(), receiveFrom(), setTimeoutSec(), and vpNetwork().

◆ tv_usec

long vpNetwork::tv_usec

protectedinherited

Definition at line 168 of file vpNetwork.h.

Referenced by vpServer::checkForConnections(), operator=(), receive(), receiveFrom(), setTimeoutUSec(), and vpNetwork().

◆ verboseMode

bool vpNetwork::verboseMode

protectedinherited

Definition at line 170 of file vpNetwork.h.

Referenced by operator=(), receive(), receiveFrom(), send(), sendRequestTo(), sendTo(), setVerbose(), and vpNetwork().

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ vpServer() [1/4]

◆ vpServer() [2/4]

◆ vpServer() [3/4]

◆ vpServer() [4/4]

◆ ~vpServer()

Member Function Documentation

◆ addDecodingRequest()

◆ checkForConnections()

◆ getMaxNumberOfClients()

◆ getMaxSizeReceivedMessage()

◆ getNumberOfClients()

◆ getReceptorIndex()

◆ getRequestIdFromIndex()

◆ isStarted()

◆ operator=()

◆ print() [1/2]

◆ print() [2/2]

◆ receive()

◆ receiveAndDecodeRequest()

◆ receiveAndDecodeRequestFrom()

◆ receiveAndDecodeRequestOnce()

◆ receiveAndDecodeRequestOnceFrom()

◆ receiveFrom()

◆ receiveRequest()

◆ receiveRequestFrom()

◆ receiveRequestOnce()

◆ receiveRequestOnceFrom()

◆ removeDecodingRequest()

◆ send() [1/2]

◆ send() [2/2]

◆ sendAndEncodeRequest()

◆ sendAndEncodeRequestTo()

◆ sendRequest()

◆ sendRequestTo()

◆ sendTo()

◆ setMaxNumberOfClients()

◆ setMaxSizeReceivedMessage()

◆ setTimeoutSec()

◆ setTimeoutUSec()

◆ setVerbose()

◆ start()

Member Data Documentation

◆ beginning

◆ currentMessageReceived

◆ emitter

◆ end

◆ max_size_message

◆ param_sep

◆ readFileDescriptor

◆ receptor_list

◆ request_list

◆ separator

◆ socketMax

◆ tv

◆ tv_sec

◆ tv_usec

◆ verboseMode