OpenRTM-aist  1.2.1
Public Member Functions | List of all members
coil::Async_t< Object, Func > Class Template Reference

Async_t template class. More...

#include <Async.h>

Inheritance diagram for coil::Async_t< Object, Func >:
Inheritance graph
[legend]
Collaboration diagram for coil::Async_t< Object, Func >:
Collaboration graph
[legend]

Public Member Functions

 Async_t (Object *obj, Func func, bool auto_delete=false)
 Constructor. More...
 
virtual ~Async_t ()
 Destructor. More...
 
virtual int svc ()
 Thread execution function for asynchronous invoke. More...
 
virtual void finalize ()
 Finalize the asynchronous function. More...
 
virtual void invoke ()
 Asynchronous function Activation. More...
 
virtual bool finished ()
 Check on completion state. More...
 
- Public Member Functions inherited from coil::Async
 Async ()
 Constructor. More...
 
virtual ~Async ()
 Destructor. More...
 
- Public Member Functions inherited from coil::Task
 Task ()
 Constructor. More...
 
virtual ~Task ()
 Destructor. More...
 
virtual int open (void *args=0)
 Task open. More...
 
virtual int close (unsigned long flags=0)
 Task close. More...
 
virtual void activate ()
 Create a thread. More...
 
virtual int wait (void)
 Waiting for the thread terminate. More...
 
virtual int suspend (void)
 Suspending the task. More...
 
virtual int resume (void)
 Resuming the suspended task. More...
 
virtual void reset ()
 Reset of task count. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from coil::Task
static void * svc_run (void *args=0)
 Start thread Execution. More...
 

Detailed Description

template<typename Object, typename Func>
class coil::Async_t< Object, Func >

Async_t template class.

Constructor & Destructor Documentation

template<typename Object, typename Func>
coil::Async_t< Object, Func >::Async_t ( Object *  obj,
Func  func,
bool  auto_delete = false 
)
inline

Constructor.

Constructor

Parameters
objThe target object for the asynchronous function.
funcAsynchronous function.
auto_deleteflag for automatic instance destruction.
template<typename Object, typename Func>
virtual coil::Async_t< Object, Func >::~Async_t ( )
inlinevirtual

Destructor.

Destructor

Member Function Documentation

template<typename Object, typename Func>
virtual void coil::Async_t< Object, Func >::finalize ( )
inlinevirtual

Finalize the asynchronous function.

Finalize the asynchronous function for preparing it for destruction.

Reimplemented from coil::Task.

References coil::Task::finalize().

template<typename Object, typename Func>
virtual bool coil::Async_t< Object, Func >::finished ( )
inlinevirtual

Check on completion state.

Return a completion state.

Returns
true: finished, false: unfinished

Implements coil::Async.

template<typename Object, typename Func>
virtual void coil::Async_t< Object, Func >::invoke ( )
inlinevirtual

Asynchronous function Activation.

Activate of Asynchronous function.

Implements coil::Async.

References coil::Task::activate().

template<typename Object, typename Func>
virtual int coil::Async_t< Object, Func >::svc ( void  )
inlinevirtual

Thread execution function for asynchronous invoke.

Invoke the registered objects operation.

Returns
The execution result.

Reimplemented from coil::Task.


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