0.01.00
ot::Tasklet Class Reference

This class is used to represent a tasklet. More...

#include <src/core/common/tasklet.hpp>

Inheritance diagram for ot::Tasklet:
ot::InstanceLocator ot::Context

Public Types

typedef void(* Handler) (Tasklet &aTasklet)
 This function pointer is called when the tasklet is run. More...
 

Public Member Functions

 Tasklet (otInstance &aInstance, Handler aHandler, void *aContext)
 This constructor creates a tasklet instance. More...
 
otError Post (void)
 This method puts the tasklet on the run queue.
 
- Public Member Functions inherited from ot::InstanceLocator
otInstanceGetInstance (void) const
 This method returns a reference to the parent otInstance structure. More...
 
Ip6::Ip6GetIp6 (void) const
 This method returns a reference to the Ip6. More...
 
ThreadNetifGetNetif (void) const
 This method returns a reference to the thread network interface. More...
 

Friends

class TaskletScheduler
 

Additional Inherited Members

- Protected Member Functions inherited from ot::InstanceLocator
 InstanceLocator (otInstance &aInstance)
 This constructor initializes the object. More...
 
- Protected Member Functions inherited from ot::Context
 Context (void *aContext)
 This constructor initializes the context object. More...
 

Detailed Description

This class is used to represent a tasklet.

Member Typedef Documentation

§ Handler

typedef void(* ot::Tasklet::Handler) (Tasklet &aTasklet)

This function pointer is called when the tasklet is run.

Parameters
[in]aTaskletA reference to the tasklet being run.

Constructor & Destructor Documentation

§ Tasklet()

ot::Tasklet::Tasklet ( otInstance aInstance,
Handler  aHandler,
void *  aContext 
)

This constructor creates a tasklet instance.

Parameters
[in]aInstanceA reference to the instance object.
[in]aHandlerA pointer to a function that is called when the tasklet is run.
[in]aContextA pointer to arbitrary context information.

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