Data structure associated with a custom dialplan function. More...

#include <pbx.h>

Collaboration diagram for ast_custom_function:

Public Member Functions
	AST_LIST_ENTRY (ast_custom_function) acflist
Data Fields
struct ast_string_field_mgr	__field_mgr
struct ast_string_field_pool *	__field_mgr_pool
const ast_string_field	arguments
const ast_string_field	desc
enum ast_doc_src	docsrc
struct ast_module *	mod
const char *	name
ast_acf_read_fn_t	read
ast_acf_read2_fn_t	read2
size_t	read_max
const ast_string_field	seealso
const ast_string_field	synopsis
const ast_string_field	syntax
ast_acf_write_fn_t	write

Detailed Description

Data structure associated with a custom dialplan function.

Definition at line 85 of file pbx.h.

Member Function Documentation

AST_LIST_ENTRY ( ast_custom_function )

Field Documentation

struct ast_string_field_mgr __field_mgr

Definition at line 93 of file pbx.h.

struct ast_string_field_pool* __field_mgr_pool

Definition at line 93 of file pbx.h.

const ast_string_field arguments

Definition at line 93 of file pbx.h.

Referenced by acf_retrieve_docs(), and handle_show_function().

const ast_string_field desc

Definition at line 93 of file pbx.h.

Referenced by acf_retrieve_docs(), and handle_show_function().

enum ast_doc_src docsrc

Where the documentation come from

Definition at line 94 of file pbx.h.

Referenced by __ast_custom_function_register(), acf_retrieve_docs(), ast_custom_function_unregister(), and handle_show_function().

struct ast_module* mod

Module this custom function belongs to

Definition at line 109 of file pbx.h.

Referenced by __ast_custom_function_register(), acf_retrieve_docs(), ast_func_read(), ast_func_read2(), and ast_func_write().

const char* name

Name Synopsis text for 'show functions' Description (help text) for 'show functions <name>' Syntax text for 'core show functions' Arguments description See also

Definition at line 86 of file pbx.h.

Referenced by __ast_custom_function_register(), acf_retrieve_docs(), ast_custom_function_find(), ast_custom_function_unregister(), handle_show_function(), handle_show_functions(), and unload_module().

ast_acf_read_fn_t read

Read function, if read is supported Read function, if read is supported

Definition at line 96 of file pbx.h.

Referenced by ast_func_read(), ast_func_read2(), and op_func().

ast_acf_read2_fn_t read2

Read function, if read is supported. Note: only one of read or read2 needs to be implemented. In new code, read2 should be implemented as the way forward, but they should return identical results, within the constraints of buffer size, if both are implemented. That is, if the read function is handed a 16-byte buffer, and the result is 17 bytes long, then the first 15 bytes (remember NULL terminator) should be the same for both the read and the read2 methods.

Definition at line 104 of file pbx.h.

Referenced by ast_func_read(), and ast_func_read2().

size_t read_max

If no read2 function is provided, what maximum size?

Definition at line 106 of file pbx.h.

Referenced by ast_func_read2().

const ast_string_field seealso

Definition at line 93 of file pbx.h.

Referenced by acf_retrieve_docs(), and handle_show_function().

const ast_string_field synopsis

Definition at line 93 of file pbx.h.

Referenced by acf_retrieve_docs(), handle_show_function(), and handle_show_functions().