Data structure associated with a custom dialplan function. More...
#include <pbx.h>
Public Member Functions | |
AST_DECLARE_STRING_FIELDS (AST_STRING_FIELD(synopsis);AST_STRING_FIELD(desc);AST_STRING_FIELD(syntax);AST_STRING_FIELD(arguments);AST_STRING_FIELD(seealso);) | |
Data Fields | |
struct { | |
struct ast_custom_function * next | |
} | acflist |
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 |
ast_acf_write_fn_t | write |
Data structure associated with a custom dialplan function.
Definition at line 85 of file pbx.h.
AST_DECLARE_STRING_FIELDS | ( | AST_STRING_FIELD(synopsis);AST_STRING_FIELD(desc);AST_STRING_FIELD(syntax);AST_STRING_FIELD(arguments);AST_STRING_FIELD(seealso); | ) |
struct { ... } acflist |
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 [read] |
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
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().
struct ast_custom_function* next [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().
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().
Write function, if write is supported Write function, if write is supported
Definition at line 108 of file pbx.h.
Referenced by ast_func_write().