Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
coil::Task Class Reference

Task class. More...

#include <Task.h>

Inheritance diagram for coil::Task:
Inheritance graph
[legend]

Public Member Functions

virtual void activate ()
 Create a thread. More...
 
virtual void activate ()
 Create a thread. More...
 
virtual int close (unsigned long flags=0)
 Task close. More...
 
virtual int close (unsigned long flags=0)
 Task close. More...
 
virtual void finalize ()
 Finalizing the task. More...
 
virtual void finalize ()
 Finalizing the task. More...
 
virtual int open (void *args=0)
 Task open. More...
 
virtual int open (void *args=0)
 Task open. More...
 
virtual void reset ()
 Reset of task count. More...
 
virtual void reset ()
 Reset of task count. More...
 
virtual int resume (void)
 Resuming the suspended task. More...
 
virtual int resume (void)
 Resuming the suspended task. More...
 
virtual int suspend (void)
 Suspending the task. More...
 
virtual int suspend (void)
 Suspending the task. More...
 
virtual int svc ()
 Execute thread. More...
 
virtual int svc ()
 Execute thread. More...
 
 Task ()
 Constructor. More...
 
 Task ()
 Constructor. More...
 
virtual int wait (void)
 Waiting for the thread terminate. More...
 
virtual int wait (void)
 Waiting for the thread terminate. More...
 
virtual ~Task ()
 Destructor. More...
 
virtual ~Task ()
 Destructor. More...
 

Static Public Member Functions

static void * svc_run (void *args=0)
 Start thread Execution. More...
 
static unsigned int WINAPI svc_run (void *args=0)
 Start thread Execution. More...
 

Private Attributes

void * m_args
 
pthread_attr_t m_attr
 
int m_count
 
pthread_t m_thread
 
HANDLE m_thread
 

Detailed Description

Task class.

Definition at line 39 of file posix/coil/Task.h.

Constructor & Destructor Documentation

◆ Task() [1/2]

coil::Task::Task ( )

Constructor.

Constructor

Definition at line 31 of file posix/coil/Task.cpp.

◆ ~Task() [1/2]

coil::Task::~Task ( )
virtual

Destructor.

Destructor

Definition at line 44 of file posix/coil/Task.cpp.

◆ Task() [2/2]

coil::Task::Task ( )

Constructor.

Constructor

◆ ~Task() [2/2]

virtual coil::Task::~Task ( )
virtual

Destructor.

Destructor

Member Function Documentation

◆ activate() [1/2]

void coil::Task::activate ( )
virtual

Create a thread.

Create a thread

Reimplemented in coil::PeriodicTaskBase, and coil::PeriodicTask.

Definition at line 92 of file posix/coil/Task.cpp.

◆ activate() [2/2]

virtual void coil::Task::activate ( )
virtual

Create a thread.

Create a thread

Reimplemented in coil::PeriodicTaskBase, and coil::PeriodicTask.

◆ close() [1/2]

int coil::Task::close ( unsigned long  flags = 0)
virtual

Task close.

Task close

Parameters
flagsFlags

Reimplemented in RTC::Manager::OrbRunner, and RTC::PeriodicExecutionContext.

Definition at line 68 of file posix/coil/Task.cpp.

◆ close() [2/2]

virtual int coil::Task::close ( unsigned long  flags = 0)
virtual

Task close.

Task close

Parameters
flagsFlags

Reimplemented in RTC::Manager::OrbRunner, and RTC::PeriodicExecutionContext.

◆ finalize() [1/2]

void coil::Task::finalize ( )
virtual

Finalizing the task.

Finalizing the task.

Reimplemented in coil::Async_ref_t< Object, Func >, coil::PeriodicTaskBase, coil::Async_t< Object, Func >, and coil::PeriodicTask.

Definition at line 164 of file posix/coil/Task.cpp.

◆ finalize() [2/2]

virtual void coil::Task::finalize ( )
virtual

Finalizing the task.

Finalizing the task.

Reimplemented in coil::Async_ref_t< Object, Func >, coil::PeriodicTaskBase, coil::Async_t< Object, Func >, and coil::PeriodicTask.

◆ open() [1/2]

int coil::Task::open ( void *  args = 0)
virtual

Task open.

Task open

Parameters
argsArguments

Reimplemented in RTC::Manager::Terminator, RTC::Manager::OrbRunner, RTC::PeriodicExecutionContext, and coil::Timer.

Definition at line 56 of file posix/coil/Task.cpp.

◆ open() [2/2]

virtual int coil::Task::open ( void *  args = 0)
virtual

Task open.

Task open

Parameters
argsArguments

Reimplemented in RTC::Manager::Terminator, RTC::Manager::OrbRunner, RTC::PeriodicExecutionContext, and coil::Timer.

