Poll::Provider Class Reference

Poll provider interface. More...

#include <PollInterface.h>

Inheritance diagram for Poll::Provider:

Public Member Functions
virtual	~Provider ()
	Virtual destructor.
virtual int	Register (User *user)=0
	Register an endpoint.
virtual void	Deregister (User *user)=0
	Deregister endpoint.
virtual void	Control (User *user)=0
	Set the events which are interesting for end point.
virtual void	Deliver (pollAction *msg)=0
	Interface to itself, via Event Manager.

Static Public Member Functions
static Provider *	GetPollService ()
	Implement as a singleton.
static int	ProviderFactory (const char *type, MSGstruct *msg)
	Factory method.for stream provider.

Detailed Description

Poll provider interface.

Interfaces to both Poll users and itself - via the event service. As it is likely that the implementation will need to be such that messages from Users will need to interrupt the actual poller, the interface is procedural, and any synchronization is done within the implementation.

Definition at line 130 of file PollInterface.h.

Constructor & Destructor Documentation

~Provider()

virtual Poll::Provider::~Provider ( )

inlinevirtual

Virtual destructor.

Definition at line 141 of file PollInterface.h.

{}

Member Function Documentation

GetPollService()

static Provider * Poll::Provider::GetPollService ( )

inlinestatic

Implement as a singleton.

Definition at line 136 of file PollInterface.h.

                                          {
            return instance;
        }

Referenced by Datagram::Provider::ProviderFactory(), and Stream::Provider::ProviderFactory().

Register()

virtual int Poll::Provider::Register ( User *  user )

pure virtual

Register an endpoint.

Returns

zero on success, -1 if already registered or other system errno value

Implemented in Poll::Poll_select.

Deregister()

virtual void Poll::Provider::Deregister ( User *  user )

pure virtual

Deregister endpoint.

Implemented in Poll::Poll_select.

Referenced by Datagram::DgramPoll::tidy(), and Stream::SocketPoll::tidy().

Control()

virtual void Poll::Provider::Control ( User *  user )

pure virtual

Set the events which are interesting for end point.

Implemented in Poll::Poll_select.

Deliver()

virtual void Poll::Provider::Deliver ( pollAction *  msg )

pure virtual

Interface to itself, via Event Manager.

Implemented in Poll::Poll_select.

ProviderFactory()

int Poll::Provider::ProviderFactory ( const char *  type, MSGstruct *  msg  )

static

Factory method.for stream provider.

Parameters

type	Name of type of provider, or NULL give default
msg	Structure which receives any failure message

Returns

Zero on success, or error code

Definition at line 112 of file EventSvc.C.

    {
        MutexLock mlock (&poller_mutex);
 
        if ( instance != 0 ) {
            MSG_IOevent_PollProviderCreated_LOG ();
            return 0;
        }
 
        if ( type == 0 || strcmp (type, "epoll") == 0 ) {
            instance = CreatePollepollProvider ();
            if ( instance != 0 )
                return 0;
        }
 
        if ( type == 0 || strcmp (type, "port") == 0 ) {
            instance = CreatePollportProvider ();
            if ( instance != 0 )
                return 0;
        }
 
        if ( type == 0 || strcmp (type, "poll") == 0 ) {
            instance = CreatePollpollProvider ();
            if ( instance != 0 )
                return 0;
        }
 
        if ( type == 0 || strcmp (type, "select") == 0 ) {
            instance = CreatePollselectProvider ();
            if ( instance != 0 )
                return 0;
        }
 
        MSG_IOevent_PollProvidertype_SET (msp, type);
        return MSG_IOevent_PollProvidertype;
    }

Referenced by Datagram::Provider::ProviderFactory(), and Stream::Provider::ProviderFactory().

---

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

• PollInterface.h
• EventSvc.C