Thu Apr 16 06:48:44 2015

Asterisk developer's documentation


ast_framehook_interface Struct Reference

#include <framehook.h>

Collaboration diagram for ast_framehook_interface:

Collaboration graph
[legend]

Data Fields

void * data
ast_framehook_destroy_callback destroy_cb
ast_framehook_event_callback event_cb
uint16_t version

Detailed Description

This interface is required for attaching a framehook to a channel.

Definition at line 204 of file framehook.h.


Field Documentation

void* data

This pointer can represent any custom data to be stored on the !framehook. This data pointer will be provided during each event callback which allows the framehook to store any stateful data associated with the application using the hook.

Definition at line 215 of file framehook.h.

Referenced by ast_framehook_attach(), frame_trace_helper(), and framehook_list_push_event().

destroy_cb is optional. This function is called immediately before the framehook is destroyed to allow for stored_data cleanup.

Definition at line 211 of file framehook.h.

event_cb represents the function that will be called everytime an event occurs on the framehook.

Definition at line 208 of file framehook.h.

Referenced by ast_framehook_attach(), and framehook_list_push_event().

uint16_t version

framehook interface version number

Definition at line 206 of file framehook.h.

Referenced by ast_framehook_attach(), and frame_trace_helper().


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

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