senf::ppi::IOEvent Class Reference
[Events]

FileHandle based I/O read/write event. More...

#include <senf/PPI/IOEvent.hh>

Inheritance diagram for senf::ppi::IOEvent:
Inheritance graph
[legend]

List of all members.


Detailed Description

FileHandle based I/O read/write event.

An IOEvent is signaled, whenever the FileHandle handle becomes readable or writable. The type of event is specified using the events mask with values from EventFlags.

There are two types of flags:

  • Event flags (Read, Prio, Write) specify the type of event. The callback will be called whenever one of the specified events occurs on the filehandle
  • Error flags (Hup, Err) specify some type of error condition on the filehandle. If you specify an error flag when registering the event, the error condition will be passed to the callback, otherwise an ErrorException or HangupException will be thrown.
See also:
IOEventInfo

Definition at line 69 of file IOEvent.hh.


Classes

struct   ErrorException
  Unhandled error condition. More...
struct   HangupException
  Unhandled hangup condition. More...

Public Types

enum   EventFlags {
  Read = scheduler::FdEvent::EV_READ, Prio = scheduler::FdEvent::EV_PRIO, Write = scheduler::FdEvent::EV_WRITE, Hup = scheduler::FdEvent::EV_HUP,
  Err = scheduler::FdEvent::EV_ERR
}

Public Member Functions

template<class Handle >
void  set (Handle handle, unsigned events)

Structors and default members

  IOEvent ()
template<class Handle >
  IOEvent (Handle handle, unsigned events)

Member Enumeration Documentation

enum senf::ppi::IOEvent::
EventFlags
Enumerator:
Read  FileHandle is readable
Prio  FileHandle priority data is readable
Write  FileHandle is writable
Hup  Hangup condition on FileHandle
Err  Some other error condition on FileHandle

Definition at line 79 of file IOEvent.hh.


Constructor & Destructor Documentation

senf::ppi::IOEvent::
IOEvent ()

Definition at line 33 of file IOEvent.cci.

template<class Handle >
senf::ppi::IOEvent::
IOEvent ( Handle  handle,
unsigned  events )

Definition at line 38 of file IOEvent.cti.


Member Function Documentation

template<class Handle >
void senf::ppi::IOEvent::
set ( Handle  handle,
unsigned  events )

Definition at line 34 of file IOEvent.ct.


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