logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

ost::SocketService - The SocketService is a thread pool object that is meant to service attached socket

Author

       Generated automatically by Doxygen for GNU CommonC++ from the source code.

GNU CommonC++                                    Sun Dec 27 2020                           ost::SocketService(3)

Constructor & Destructor Documentation

ost::SocketService::SocketService(intpri=0,size_tstack=0,constchar*id=NULL)
       Create a service thread for attaching socket ports. The thread begins execution with the first attached
       socket.

       Parameterspri of this thread to run under.
           stack stack size.
           id thread ID.

   virtualost::SocketService::~SocketService()[virtual]
       Terminate the thread pool and eliminate any attached socket ports.

Detailed Description

       The SocketService is a thread pool object that is meant to service attached 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 separate thread for each connection. Features can be added through
       supported virtual methods.

       Author
           David Sugar dyfet@ostel.comThread pool service object for socket ports.

       Examplestcpservice.cpp.

Member Function Documentation

intost::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.

   virtualvoidost::SocketService::onCallback(SocketPort*port)[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().

       ParametersportSocketPort who's callback events are being evaluated.

   virtualvoidost::SocketService::onEvent(void)[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.

   virtualvoidost::SocketService::onUpdate(unsignedcharbuf)[protected],[virtual]
       Handles all requests other than 'termination'.

       Parametersbuf request id as posted from update().

   voidost::SocketService::update(unsignedcharflag=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.

       Parametersflag update flag value.

Name

       ost::SocketService - The SocketService is a thread pool object that is meant to service attached socket
       ports.

Synopsis

       #include <socketport.h>

       Inherits ost::Thread, and ost::Mutex.

   PublicMemberFunctions
       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, size_t stack=0, const char *id=NULL)
           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.

   ProtectedMemberFunctions
       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 SocketPortAdditionalInheritedMembers

See Also