NAME
SocketService - The SocketService is a thread pool object that is meant to service attached socket ports. Thread pool service object for socket ports.
SYNOPSIS
#include <socket.h>
Inherits Thread, and Mutex.
Public Methods
void update (unsigned char flag=0xff)
Notify service thread that a port has been added or removed, or a timer changed, so that a new schedule can be computed for expiring attached ports. SocketService (int pri=0)
Create a service thread for attaching socket ports. virtual ~SocketService ()
Terminate the thread pool and eliminate any attached socket ports. int getCount (void) const
Get current reference count.
Protected Methods
virtual void onUpdate (unsigned char buf)
Handles all requests other than 'termination'. virtual void onEvent (void)
Called once each time the service thread is rescheduled. virtual void onCallback (SocketPort *port)
Called for each port that is being processed in response to an event.
Friends
class SocketPort
DETAILED DESCRIPTION
The SocketService is a thread pool object that is meant to service attached socket ports. Thread pool service object for socket ports.
Multiple pool objects may be created and multiple socket ports may be attached to the same thread of execution. This allows one to balance threads and sockets they service rather than either using a single thread for all connections or a seperate thread for each connection. Features can be added through supported virtual methods.
Author: David Sugar <[email protected]>
CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
SocketService::SocketService (int pri = 0)
Create a service thread for attaching socket ports.
The thread begins execution with the first attached socket.
Parameters:
- pri
-
of this thread to run under.
virtual SocketService::~SocketService () [virtual]
Terminate the thread pool and eliminate any attached socket ports.
MEMBER FUNCTION DOCUMENTATION
int SocketService::getCount (void) const [inline]
Get current reference count.
This can be used when selecting the least used service handler from a pool.
Returns: count of active ports.
virtual void SocketService::onCallback (SocketPort * port) [inline, protected, virtual]
Called for each port that is being processed in response to an event.
This can be used to add additional notification options during callback in combination with update().
Parameters:
- port
-
SocketPort who's callback events are being evaluated.
virtual void SocketService::onEvent (void) [inline, protected, virtual]
Called once each time the service thread is rescheduled.
This is called after the mutex is locked and can be used to slip in additional processing.
virtual void SocketService::onUpdate (unsigned char buf) [inline, protected, virtual]
Handles all requests other than 'termination'.
Parameters:
- buf
-
request id as posted from update().
void SocketService::update (unsigned char flag = 0xff)
Notify service thread that a port has been added or removed, or a timer changed, so that a new schedule can be computed for expiring attached ports.
A '0' is used to terminate the service thread, and additional values can be specified which will be 'caught' in the onUpdate() handler.
Parameters:
- flag
-
update flag value.
FRIENDS AND RELATED FUNCTION DOCUMENTATION
friend class SocketPort [friend]
AUTHOR
Generated automatically by Doxygen for CommonC++ from the source code.