S3FC project page S3FC home page
Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

s3_txport_base Class Template Reference

Abstract base class for a generic transport mechanism. More...

#include <s3_txport_base.h>

Inheritance diagram for s3_txport_base:

Inheritance graph
[legend]
Collaboration diagram for s3_txport_base:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual ~s3_txport_base ()
 Support destructors in the derived classes. More...

virtual s3_fifo_queue< s3_txport_data<
T_Data > > & 		get_tx_queue ()=0
 Return a reference to a s3_fifo_queue specialised on the s3_txport_data for the transmit data queue. More...

virtual s3_fifo_queue< s3_txport_data<
T_Data > > & 		get_rx_queue ()=0
 Return a reference to a s3_fifo_queue specialised on the s3_txport_data for the received data queue. More...

virtual std::list< s3_txport_client_id > get_client_id_list () const=0
 Returns a list of all currently connected clients. More...

virtual void send_metadata (s3_txport_client_id id, const std::string &metadata)=0
 Transmit metadata to the remote connection. More...

virtual bool is_connected_by_id (s3_txport_client_id id)=0
 Returns true if the client is still considered to be active. More...

virtual bool disconnect_by_id (s3_txport_client_id id)=0
 Disconnect the indicated remote connection. More...

virtual void disconnect_all ()=0
 Disconnect all clients, regardless, but keep the listener etc. alive. More...

virtual bool listening () const=0
 Returns true if the server is listening for connections. More...

Detailed Description

template<class T_Data>
class s3_txport_base< T_Data >

Abstract base class for a generic transport mechanism.

This is a very thin base from which the various transport mechanisms are derived from.

Definition at line 172 of file s3_txport_base.h.

Constructor & Destructor Documentation

template<class T_Data>
virtual s3_txport_base< T_Data >::~s3_txport_base (    )  [inline, virtual]
 

Support destructors in the derived classes.

Definition at line 178 of file s3_txport_base.h.

Member Function Documentation

template<class T_Data>
virtual void s3_txport_base< T_Data >::disconnect_all (    )  [pure virtual]
 

Disconnect all clients, regardless, but keep the listener etc. alive.

Implemented in s3_txport_local.

template<class T_Data>
virtual bool s3_txport_base< T_Data >::disconnect_by_id (  s3_txport_client_id    id )  [pure virtual]
 

Disconnect the indicated remote connection.

Parameters:
The  ID of the remote to be disconnected.

Implemented in s3_txport_local.

template<class T_Data>
virtual std::list<s3_txport_client_id> s3_txport_base< T_Data >::get_client_id_list (    )  const [pure virtual]
 

Returns a list of all currently connected clients.

Note that this list reflects the situation at the time of the call, and there is no guarantee that all the clients in the list are connected.

Implemented in s3_txport_local.

template<class T_Data>
virtual s3_fifo_queue<s3_txport_data<T_Data> >& s3_txport_base< T_Data >::get_rx_queue (    )  [pure virtual]
 

Return a reference to a s3_fifo_queue specialised on the s3_txport_data for the received data queue.

Implemented in s3_txport_local.

template<class T_Data>
virtual s3_fifo_queue<s3_txport_data<T_Data> >& s3_txport_base< T_Data >::get_tx_queue (    )  [pure virtual]
 

Return a reference to a s3_fifo_queue specialised on the s3_txport_data for the transmit data queue.

Implemented in s3_txport_local.

template<class T_Data>
virtual bool s3_txport_base< T_Data >::is_connected_by_id (  s3_txport_client_id    id )  [pure virtual]
 

Returns true if the client is still considered to be active.

Implemented in s3_txport_local.

template<class T_Data>
virtual bool s3_txport_base< T_Data >::listening (    )  const [pure virtual]
 

Returns true if the server is listening for connections.

Implemented in s3_txport_local.

template<class T_Data>
virtual void s3_txport_base< T_Data >::send_metadata (  s3_txport_client_id    id,
const std::string &    metadata
)  [pure virtual]
 

Transmit metadata to the remote connection.

The metadata will be dispatched to any s3_event_handler types attached to the s3_txport_base.

Parameters:
id  The ID of the remote client to whom the metadata must be sent
metadata  A string of metadata payload.

Implemented in s3_txport_local.

The documentation for this class was generated from the following file:
Send comments to: s3fc@stonethree.com SourceForge Logo