SigCX::Tunnel Class Reference
[SigC++ Extras]

A tunnel. More...

#include <tunnel.h>

Inheritance diagram for SigCX::Tunnel:

SigCX::ThreadTunnel List of all members.

Public Member Functions

virtual ~Tunnel ()
virtual void send (Callback *cb, bool sync=false)=0
virtual bool in_sync_callback ()=0
virtual void drain ()=0

Classes

class  Callback
 Tunnel callback. More...

Detailed Description

A tunnel.

A tunnel is a device that accepts callbacks to be executed, either synchronous or asynchronous.


Constructor & Destructor Documentation

virtual SigCX::Tunnel::~Tunnel  )  [inline, virtual]
 

Destructor.


Member Function Documentation

virtual void SigCX::Tunnel::drain  )  [pure virtual]
 

Drain the tunnel.

Any callbacks in the tunnel are cancelled. This is intended to be called at the destination end of the tunnel.

Implemented in SigCX::ThreadTunnel.

virtual bool SigCX::Tunnel::in_sync_callback  )  [pure virtual]
 

Check if tunnel is executing a synchronous callback.

Returns:
true if a synchronous callback is in execution.

Implemented in SigCX::ThreadTunnel.

virtual void SigCX::Tunnel::send Callback cb,
bool  sync = false
[pure virtual]
 

Send a callback to the other side.

Parameters:
cb Callback to be executed on the other side of the tunnel.
sync If true, this thread is suspended until the callback has finished execution.


The documentation for this class was generated from the following file:
Generated on Mon Jul 3 10:40:09 2006 for SigCX - SigC++ Extras by  doxygen 1.4.6