ASSA::EventHandler Class Reference

EventHandler class. More...

#include <EventHandler.h>

Inheritance diagram for ASSA::EventHandler:

Public Member Functions
	EventHandler ()
	Constructor. More...
virtual	~EventHandler ()
	Virtual destructor. More...
virtual int	handle_read (int fd)
	Read event callback. More...
virtual int	handle_write (int fd)
	Write handler callback. More...
virtual int	handle_except (int fd)
	Exception handler callback. More...
virtual int	handle_timeout (TimerId tid)
	Timeout handler callback. More...
virtual int	handle_signal (int signum_)
	Signal handler callback. More...
virtual int	handle_close (int fd)
	EOF on peer socket handler callback. More...
virtual void	resetState (void)
	A hook for derived class to reset internal state as needed. More...
void	set_id (const std::string &id_)
	Set EventHandler ID. More...
std::string	get_id () const
	Retrieve EventHandler ID. More...

Protected Attributes
std::string	m_id

Detailed Description

EventHandler class.

EventHandler is a pure virtual class. It is an interface class to the Event Handlers. These events are processed by Reactor. The supported events are signals, timers, and I/O pipes such as file descriptors, sockets and such.

See also

EventType

Definition at line 102 of file EventHandler.h.

Constructor & Destructor Documentation

ASSA::EventHandler::EventHandler ( )

inline

Constructor.

Definition at line 165 of file EventHandler.h.

References ASSA::REACTTRACE, and trace_with_mask.

               : m_id ("EventHandler")
{
    trace_with_mask("EventHandler::EventHandler",REACTTRACE);
}

virtual ASSA::EventHandler::~EventHandler ( )

inlinevirtual

Virtual destructor.

Definition at line 109 of file EventHandler.h.

{ /* no-op */ }

Member Function Documentation

std::string ASSA::EventHandler::get_id ( ) const

inline

Retrieve EventHandler ID.

Definition at line 157 of file EventHandler.h.

References m_id.

Referenced by ASSA::Reactor::dispatchHandler(), ASSA::Timer::dump(), ASSA::Reactor::registerIOHandler(), ASSA::Reactor::removeHandler(), and ASSA::Reactor::removeIOHandler().

{ return m_id; }

int ASSA::EventHandler::handle_close ( int  fd )

inlinevirtual

EOF on peer socket handler callback.

There is no corresponding EventType. One is not needed because detecting EOF is a part of handle_read () data processing.

Returns

0 on success, -1 on error

Reimplemented in ASSA::Acceptor< SERVICE_HANDLER, PEER_ACCEPTOR >, and ASSA::RemoteLogger.

Definition at line 212 of file EventHandler.h.

References ASSA::REACTTRACE, and trace_with_mask.

Referenced by ASSA::Reactor::removeHandler(), and ASSA::Reactor::removeIOHandler().

{
    trace_with_mask("EventHandler::handle_close",REACTTRACE);
    return -1;
}

int ASSA::EventHandler::handle_except ( int  fd )

inlinevirtual

Exception handler callback.

Returns

0 on success, -1 on error

Definition at line 188 of file EventHandler.h.

References ASSA::REACTTRACE, and trace_with_mask.

Referenced by ASSA::Reactor::dispatch().

{
    trace_with_mask("EventHandler::handle_except",REACTTRACE);
    return -1;
}

int ASSA::EventHandler::handle_read ( int  fd )

inlinevirtual

Read event callback.

If reader detects EOF, it must return error to the Reactor. (See Reactor for details).

Returns

0 on success, -1 on error

Reimplemented in ASSA::Acceptor< SERVICE_HANDLER, PEER_ACCEPTOR >.

Definition at line 172 of file EventHandler.h.

References ASSA::REACTTRACE, and trace_with_mask.

Referenced by ASSA::Reactor::dispatch().

{
    trace_with_mask("EventHandler::handle_read",REACTTRACE);
    return -1;
}

int ASSA::EventHandler::handle_signal ( int  signum_ )

inlinevirtual

Signal handler callback.

Returns

0 on success, -1 on error

Reimplemented in ASSA::SIGPOLLHandler, ASSA::SIGALRMHandler, ASSA::SIGCHLDHandler, ASSA::SIGUSR2Handler, ASSA::GenServer, ASSA::SIGUSR1Handler, ASSA::ChildStatusHandler, ASSA::SIGINTHandler, and ASSA::CFUNC_Handler.

Definition at line 204 of file EventHandler.h.

References ASSA::REACTTRACE, and trace_with_mask.

Referenced by ASSA::SigHandler::dispatch(), and ASSA::SigHandlers::dispatch().

{
    trace_with_mask("EventHandler::handle_signal",REACTTRACE);
    return -1;
}

int ASSA::EventHandler::handle_timeout ( TimerId  tid )

inlinevirtual

Timeout handler callback.

Returns

1 to reschedule the timer, 0 otherwise

Reimplemented in ASSA::Connector< SERVICE_HANDLER, PEER_CONNECTOR >.

Definition at line 196 of file EventHandler.h.

References ASSA::REACTTRACE, and trace_with_mask.

Referenced by ASSA::TimerQueue::expire().

{
    trace_with_mask("EventHandler::handle_timeout",REACTTRACE);
    return -1;
}

int ASSA::EventHandler::handle_write ( int  fd )

inlinevirtual

Write handler callback.

Returns

0 on success, -1 on error

Reimplemented in ASSA::Connector< SERVICE_HANDLER, PEER_CONNECTOR >.

Definition at line 180 of file EventHandler.h.

References ASSA::REACTTRACE, and trace_with_mask.

Referenced by ASSA::Reactor::dispatch().

{
    trace_with_mask("EventHandler::handle_write",REACTTRACE);
    return -1;
}

void ASSA::EventHandler::resetState ( void  )

inlinevirtual

A hook for derived class to reset internal state as needed.

Reimplemented in ASSA::SIGALRMHandler, ASSA::SIGCHLDHandler, ASSA::SIGUSR2Handler, ASSA::SIGUSR1Handler, and ASSA::SIGINTHandler.

Definition at line 220 of file EventHandler.h.

References ASSA::REACTTRACE, and trace_with_mask.

{
    trace_with_mask("EventHandler::reset",REACTTRACE);
}

void ASSA::EventHandler::set_id ( const std::string &  id_ )

inline

Set EventHandler ID.

ID allows Reactor and application-level code describe intelligently the kind of the EventHandler.

Definition at line 153 of file EventHandler.h.

References m_id.

Referenced by ASSA::Connector< SERVICE_HANDLER, PEER_CONNECTOR >::Connector().

{ m_id = id_; }

Member Data Documentation

std::string ASSA::EventHandler::m_id

protected

Definition at line 160 of file EventHandler.h.

Referenced by get_id(), and set_id().

---

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

• /tmp/buildd/libassa-3.5.1/assa/EventHandler.h