Asterisk - The Open Source Telephony Project  GIT-master-a1fa8df
Public Member Functions | Data Fields
ast_custom_function Struct Reference

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

#include <pbx.h>

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
 
const char * desc
 
enum ast_doc_src docsrc
 
struct ast_modulemod
 
const char * name
 
ast_acf_read_fn_t read
 
int(* read )(struct ast_channel *, const char *, char *, char *, size_t)
 
ast_acf_read2_fn_t read2
 
unsigned int read_escalates:1
 
size_t read_max
 
const ast_string_field seealso
 
const ast_string_field synopsis
 
const char * synopsis
 
const ast_string_field syntax
 
const char * syntax
 
ast_acf_write_fn_t write
 
int(* write )(struct ast_channel *, const char *, char *, const char *)
 
unsigned int write_escalates:1
 

Detailed Description

Data structure associated with a custom dialplan function.

Definition at line 118 of file pbx.h.

Member Function Documentation

◆ AST_LIST_ENTRY()

AST_LIST_ENTRY ( ast_custom_function  )

Field Documentation

◆ __field_mgr

struct ast_string_field_mgr __field_mgr

Definition at line 126 of file pbx.h.

◆ __field_mgr_pool

struct ast_string_field_pool* __field_mgr_pool

Definition at line 126 of file pbx.h.

◆ arguments

const ast_string_field arguments

Arguments description

Definition at line 126 of file pbx.h.

Referenced by acf_retrieve_docs(), and handle_show_function().

◆ desc [1/2]

const ast_string_field desc

Description (help text) for 'show functions <name>'

Definition at line 126 of file pbx.h.

Referenced by acf_retrieve_docs(), and handle_show_function().

◆ desc [2/2]

const char* desc

Help text that explains it all

Definition at line 2099 of file extconf.c.

◆ docsrc

enum ast_doc_src docsrc

Where the documentation come from

Definition at line 127 of file pbx.h.

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

◆ mod

struct ast_module* mod

Module this custom function belongs to

Definition at line 142 of file pbx.h.

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

◆ name

const char * name

◆ read [1/2]

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

Definition at line 129 of file pbx.h.

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

◆ read [2/2]

int(* read) (struct ast_channel *, const char *, char *, char *, size_t)

Read function, if read is supported

Definition at line 2101 of file extconf.c.

◆ 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 137 of file pbx.h.

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

◆ read_escalates

unsigned int read_escalates

The read function is to be considered 'dangerous', and should not be run directly from external interfaces (AMI, ARI, etc.)

Since
12

Definition at line 143 of file pbx.h.

Referenced by __ast_custom_function_register_escalating(), and read_escalates().

◆ read_max

size_t read_max

If no read2 function is provided, what maximum size?

Definition at line 139 of file pbx.h.

Referenced by ast_func_read2().

◆ seealso

const ast_string_field seealso

See also

Definition at line 126 of file pbx.h.

Referenced by acf_retrieve_docs(), and handle_show_function().

◆ synopsis [1/2]

const ast_string_field synopsis

Synopsis text for 'show functions'

Definition at line 126 of file pbx.h.

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

◆ synopsis [2/2]

const char* synopsis

Short description for "show functions"

Definition at line 2098 of file extconf.c.

◆ syntax [1/2]

const ast_string_field syntax

Syntax text for 'core show functions'

Definition at line 126 of file pbx.h.

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

◆ syntax [2/2]

const char* syntax

Syntax description

Definition at line 2100 of file extconf.c.

◆ write [1/2]

Write function, if write is supported Write function, if write is supported

Definition at line 141 of file pbx.h.

Referenced by ast_func_write(), and MultiOrderedConfigParser::write().

◆ write [2/2]

int(* write) (struct ast_channel *, const char *, char *, const char *)

Write function, if write is supported

Definition at line 2102 of file extconf.c.

Referenced by MultiOrderedConfigParser::write().

◆ write_escalates

unsigned int write_escalates

The write function is to be considerd 'dangerous', and should not be run directly from external interfaces (AMI, ARI, etc.)

Since
12

Definition at line 147 of file pbx.h.

Referenced by __ast_custom_function_register_escalating(), and write_escalates().


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