roswrap::CallbackInterface Class Reference

Abstract interface for items which can be added to a CallbackQueueInterface. More...

#include <callback_queue_interface.h>

Inheritance diagram for roswrap::CallbackInterface:

Public Types
enum	CallResult { Success, TryAgain, Invalid }
	Possible results for the call() method. More...

Public Member Functions
virtual CallResult	call ()=0
	Call this callback. More...
virtual bool	ready ()
	Provides the opportunity for specifying that a callback is not ready to be called before call() actually takes place. More...
virtual	~CallbackInterface ()

Detailed Description

Abstract interface for items which can be added to a CallbackQueueInterface.

Definition at line 49 of file callback_queue_interface.h.

Member Enumeration Documentation

CallResult

enum roswrap::CallbackInterface::CallResult

Possible results for the call() method.

Enumerator
Success	Call succeeded.
TryAgain	Call not ready, try again later.
Invalid	Call no longer valid.

Definition at line 55 of file callback_queue_interface.h.

Constructor & Destructor Documentation

~CallbackInterface()

virtual roswrap::CallbackInterface::~CallbackInterface ( )

inlinevirtual

Definition at line 62 of file callback_queue_interface.h.

Member Function Documentation

call()

virtual CallResult roswrap::CallbackInterface::call ( )

pure virtual

Call this callback.

Returns

The result of the call

Implemented in roswrap::TimerManager< T, D, E >::TimerQueueCallback, and roswrap::SubscriptionQueue.

ready()

virtual bool roswrap::CallbackInterface::ready ( )

inlinevirtual

Provides the opportunity for specifying that a callback is not ready to be called before call() actually takes place.

Reimplemented in roswrap::SubscriptionQueue.

Definition at line 73 of file callback_queue_interface.h.

---

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

• callback_queue_interface.h