LibBeamApi  1.3.0
Public Member Functions | Private Attributes | List of all members
BEventPipe Class Reference

This class provides a base interface for sending events via a pipe. This allows threads to send events that can be picked up by the poll system call. More...

#include <BEvent.h>

Public Member Functions

 BEventPipe ()
 
 ~BEventPipe ()
 
void clear ()
 Clear events pending. More...
 
BError sendEvent (BEvent *event)
 Send an event. More...
 
BError getEvent (BEvent *event, int timeOutUs=-1)
 Receive the event. More...
 
int getReceiveFd ()
 returns the receive file descriptor for the poll system call More...
 

Private Attributes

int ofds [2]
 File descriptors for pipe. More...
 

Detailed Description

This class provides a base interface for sending events via a pipe. This allows threads to send events that can be picked up by the poll system call.

Constructor & Destructor Documentation

BEventPipe::BEventPipe ( )
BEventPipe::~BEventPipe ( )

Member Function Documentation

void BEventPipe::clear ( )

Clear events pending.

BError BEventPipe::getEvent ( BEvent event,
int  timeOutUs = -1 
)

Receive the event.

int BEventPipe::getReceiveFd ( )

returns the receive file descriptor for the poll system call

BError BEventPipe::sendEvent ( BEvent event)

Send an event.

Member Data Documentation

int BEventPipe::ofds[2]
private

File descriptors for pipe.


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