Main Page   Class Hierarchy   Compound List   File List   Compound Members  

SmartSockets::SocketEvent Class Reference

#include <tevent.h>

Inheritance diagram for SmartSockets::SocketEvent::

SmartSockets::TipcEvent List of all members.

Public Methods

sock getSocket () throw (TipcException)
T_IO_CHECK_MODE getCheckMode () throw (TipcException)

Friends

class T_IPCX_API TipcDispatcher
class T_IPCX_API TipcDispatcherTraverser

Detailed Description

Class that represents a socket event. Socket events are triggered whenever the given socket is ready to be written to or read from.

Caution:

When an event is created or destroyed from a thread other than the thread dispatching the events, a user event is added to the dispatcher to perform the actual creation or destruction. To ensure that event data, such as a socket or a connection, is not destroyed before the event is removed from the dispatcher, create a user event to destroy the event and to perform any necessary cleanup.

This class contains the SocketEventHandler object and method that is called by the TipcDispatcher when this event is triggered.

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


Member Function Documentation

T_IO_CHECK_MODE SmartSockets::SocketEvent::getCheckMode   throw (TipcException) [inline]
 

Gets the IO operation associated with the event.

Returns:
T_IO_CHECK_READ or T_IO_CHECK_WRITE.

sock SmartSockets::SocketEvent::getSocket   throw (TipcException) [inline]
 

Gets the socket associated with the event.

Returns:
socket file descriptor.


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