ast_taskprocessor_listener_callbacks Struct Reference

#include <taskprocessor.h>


Data Fields

void(* dtor )(struct ast_taskprocessor_listener *listener)
void(* emptied )(struct ast_taskprocessor_listener *listener)
 Indicates the task processor has become empty.
void(* shutdown )(struct ast_taskprocessor_listener *listener)
 Indicates the taskprocessor wishes to die.
int(* start )(struct ast_taskprocessor_listener *listener)
 The taskprocessor has started completely.
void(* task_pushed )(struct ast_taskprocessor_listener *listener, int was_empty)
 Indicates a task was pushed to the processor.


Detailed Description

Definition at line 76 of file taskprocessor.h.


Field Documentation

void(* dtor)(struct ast_taskprocessor_listener *listener)

void(* emptied)(struct ast_taskprocessor_listener *listener)

Indicates the task processor has become empty.

Parameters:
listener The listener

Referenced by ast_taskprocessor_execute().

void(* shutdown)(struct ast_taskprocessor_listener *listener)

Indicates the taskprocessor wishes to die.

All operations on the task processor must to be stopped in this callback. This is an opportune time to free the listener's user data if it is not going to be used anywhere else.

After this callback returns, it is NOT safe to operate on the listener's reference to the taskprocessor.

Parameters:
listener The listener

Referenced by listener_shutdown().

int(* start)(struct ast_taskprocessor_listener *listener)

The taskprocessor has started completely.

This indicates that the taskprocessor is fully set up and the listener can now start interacting with it.

Parameters:
listener The listener to start

void(* task_pushed)(struct ast_taskprocessor_listener *listener, int was_empty)

Indicates a task was pushed to the processor.

Parameters:
listener The listener
was_empty If non-zero, the taskprocessor was empty prior to the task being pushed

Referenced by taskprocessor_push().


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

Generated on Thu Apr 16 06:35:42 2015 for Asterisk - The Open Source Telephony Project by  doxygen 1.5.6