---

SmartSockets::TipcEvent Class Reference

#include <tevent.h>

Inheritance diagram for SmartSockets::TipcEvent::

List of all members.

Public Methods
void	destroy () throw (TipcException)
TipcDispatcher	getDispatcher () throw (TipcException)
	operator T_IPC_EVENT () const throw ()
T_IPC_EVENT_TYPE	getType () const throw (TipcException)
Protected Methods
	TipcEvent ()
virtual	~TipcEvent () throw ()
void	setEvent (T_IPC_EVENT event)
Protected Attributes
T_IPC_EVENT	_event
Friends
class T_IPCX_API	TipcDispatcher
class T_IPCX_API	TipcDispatcherTraverser

---

Detailed Description

Base class to all events handled by the Dispatcher. This class allows users to either destroy an event (e.g. stop triggering the event handlers), or to get the type of an event, or even to get the Dipatcher that created the object. The first use (destroying events is particularly useful to remove events from within event handlers. Note that only the TipcDispatcher and TipcDispatcher traverser are allowed to instantiate or delete objects of this class.

The TipcEvent class and its children are used to contain the handler objects and pointers called when an event is triggered.

Warning:

Do not delete this object using the delete operator; call either the TipcEvent::destroy() method, or the TipcDispatcher::destroyEvent() method.

---

Constructor & Destructor Documentation

SmartSockets::TipcEvent::TipcEvent (    )  [inline, protected]

Protected Constructor; use the Dispatcher to create TipcEvent child classes.

virtual SmartSockets::TipcEvent::~TipcEvent (    )  throw () [inline, protected, virtual]

Destructor; use the Dispatcher::destroyEvent() to delete this class.

---

Member Function Documentation

void SmartSockets::TipcEvent::destroy (    )  throw (TipcException) [inline]

Unregisters the events with the TipcDispatcher objects.

TipcDispatcher SmartSockets::TipcEvent::getDispatcher (    )  throw (TipcException)

Gets the Dispatcher that created this event.

T_IPC_EVENT_TYPE SmartSockets::TipcEvent::getType (    )  const throw (TipcException)

Gets the type of the event. Returns: one of the following: T_IPC_EVENT_USER - this pointer is a UserEvent. T_IPC_EVENT_TIMER - this pointer is a TimerEvent. T_IPC_EVENT_SOCKET - this pointer is a SocketEvent. T_IPC_EVENT_CONN - this pointer is a ConnEvent. T_IPC_EVENT_MSG - this pointer is a MessageEvent created with TipcDispatcher::createMsgSubjEvent(). T_IPC_EVENT_MSG_TYPE - this pointer is a MessageEvent created with TipcDispatcher::createMsgTypeEvent().

SmartSockets::TipcEvent::operator T_IPC_EVENT (    )  const throw () [inline]

Gets the underlying C structure for compatibility with the C API.

void SmartSockets::TipcEvent::setEvent (  T_IPC_EVENT    event )  [inline, protected]

Allows child classes to set the underlying C event structure.

---

Member Data Documentation

T_IPC_EVENT SmartSockets::TipcEvent::_event [protected]

The actual C style handle we are wrapping.

---

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

• tevent.h

---