FuseNetworkTransceiver Class Reference
[FireVision FUSE Network Protocol, FireVision Image Processing Framework and Applications]

FUSE Network Transceiver. More...

#include <fvutils/net/fuse_transceiver.h>

List of all members.


Static Public Member Functions

static void send (fawkes::StreamSocket *s, FuseNetworkMessageQueue *msgq)
 Send messages.
static void recv (fawkes::StreamSocket *s, FuseNetworkMessageQueue *msgq, unsigned int max_num_msgs=8)
 Receive data.

Detailed Description

FUSE Network Transceiver.

Utility class that provides methods to send and receive messages via the network. Operates on message queues and a given socket.

Author:
Tim Niemueller

Definition at line 34 of file fuse_transceiver.h.

Member Function Documentation

void FuseNetworkTransceiver::recv ( fawkes::StreamSocket *  s,
FuseNetworkMessageQueue *  msgq,
unsigned int  max_num_msgs = 8 
) [static]

Receive data.

This method receives all messages currently available from the network, or a limited number depending on max_num_msgs. If max_num_msgs is 0 then all messages are read. Note that on a busy connection this may cause recv() to never return! The default is to return after 8 messages. The messages are stored in the supplied message queue.

Parameters:
s socket to gather messages from
msgq message queue to store received messages in
max_num_msgs maximum number of messages to read from stream in one go.
Exceptions:
ConnectionDiedException Thrown if any error occurs during the operation since for any error the conncetion is considered dead.

Definition at line 87 of file fuse_transceiver.cpp.

References fawkes::Socket::available(), FUSE_message_t::header, fawkes::LockQueue< Type >::lock(), FUSE_message_t::payload, FUSE_header_t::payload_size, fawkes::Socket::read(), and fawkes::LockQueue< Type >::unlock().

void FuseNetworkTransceiver::send ( fawkes::StreamSocket *  s,
FuseNetworkMessageQueue *  msgq 
) [static]

Send messages.

Parameters:
s socket over which the data shall be transmitted.
msgq message queue that contains the messages that have to be sent
Exceptions:
ConnectionDiedException Thrown if any error occurs during the operation since for any error the conncetion is considered dead.

Definition at line 52 of file fuse_transceiver.cpp.

References FuseNetworkMessage::fmsg(), FUSE_message_t::header, fawkes::LockQueue< Type >::lock(), FuseNetworkMessage::pack(), FUSE_message_t::payload, FuseNetworkMessage::payload_size(), fawkes::LockQueue< Type >::unlock(), fawkes::RefCount::unref(), and fawkes::Socket::write().

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