apt_task_msg.h File Reference

Task Message Base Definition. More...

#include "apt.h"

Go to the source code of this file.

Data Structures
struct	apt_task_msg_t

Typedefs
typedef struct apt_task_msg_t	apt_task_msg_t
typedef struct apt_task_msg_pool_t	apt_task_msg_pool_t

Enumerations
enum	apt_task_msg_type_e { TASK_MSG_CORE, TASK_MSG_USER }
enum	apt_core_task_msg_type_e {   CORE_TASK_MSG_NONE, CORE_TASK_MSG_START_COMPLETE, CORE_TASK_MSG_TERMINATE_REQUEST, CORE_TASK_MSG_TERMINATE_COMPLETE,   CORE_TASK_MSG_TAKEOFFLINE_REQUEST, CORE_TASK_MSG_TAKEOFFLINE_COMPLETE, CORE_TASK_MSG_BRINGONLINE_REQUEST, CORE_TASK_MSG_BRINGONLINE_COMPLETE }

Functions
apt_task_msg_pool_t *	apt_task_msg_pool_create_dynamic (apr_size_t msg_size, apr_pool_t *pool)
apt_task_msg_pool_t *	apt_task_msg_pool_create_static (apr_size_t msg_size, apr_size_t msg_pool_size, apr_pool_t *pool)
void	apt_task_msg_pool_destroy (apt_task_msg_pool_t *msg_pool)
apt_task_msg_t *	apt_task_msg_acquire (apt_task_msg_pool_t *task_msg_pool)
void	apt_task_msg_release (apt_task_msg_t *task_msg)

Detailed Description

Task Message Base Definition.

Typedef Documentation

typedef struct apt_task_msg_pool_t apt_task_msg_pool_t

Opaque task message pool declaration

typedef struct apt_task_msg_t apt_task_msg_t

Opaque task message declaration

Enumeration Type Documentation

enum apt_core_task_msg_type_e

Enumeration of core task messages

Enumerator
CORE_TASK_MSG_NONE	indefinite message
CORE_TASK_MSG_START_COMPLETE	start-complete message
CORE_TASK_MSG_TERMINATE_REQUEST	terminate-request message
CORE_TASK_MSG_TERMINATE_COMPLETE	terminate-complete message
CORE_TASK_MSG_TAKEOFFLINE_REQUEST	take-offline-request message
CORE_TASK_MSG_TAKEOFFLINE_COMPLETE	take-offline-complete message
CORE_TASK_MSG_BRINGONLINE_REQUEST	bring-online-request message
CORE_TASK_MSG_BRINGONLINE_COMPLETE	bring-online-complete message

enum apt_task_msg_type_e

Enumeration of task message types

Enumerator
TASK_MSG_CORE	core task message type
TASK_MSG_USER	user defined task messages start from here

Function Documentation

apt_task_msg_t* apt_task_msg_acquire

(

apt_task_msg_pool_t *

task_msg_pool

)

Acquire task message from task message pool

apt_task_msg_pool_t* apt_task_msg_pool_create_dynamic	(	apr_size_t	msg_size,
		apr_pool_t *	pool
	)

Create pool of task messages with dynamic allocation of messages (no actual pool is created)

apt_task_msg_pool_t* apt_task_msg_pool_create_static	(	apr_size_t	msg_size,
		apr_size_t	msg_pool_size,
		apr_pool_t *	pool
	)

Create pool of task messages with static allocation of messages

void apt_task_msg_pool_destroy

(

apt_task_msg_pool_t *

msg_pool

)

Destroy pool of task messages

void apt_task_msg_release

(

apt_task_msg_t *

task_msg

)

Realese task message