Structure to describe a channel "technology", ie a channel driver See for examples:. More...
#include <channel.h>
Data Fields | |
int(*const | answer )(struct ast_channel *chan) |
Answer the channel. | |
enum ast_bridge_result(*const | bridge )(struct ast_channel *c0, struct ast_channel *c1, int flags, struct ast_frame **fo, struct ast_channel **rc, int timeoutms) |
Bridge two channels of the same type together. | |
struct ast_channel *(*const | bridged_channel )(struct ast_channel *chan, struct ast_channel *bridge) |
Find bridged channel. | |
int(*const | call )(struct ast_channel *chan, char *addr, int timeout) |
Call a given phone number (address, etc), but don't take longer than timeout seconds to do so. | |
int | capabilities |
const char *const | description |
int(*const | devicestate )(void *data) |
struct ast_frame *(*const | exception )(struct ast_channel *chan) |
Handle an exception, reading a frame. | |
int(*const | fixup )(struct ast_channel *oldchan, struct ast_channel *newchan) |
Fix up a channel: If a channel is consumed, this is called. Basically update any ->owner links. | |
int(* | func_channel_read )(struct ast_channel *chan, char *function, char *data, char *buf, size_t len) |
Provide additional read items for CHANNEL() dialplan function. | |
int(* | func_channel_write )(struct ast_channel *chan, char *function, char *data, const char *value) |
Provide additional write items for CHANNEL() dialplan function. | |
struct ast_channel *(* | get_base_channel )(struct ast_channel *chan) |
Retrieve base channel (agent and local). | |
int(*const | hangup )(struct ast_channel *chan) |
Hangup (and possibly destroy) the channel. | |
int(*const | indicate )(struct ast_channel *c, int condition, const void *data, size_t datalen) |
Indicate a particular condition (e.g. AST_CONTROL_BUSY or AST_CONTROL_RINGING or AST_CONTROL_CONGESTION. | |
int | properties |
int(*const | queryoption )(struct ast_channel *chan, int option, void *data, int *datalen) |
Query a given option. | |
struct ast_frame *(*const | read )(struct ast_channel *chan) |
Read a frame, in standard format (see frame.h). | |
struct ast_channel *(*const | requester )(const char *type, int format, void *data, int *cause) |
Requester - to set up call data structures (pvt's). | |
int(*const | send_digit_begin )(struct ast_channel *chan, char digit) |
Start sending a literal DTMF digit. | |
int(*const | send_digit_end )(struct ast_channel *chan, char digit, unsigned int duration) |
Stop sending a literal DTMF digit. | |
int(*const | send_html )(struct ast_channel *chan, int subclass, const char *data, int len) |
Send HTML data. | |
int(*const | send_image )(struct ast_channel *chan, struct ast_frame *frame) |
Display or send an image. | |
int(*const | send_text )(struct ast_channel *chan, const char *text) |
Display or transmit text. | |
int(* | set_base_channel )(struct ast_channel *chan, struct ast_channel *base) |
Set base channel (agent and local). | |
int(*const | setoption )(struct ast_channel *chan, int option, void *data, int datalen) |
Set a given option. | |
int(*const | transfer )(struct ast_channel *chan, const char *newdest) |
Blind transfer other side (see app_transfer.c and ast_transfer(). | |
const char *const | type |
int(*const | write )(struct ast_channel *chan, struct ast_frame *frame) |
Write a frame, in standard format (see frame.h). | |
int(*const | write_video )(struct ast_channel *chan, struct ast_frame *frame) |
Write a frame, in standard format. |
Structure to describe a channel "technology", ie a channel driver See for examples:.
If you develop your own channel driver, this is where you tell the PBX at registration of your driver what properties this driver supports and where different callbacks are implemented.
Definition at line 227 of file channel.h.
int(* const answer)(struct ast_channel *chan) |
Answer the channel.
Referenced by ast_answer().
enum ast_bridge_result(* const bridge)(struct ast_channel *c0, struct ast_channel *c1, int flags, struct ast_frame **fo, struct ast_channel **rc, int timeoutms) |
Bridge two channels of the same type together.
Referenced by ast_channel_bridge().
struct ast_channel*(* const bridged_channel)(struct ast_channel *chan, struct ast_channel *bridge) [read] |
Find bridged channel.
Referenced by ast_bridged_channel().
int(* const call)(struct ast_channel *chan, char *addr, int timeout) |
Call a given phone number (address, etc), but don't take longer than timeout seconds to do so.
Referenced by ast_call().
int capabilities |
Bitmap of formats this channel can handle
Definition at line 231 of file channel.h.
Referenced by ast_request(), load_module(), show_channeltype(), and show_channeltype_deprecated().
const char* const description |
Definition at line 229 of file channel.h.
Referenced by ast_channel_register(), ast_channeltype_list(), and show_channeltypes().
int(* const devicestate)(void *data) |
Devicestate call back
Referenced by ast_device_state(), show_channeltype(), show_channeltype_deprecated(), and show_channeltypes().
struct ast_frame*(* const exception)(struct ast_channel *chan) [read] |
Handle an exception, reading a frame.
Referenced by __ast_read().
int(* const fixup)(struct ast_channel *oldchan, struct ast_channel *newchan) |
Fix up a channel: If a channel is consumed, this is called. Basically update any ->owner links.
Referenced by ast_do_masquerade().
int(* func_channel_read)(struct ast_channel *chan, char *function, char *data, char *buf, size_t len) |
Provide additional read items for CHANNEL() dialplan function.
Referenced by func_channel_read().
int(* func_channel_write)(struct ast_channel *chan, char *function, char *data, const char *value) |
Provide additional write items for CHANNEL() dialplan function.
Referenced by func_channel_write_real().
struct ast_channel*(* get_base_channel)(struct ast_channel *chan) [read] |
Retrieve base channel (agent and local).
Referenced by ast_channel_masquerade().
int(* const hangup)(struct ast_channel *chan) |
Hangup (and possibly destroy) the channel.
Referenced by ast_do_masquerade(), and ast_hangup().
int(* const indicate)(struct ast_channel *c, int condition, const void *data, size_t datalen) |
Indicate a particular condition (e.g. AST_CONTROL_BUSY or AST_CONTROL_RINGING or AST_CONTROL_CONGESTION.
Referenced by agent_indicate(), ast_indicate_data(), ast_write(), show_channeltype(), show_channeltype_deprecated(), and show_channeltypes().
int properties |
Technology Properties
Definition at line 233 of file channel.h.
Referenced by ast_jb_do_usecheck(), and schedule_delivery().
int(* const queryoption)(struct ast_channel *chan, int option, void *data, int *datalen) |
Query a given option.
struct ast_frame*(* const read)(struct ast_channel *chan) [read] |
Read a frame, in standard format (see frame.h).
Referenced by __ast_read().
struct ast_channel*(* const requester)(const char *type, int format, void *data, int *cause) [read] |
Requester - to set up call data structures (pvt's).
Referenced by ast_request().
int(* const send_digit_begin)(struct ast_channel *chan, char digit) |
Start sending a literal DTMF digit.
Referenced by ast_channel_bridge(), ast_rtp_bridge(), ast_senddigit(), ast_senddigit_begin(), show_channeltype(), and show_channeltype_deprecated().
int(* const send_digit_end)(struct ast_channel *chan, char digit, unsigned int duration) |
Stop sending a literal DTMF digit.
Referenced by ast_senddigit_end(), show_channeltype(), and show_channeltype_deprecated().
int(* const send_html)(struct ast_channel *chan, int subclass, const char *data, int len) |
Send HTML data.
Referenced by ast_channel_sendhtml(), ast_channel_supports_html(), ast_write(), show_channeltype(), and show_channeltype_deprecated().
int(* const send_image)(struct ast_channel *chan, struct ast_frame *frame) |
Display or send an image.
Referenced by ast_send_image(), ast_supports_images(), show_channeltype(), and show_channeltype_deprecated().
int(* const send_text)(struct ast_channel *chan, const char *text) |
Display or transmit text.
Referenced by ast_sendtext(), ast_write(), sendtext_exec(), show_channeltype(), and show_channeltype_deprecated().
int(* set_base_channel)(struct ast_channel *chan, struct ast_channel *base) |
Set base channel (agent and local).
int(* const setoption)(struct ast_channel *chan, int option, void *data, int datalen) |
Set a given option.
Referenced by ast_channel_setoption().
int(* const transfer)(struct ast_channel *chan, const char *newdest) |
Blind transfer other side (see app_transfer.c and ast_transfer().
Referenced by ast_transfer(), show_channeltype(), show_channeltype_deprecated(), show_channeltypes(), and transfer_exec().
const char* const type |
Definition at line 228 of file channel.h.
Referenced by agent_read(), ast_channel_register(), ast_channel_unregister(), ast_channeltype_list(), ast_do_masquerade(), ast_get_channel_tech(), ast_request(), cb_events(), complete_channeltypes(), complete_channeltypes_deprecated(), conf_exec(), conf_run(), exec(), flash_exec(), func_channel_read(), get_proto(), handle_response_invite(), handle_showchan(), handle_showchan_deprecated(), load_module(), misdn_facility_exec(), misdn_set_opt_exec(), oss_read(), park_call_full(), serialize_showchan(), setup_env(), show_channeltype(), show_channeltype_deprecated(), show_channeltypes(), softhangup_exec(), transfer_exec(), and try_calling().
int(* const write)(struct ast_channel *chan, struct ast_frame *frame) |
Write a frame, in standard format (see frame.h).
Referenced by ast_write().
int(* const write_video)(struct ast_channel *chan, struct ast_frame *frame) |
Write a frame, in standard format.
Referenced by ast_write(), and ast_write_video().