vsk_Inbox

Data Structures
struct	vsk_Inbox_Class
	Inbox class. More...
struct	vsk_Inbox
	Inbox. More...

Typedefs
typedef struct vsk_Inbox_Class	vsk_Inbox_Class_t
	Inbox class.
typedef struct vsk_Inbox	vsk_Inbox_t
	Inbox.

Functions
vsk_Inbox_Class_t *	vsk_Inbox_Class_init (vsk_Inbox_Class_t *const cls)
	Initializes the Inbox class.
void	vsk_Inbox_Class_onTick (vsk_Inbox_Class_t *const cls)
	Propagates the system tick to all inboxes.
vsk_Inbox_t *	vsk_Inbox_init (vsk_Inbox_t *const self, vsk_Task_t *const task)
	Initializes an Inbox.
bool	vsk_Inbox_isEmpty (vsk_Inbox_t *const self)
	Checks if the inbox is empty.
void	vsk_Inbox_postMessage (vsk_Inbox_t *const self, vsk_Message_t *const message)
	Posts a message to the inbox.
vsk_Message_t *	vsk_Inbox_readMessage (vsk_Inbox_t *const self)
	Reads a message from the inbox.
void	vsk_Inbox_clear (vsk_Inbox_t *const self)
	Clears the inbox.

Variables
vsk_Inbox_Class_t	vsk_Inbox_Class
	Inbox class instance.

Detailed Description

Function Documentation

vsk_Inbox_Class_init()

vsk_Inbox_Class_t * vsk_Inbox_Class_init

(

vsk_Inbox_Class_t *const

cls

)

Initializes the Inbox class.

Parameters

cls	Inbox class reference

Returns

Initialized Inbox class reference

vsk_Inbox_Class_onTick()

void vsk_Inbox_Class_onTick

(

vsk_Inbox_Class_t *const

cls

)

Propagates the system tick to all inboxes.

Parameters

cls	Inbox class reference

vsk_Inbox_clear()

void vsk_Inbox_clear

(

vsk_Inbox_t *const

self

)

Clears the inbox.

Parameters

self	Inbox reference

vsk_Inbox_init()

vsk_Inbox_t * vsk_Inbox_init	(	vsk_Inbox_t *const	self,
		vsk_Task_t *const	task )

Initializes an Inbox.

Parameters

self	Inbox reference
task	Associated Task reference

Returns

Initialized Inbox reference

vsk_Inbox_isEmpty()

bool vsk_Inbox_isEmpty

(

vsk_Inbox_t *const

self

)

Checks if the inbox is empty.

Parameters

self	Inbox reference

Returns

true if the inbox is empty

false if the inbox is not empty

vsk_Inbox_postMessage()

void vsk_Inbox_postMessage	(	vsk_Inbox_t *const	self,
		vsk_Message_t *const	message )

Posts a message to the inbox.

Parameters

self	Inbox reference
message	Message reference

vsk_Inbox_readMessage()

vsk_Message_t * vsk_Inbox_readMessage

(

vsk_Inbox_t *const

self

)

Reads a message from the inbox.

Parameters

self	Inbox reference

Returns

Message reference