Visual Servoing Platform
version 3.6.1 under development (2024-10-15)
|
#include <visp3/core/vpNetwork.h>
Public Member Functions | |
vpNetwork () | |
virtual | ~vpNetwork () |
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 | 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) |
template<typename T > | |
int | send (T *object, const unsigned int &sizeOfObject) |
Protected Attributes | |
vpEmitter | emitter |
std::vector< vpReceptor > | receptor_list |
fd_set | readFileDescriptor |
SOCKET | 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 |
This class represents a Transmission Control Protocol (TCP) network.
TCP provides reliable, ordered delivery of a stream of bytes from a program on one computer to another program on another computer.
Definition at line 95 of file vpNetwork.h.
BEGIN_VISP_NAMESPACE vpNetwork::vpNetwork | ( | ) |
Definition at line 50 of file vpNetwork.cpp.
|
virtual |
Definition at line 71 of file vpNetwork.cpp.
void vpNetwork::addDecodingRequest | ( | vpRequest * | req | ) |
Add a decoding request to the emitter. This request will be used to decode the received messages. Each request must have a different id.
req | : Request to add. |
Definition at line 89 of file vpNetwork.cpp.
References vpRequest::getId(), and request_list.
|
inline |
Get the maximum size that the emitter can receive (in request mode).
Definition at line 200 of file vpNetwork.h.
int vpNetwork::getReceptorIndex | ( | const char * | name | ) |
Get the receptor index from its name. The name can be either the IP, or its name on the network.
name | : Name of the receptor. |
Definition at line 144 of file vpNetwork.cpp.
References receptor_list.
|
inline |
Get the Id of the request at the index ind.
ind | : Index of the request. |
Definition at line 186 of file vpNetwork.h.
void vpNetwork::print | ( | const char * | id = "" | ) |
Print the receptors.
id | : Message to display before the receptor's index. |
Definition at line 129 of file vpNetwork.cpp.
References receptor_list.
Referenced by vpClient::print(), and vpServer::print().
int vpNetwork::receive | ( | T * | object, |
const unsigned int & | sizeOfObject = sizeof(T) |
||
) |
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.
object | : Received object. |
sizeOfObject | : Size of the received object. |
Definition at line 290 of file vpNetwork.h.
References readFileDescriptor, receptor_list, socketMax, tv, tv_sec, tv_usec, and verboseMode.
std::vector< int > vpNetwork::receiveAndDecodeRequest | ( | ) |
Receives and decode requests until there is requests to receive.
Definition at line 381 of file vpNetwork.cpp.
References receiveRequest(), and request_list.
std::vector< int > vpNetwork::receiveAndDecodeRequestFrom | ( | const unsigned int & | receptorEmitting | ) |
Receives and decode requests, from a specific emitter, until there is request to receive.
receptorEmitting | : Index of the receptor emitting the message |
Definition at line 408 of file vpNetwork.cpp.
References receiveRequestFrom(), and request_list.
int vpNetwork::receiveAndDecodeRequestOnce | ( | ) |
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.
Definition at line 438 of file vpNetwork.cpp.
References receiveRequestOnce(), and request_list.
int vpNetwork::receiveAndDecodeRequestOnceFrom | ( | const unsigned int & | receptorEmitting | ) |
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.
receptorEmitting | : Index of the receptor emitting the message. |
Definition at line 468 of file vpNetwork.cpp.
References receiveRequestOnceFrom(), and request_list.
int vpNetwork::receiveFrom | ( | T * | object, |
const unsigned int & | receptorEmitting, | ||
const unsigned int & | sizeOfObject = sizeof(T) |
||
) |
Receives a object from a receptor, by specifying its size or not. Note that a received message can correspond to a deconnection signal.
object | : Received object. |
receptorEmitting | : Index of the receptor emitting the message. |
sizeOfObject | : Size of the received object. |
Definition at line 374 of file vpNetwork.h.
References readFileDescriptor, receptor_list, socketMax, tv, tv_sec, tv_usec, and verboseMode.
std::vector< int > vpNetwork::receiveRequest | ( | ) |
Receive requests until there is requests to receive.
Definition at line 287 of file vpNetwork.cpp.
Referenced by receiveAndDecodeRequest().
std::vector< int > vpNetwork::receiveRequestFrom | ( | const unsigned int & | receptorEmitting | ) |
Receives requests, from a specific emitter, until there is request to receive.
receptorEmitting | : Index of the receptor emitting the message |
Definition at line 310 of file vpNetwork.cpp.
Referenced by receiveAndDecodeRequestFrom().
int vpNetwork::receiveRequestOnce | ( | ) |
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.
Definition at line 334 of file vpNetwork.cpp.
Referenced by receiveAndDecodeRequestOnce().
int vpNetwork::receiveRequestOnceFrom | ( | const unsigned int & | receptorEmitting | ) |
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.
receptorEmitting | : Index of the receptor emitting the message. |
Definition at line 361 of file vpNetwork.cpp.
Referenced by receiveAndDecodeRequestOnceFrom().
void vpNetwork::removeDecodingRequest | ( | const char * | id | ) |
Delete a decoding request from the emitter.
id | : Id of the request to delete. |
Definition at line 114 of file vpNetwork.cpp.
References request_list.
int vpNetwork::send | ( | T * | object, |
const int unsigned & | sizeOfObject = sizeof(T) |
||
) |
int vpNetwork::send | ( | T * | object, |
const unsigned int & | sizeOfObject | ||
) |
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.
object | : Received object. |
sizeOfObject | : Size of the object |
Definition at line 448 of file vpNetwork.h.
References receptor_list, and verboseMode.
int vpNetwork::sendAndEncodeRequest | ( | vpRequest & | req | ) |
Send and encode a request to the first receptor in the list.
req | : Request to send. |
Definition at line 247 of file vpNetwork.cpp.
References vpRequest::encode(), and sendRequest().
int vpNetwork::sendAndEncodeRequestTo | ( | vpRequest & | req, |
const unsigned int & | dest | ||
) |
Send and encode a request to a specific receptor.
req | : Request to send. |
dest | : Index of the receptor receiving the request. |
Definition at line 267 of file vpNetwork.cpp.
References vpRequest::encode(), and sendRequestTo().
int vpNetwork::sendRequest | ( | vpRequest & | req | ) |
Send a request to the first receptor in the list.
req | : Request to send. |
Definition at line 179 of file vpNetwork.cpp.
References sendRequestTo().
Referenced by sendAndEncodeRequest().
int vpNetwork::sendRequestTo | ( | vpRequest & | req, |
const unsigned int & | dest | ||
) |
Send a request to a specific receptor.
req | : Request to send. |
dest | : Index of the receptor receiving the request. |
Definition at line 195 of file vpNetwork.cpp.
References beginning, end, vpRequest::getId(), param_sep, receptor_list, separator, vpRequest::size(), and verboseMode.
Referenced by sendAndEncodeRequestTo(), and sendRequest().
int vpNetwork::sendTo | ( | T * | object, |
const unsigned int & | dest, | ||
const unsigned int & | sizeOfObject = sizeof(T) |
||
) |
Send an object. The size has to be specified.
object | : Object to send. |
dest | : Index of the receptor that you are sending the object. |
sizeOfObject | : Size of the object. |
Definition at line 492 of file vpNetwork.h.
References receptor_list, and verboseMode.
|
inline |
Change the maximum size that the emitter can receive (in request mode).
s | : new maximum size value. |
Definition at line 236 of file vpNetwork.h.
|
inline |
Change the time the emitter spend to check if he receives a message from a receptor. Initially this value is set to 10usec.
sec | : new value in second. |
Definition at line 246 of file vpNetwork.h.
|
inline |
Change the time the emitter spend to check if he receives a message from a receptor. Initially this value is set to 10usec.
usec | : new value in micro second. |
Definition at line 256 of file vpNetwork.h.
|
inline |
Set the verbose mode.
mode | : Change the verbose mode. True to turn on, False to turn off. |
Definition at line 263 of file vpNetwork.h.
|
protected |
Definition at line 150 of file vpNetwork.h.
Referenced by sendRequestTo().
|
protected |
Definition at line 154 of file vpNetwork.h.
|
protected |
Definition at line 136 of file vpNetwork.h.
Referenced by vpServer::checkForConnections(), vpServer::start(), vpServer::vpServer(), and vpServer::~vpServer().
|
protected |
Definition at line 151 of file vpNetwork.h.
Referenced by sendRequestTo().
|
protected |
Definition at line 148 of file vpNetwork.h.
|
protected |
Definition at line 152 of file vpNetwork.h.
Referenced by sendRequestTo().
|
protected |
Definition at line 138 of file vpNetwork.h.
Referenced by vpServer::checkForConnections(), receive(), and receiveFrom().
|
protected |
Definition at line 137 of file vpNetwork.h.
Referenced by vpServer::checkForConnections(), vpClient::deconnect(), getReceptorIndex(), print(), receive(), receiveFrom(), send(), sendRequestTo(), sendTo(), vpClient::stop(), and vpServer::~vpServer().
|
protected |
Definition at line 146 of file vpNetwork.h.
Referenced by addDecodingRequest(), receiveAndDecodeRequest(), receiveAndDecodeRequestFrom(), receiveAndDecodeRequestOnce(), receiveAndDecodeRequestOnceFrom(), and removeDecodingRequest().
|
protected |
Definition at line 149 of file vpNetwork.h.
Referenced by sendRequestTo().
|
protected |
Definition at line 142 of file vpNetwork.h.
Referenced by vpServer::checkForConnections(), receive(), and receiveFrom().
|
protected |
Definition at line 154 of file vpNetwork.h.
Referenced by vpServer::checkForConnections(), receive(), receiveFrom(), and vpNetwork().
|
protected |
Definition at line 157 of file vpNetwork.h.
Referenced by vpServer::checkForConnections(), receive(), receiveFrom(), and vpNetwork().
|
protected |
Definition at line 158 of file vpNetwork.h.
Referenced by vpServer::checkForConnections(), receive(), receiveFrom(), and vpNetwork().
|
protected |
Definition at line 160 of file vpNetwork.h.
Referenced by receive(), receiveFrom(), send(), sendRequestTo(), and sendTo().