Main Page   Class Hierarchy   Compound List   File List   Compound Members  

SmartSockets::CallBack Class Template Reference

#include <tcallbck.h>

List of all members.

Public Methods

void destroy () throw (CallBackException)
bool is_created () throw ()
 operator T_CB () throw ()
void * getArgument () const throw ()
void setArgument (void *data) throw ()
T_CB_PRIORITY getPriority () const throw (CallBackException)
void setPriority (T_CB_PRIORITY priority) throw (CallBackException)
virtual bool print (T_OUT_FUNC func=(T_OUT_FUNC) TutOut) throw (CallBackException)

Protected Methods

void setTCB (T_CB handle)

Protected Attributes

T_CB m_cb
Implementor * m_implementor
Implementor::Handler m_handler
void * m_argument

Friends

class T_IPCX_API TipcSrv
class T_IPCX_API TipcConn
class T_IPCX_API Option


Detailed Description

template<class Implementor>
class SmartSockets::CallBack< Implementor >

The CallBack class provides a template for callback objects.

The T_CB struct underlies the callback object and the creation, destruction, setting and getting of priority and print operations are performed on this struct.


Member Function Documentation

template<class Implementor>
void SmartSockets::CallBack< Implementor >::destroy   throw (CallBackException) [inline]
 

Destroys the callback

Exceptions:
CallBackException  if the desctruction of the callback fails

template<class Implementor>
void* SmartSockets::CallBack< Implementor >::getArgument   const throw () [inline]
 

Returns this callback object's argument data.

Returns:
this callback object's argument data.

template<class Implementor>
T_CB_PRIORITY SmartSockets::CallBack< Implementor >::getPriority   const throw (CallBackException) [inline]
 

Returns the priority of this callback.

Returns:
the priority of this callback.

template<class Implementor>
bool SmartSockets::CallBack< Implementor >::is_created   throw () [inline]
 

Returns whether this callback object has been successfully created

Returns:
whether this callback object has been successfully created

template<class Implementor>
SmartSockets::CallBack< Implementor >::operator T_CB   throw () [inline]
 

Returns the underlying callback structure of this object.

Returns:
the underlying callback structure of this object.

template<class Implementor>
virtual bool SmartSockets::CallBack< Implementor >::print T_OUT_FUNC    func = (T_OUT_FUNC)TutOut throw (CallBackException) [inline, virtual]
 

Calls the callback print method.

Returns:
TRUE

template<class Implementor>
void SmartSockets::CallBack< Implementor >::setArgument void *    data throw () [inline]
 

Sets this callback object's argument data.

Parameters:
data  this callback object's argument data.

template<class Implementor>
void SmartSockets::CallBack< Implementor >::setPriority T_CB_PRIORITY    priority throw (CallBackException) [inline]
 

Sets the priority of this callback.

Parameters:
priority  the priority of this callback.

template<class Implementor>
void SmartSockets::CallBack< Implementor >::setTCB T_CB    handle [inline, protected]
 

Sets the underlying callback structure of this object.

Parameters:
handle  the underlying calllback structure of this object.


The documentation for this class was generated from the following file:
Generated on Fri Jul 14 15:05:55 2006 by doxygen1.2.12 written by Dimitri van Heesch, © 1997-2001