◆ reset() [1/2]

void coil::Task::reset ( )
virtual

Reset of task count.

Reset of task count

Definition at line 152 of file posix/coil/Task.cpp.

◆ reset() [2/2]

virtual void coil::Task::reset ( )
virtual

Reset of task count.

Reset of task count

◆ resume() [1/2]

int coil::Task::resume ( void  )
virtual

Resuming the suspended task.

Resuming the suspended task

Reimplemented in coil::PeriodicTaskBase, and coil::PeriodicTask.

Definition at line 140 of file posix/coil/Task.cpp.

◆ resume() [2/2]

virtual int coil::Task::resume ( void  )
virtual

Resuming the suspended task.

Resuming the suspended task

Reimplemented in coil::PeriodicTaskBase, and coil::PeriodicTask.

◆ suspend() [1/2]

int coil::Task::suspend ( void  )
virtual

Suspending the task.

Suspending the task

Reimplemented in coil::PeriodicTaskBase, and coil::PeriodicTask.

Definition at line 128 of file posix/coil/Task.cpp.

◆ suspend() [2/2]

virtual int coil::Task::suspend ( void  )
virtual

Suspending the task.

Suspending the task

Reimplemented in coil::PeriodicTaskBase, and coil::PeriodicTask.

◆ svc() [1/2]

int coil::Task::svc ( void  )
virtual

Execute thread.

Execute thread

Reimplemented in RTC::Manager::Terminator, RTC::Manager::OrbRunner, Tests::ManagerTests::InvokerMock, coil::Async_ref_t< Object, Func >, coil::PeriodicTask, Logger::LogOutCreator, coil::Async_t< Object, Func >, RTC::PeriodicExecutionContext, OpenRTM::RTPreemptEC, Time::TimeTests, coil::Timer, RTC::ExtTrigExecutionContext, Guard::GuardTests, Mutex::MutexTests::TestTaskTrylock, Task::TaskTests, Threaded, RTC::OpenHRPExecutionContext, Condition::ConditionCheckTask, Time::TimeTests::TestTimeTask, Logger::LogCreator, Guard::GuardTests::TestGuardTask, Mutex::MutexTests::TestTaskLock, and RTC::ArtExecutionContext.

Definition at line 80 of file posix/coil/Task.cpp.

◆ svc() [2/2]

virtual int coil::Task::svc ( )
virtual

Execute thread.

Execute thread

Reimplemented in RTC::Manager::Terminator, RTC::Manager::OrbRunner, Tests::ManagerTests::InvokerMock, coil::Async_ref_t< Object, Func >, coil::PeriodicTask, Logger::LogOutCreator, coil::Async_t< Object, Func >, RTC::PeriodicExecutionContext, OpenRTM::RTPreemptEC, Time::TimeTests, coil::Timer, RTC::ExtTrigExecutionContext, Guard::GuardTests, Mutex::MutexTests::TestTaskTrylock, Task::TaskTests, Threaded, RTC::OpenHRPExecutionContext, Condition::ConditionCheckTask, Time::TimeTests::TestTimeTask, Logger::LogCreator, Guard::GuardTests::TestGuardTask, Mutex::MutexTests::TestTaskLock, and RTC::ArtExecutionContext.

◆ svc_run() [1/2]

unsigned int WINAPI coil::Task::svc_run ( void *  args = 0)
static

Start thread Execution.

Start thread Execution

Parameters
argsThread arguments

Definition at line 176 of file posix/coil/Task.cpp.

◆ svc_run() [2/2]

static unsigned int WINAPI coil::Task::svc_run ( void *  args = 0)
static

Start thread Execution.

Start thread Execution

Parameters
argsThread arguments

◆ wait() [1/2]

int coil::Task::wait ( void  )
virtual

Waiting for the thread terminate.

Waiting for the thread terminate

Definition at line 111 of file posix/coil/Task.cpp.

◆ wait() [2/2]

virtual int coil::Task::wait ( void  )
virtual

Waiting for the thread terminate.

Waiting for the thread terminate

Member Data Documentation

◆ m_args

void* coil::Task::m_args
private

Definition at line 262 of file posix/coil/Task.h.

◆ m_attr

pthread_attr_t coil::Task::m_attr
private

Definition at line 261 of file posix/coil/Task.h.

◆ m_count

int coil::Task::m_count
private

Definition at line 259 of file posix/coil/Task.h.

◆ m_thread [1/2]

pthread_t coil::Task::m_thread
private

Definition at line 260 of file posix/coil/Task.h.

◆ m_thread [2/2]

HANDLE coil::Task::m_thread
private

Definition at line 262 of file win32/coil/Task.h.

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

openrtm_aist
Author(s): Noriaki Ando
autogenerated on Mon Feb 28 2022 23:00:46