Thu Oct 11 06:50:13 2012

Asterisk developer's documentation


ast_channel_tech Struct Reference

Structure to describe a channel "technology", ie a channel driver See for examples:. More...

#include <channel.h>

Collaboration diagram for ast_channel_tech:

Collaboration graph
[legend]

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)
enum ast_bridge_result(*const early_bridge )(struct ast_channel *c0, struct ast_channel *c1)
 Bridge two channels of the same type together (early).
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, const 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, const 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).
const char *(* get_pvt_uniqueid )(struct ast_channel *chan)
 Get the unique identifier for the PVT, i.e. SIP call-ID for SIP.
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_text )(struct ast_channel *chan, struct ast_frame *frame)
 Write a text frame, in standard format.
int(*const write_video )(struct ast_channel *chan, struct ast_frame *frame)
 Write a frame, in standard format.

Detailed Description

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 243 of file channel.h.


Field Documentation

int(* const answer)(struct ast_channel *chan)

Answer the channel.

Referenced by ast_raw_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(), destroy_conference_bridge(), and play_sound_file().

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().

Bitmap of formats this channel can handle

Definition at line 247 of file channel.h.

Referenced by ast_request(), handle_cli_core_show_channeltype(), and load_module().

const char* const description

int(* const devicestate)(void *data)

enum ast_bridge_result(* const early_bridge)(struct ast_channel *c0, struct ast_channel *c1)

Bridge two channels of the same type together (early).

Referenced by ast_channel_early_bridge().

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, const 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, const 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().

const char*(* get_pvt_uniqueid)(struct ast_channel *chan)

Get the unique identifier for the PVT, i.e. SIP call-ID for SIP.

Referenced by update_bridge_vars().

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_var_channel_types_table(), ast_write(), handle_cli_core_show_channeltype(), and handle_cli_core_show_channeltypes().

Technology Properties

Definition at line 249 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.

Referenced by ast_channel_queryoption().

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.

Note:
The channel is not locked when this function gets called.

Referenced by ast_channel_bridge(), ast_rtp_bridge(), ast_senddigit(), ast_senddigit_begin(), handle_cli_core_show_channeltype(), and load_module().

int(* const send_digit_end)(struct ast_channel *chan, char digit, unsigned int duration)

Stop sending a literal DTMF digit.

Note:
The channel is not locked when this function gets called.

Referenced by ast_senddigit_end(), and handle_cli_core_show_channeltype().

int(* const send_html)(struct ast_channel *chan, int subclass, const char *data, int len)

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(), and handle_cli_core_show_channeltype().

int(* const send_text)(struct ast_channel *chan, const char *text)

Display or transmit text.

Referenced by ast_sendtext(), ast_write(), handle_cli_core_show_channeltype(), and sendtext_exec().

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)

const char* const type

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_text)(struct ast_channel *chan, struct ast_frame *frame)

Write a text frame, in standard format.

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().


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

Generated on Thu Oct 11 06:50:14 2012 for Asterisk - the Open Source PBX by  doxygen 1.5.6