OpenMAMA C++ API
Wombat::MamaIo Class Reference

A repeating IO. More...

#include <MamaIo.h>

Public Member Functions

virtual ~MamaIo (void)
 
 MamaIo (void)
 
virtual void create (MamaQueue *queue, MamaIoCallback *action, uint32_t descriptor, mamaIoType ioType, void *closure=NULL)
 Create an IO handler. More...
 
virtual uint32_t getDescriptor (void) const
 
virtual void destroy ()
 
virtual void * getClosure (void) const
 Return the closure for the IO. More...
 

Public Attributes

MamaIoImpl * mPimpl
 

Detailed Description

A repeating IO.

The callback will be repeatedly called at the specified interval until the IO is destroyed. See Mama::createMamaIo ().

The IO relies on the underlying middleware so its resolution is also dependent on the middleware.

Constructor & Destructor Documentation

§ ~MamaIo()

virtual Wombat::MamaIo::~MamaIo ( void  )
virtual

§ MamaIo()

Wombat::MamaIo::MamaIo ( void  )

Member Function Documentation

§ create()

virtual void Wombat::MamaIo::create ( MamaQueue queue,
MamaIoCallback action,
uint32_t  descriptor,
mamaIoType  ioType,
void *  closure = NULL 
)
virtual

Create an IO handler.

Parameters
queueThe event queue for the io events. NULL specifies the Mama default queue.
actionThe callback to be invoked when an event occurs.
descriptorWait for IO on this descriptor.
ioTypeWait for occurrences of this type. See mama/io.h
closureThe caller supplied closure.

§ getDescriptor()

virtual uint32_t Wombat::MamaIo::getDescriptor ( void  ) const
virtual

§ destroy()

virtual void Wombat::MamaIo::destroy ( )
virtual

§ getClosure()

virtual void* Wombat::MamaIo::getClosure ( void  ) const
virtual

Return the closure for the IO.

Returns
the closure.

Member Data Documentation

§ mPimpl

MamaIoImpl* Wombat::MamaIo::mPimpl