---

SmartSockets::UserEvent Class Reference

#include <tevent.h>

Inheritance diagram for SmartSockets::UserEvent::

List of all members.

Public Methods
const void *	getData () throw (TipcException)
Friends
class T_IPCX_API	TipcDispatcher
class T_IPCX_API	TipcDispatcherTraverser

---

Detailed Description

Class that represents a user event; user events are only useful for inter thread communication. Events of this type will be immediately queued in the Dispatcher. If the dispatcher is running in detatched mode, this allows one thread to communicate to the dispatcher's thread in a thread safe manner.

This class contains the UserEventHandler object and method that are triggered when a user event is dispatched.

Warning:

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

---

Member Function Documentation

const void* SmartSockets::UserEvent::getData (    )  throw (TipcException) [inline]

Allows users to get the user event data associated with this event. The data can be any arbitrary user specified data. Note that the memory returned by this method belongs to the UserEvent object, and therefore, should not be deleted.

---

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

• tevent.h

---