ADSI Support (built upon Caller*ID) More...

#include "asterisk/callerid.h"

Include dependency graph for adsi.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	adsi_funcs

Macros
ADSI parameters
#define	ADSI_BACKSPACE 0x89 /* Erase last collected digit */

#define	ADSI_BLANK 0x86 /* Blank (does nothing) */

#define	ADSI_CLEAR_CALL_B 0x95 /* Clear specified call buffer */

#define	ADSI_CLEAR_CALL_BUF 145

#define	ADSI_CLEAR_CHARS 0x88 /* Clear characters/digits collected */

#define	ADSI_CLEAR_SCREEN 148

#define	ADSI_CLEAR_SOFTKEY 136

#define	ADSI_CLEAR_TYPE_AHEAD 143

#define	ADSI_COMM_PAGE 0x1

#define	ADSI_CONNECT_SESSION 142

#define	ADSI_DELAY 0x90 /* Delay for given # (times 10) of ms */

#define	ADSI_DIAL_PULSE_ONE 0x91 /* Send a dial pulse "1" */

#define	ADSI_DIAL_TONE_DETECT 0x84 /* Wait for dialtone */

#define	ADSI_DIR_FROM_LEFT (0)

#define	ADSI_DIR_FROM_RIGHT (1)

#define	ADSI_DISC_SESSION 133

#define	ADSI_DISP_CALL_BUF 0x94 /* Display specified call buffer */

#define	ADSI_DISPLAY_CALL_BUF 144

#define	ADSI_DOWNLOAD_CONNECT 131

#define	ADSI_DOWNLOAD_DISC 132

#define	ADSI_ENCODED_DTMF 0x80 /* Transmit following chars with encoded dtmf */

#define	ADSI_EXTENDED_DTMF 0x8F /* Send DTMF tones for 250ms instead of 60 ms */

#define	ADSI_FLASH 0x83 /* Flash switch-hook */

#define	ADSI_GOTO_LINE 0x8B /* Go to given page and line number */

#define	ADSI_GOTO_LINE_REL 0x8C /* Go to given line (relative to current) */

#define	ADSI_INFO_PAGE 0x0

#define	ADSI_INFORMATION 132

#define	ADSI_INIT_SOFTKEY_LINE 129

#define	ADSI_INPUT_CONTROL 137

#define	ADSI_INPUT_FORMAT 138

#define	ADSI_JUST_CENT 0x0 /* Center */

#define	ADSI_JUST_IND 0x3 /* Indent */

#define	ADSI_JUST_LEFT 0x2

#define	ADSI_JUST_RIGHT 0x1

#define	ADSI_KEY_APPS 16 /* 16 to 33 reserved for applications */

#define	ADSI_KEY_HILITE 0x40 /* Highlight key */

#define	ADSI_KEY_SKT 0x80 /* Load from SKT */

#define	ADSI_LINE_CONTROL 131

#define	ADSI_LINE_NUMBER 0x85 /* Send current line number using DTMF/encoded DTMF */

#define	ADSI_LOAD_DEFAULT 141

#define	ADSI_LOAD_PREDEF_DISP 129 /* Load predefined display */

#define	ADSI_LOAD_SCRIPT 130

#define	ADSI_LOAD_SOFTKEY 128

#define	ADSI_LOAD_SOFTKEY_TABLE 128 /* Conveniently identical to the soft version */

#define	ADSI_LOAD_VIRTUAL_DISP 130

#define	ADSI_MOVE_DATA 140

#define	ADSI_MSG_DISPLAY 132

#define	ADSI_MSG_DOWNLOAD 133

#define	ADSI_OFF_HOOK 0x82 /* Close switch-hook */

#define	ADSI_ON_HOOK 0x81 /* Open switch-hook */

#define	ADSI_PAGE_DOWN 0x8E /* Go down one page */

#define	ADSI_PAGE_UP 0x8D /* Go up one page */

#define	ADSI_QUERY_CONFIG 149

#define	ADSI_QUERY_CPEID 150

#define	ADSI_SEND_CHARS 0x87 /* Send collected digits/characters */

#define	ADSI_SWITCH_TO_ALT 146

#define	ADSI_SWITCH_TO_APP 151

#define	ADSI_SWITCH_TO_DATA 134

#define	ADSI_SWITCH_TO_DATA2 0x92 /* Switch CPE to data mode */

#define	ADSI_SWITCH_TO_GRAPHICS 147

#define	ADSI_SWITCH_TO_PERIPH 139

#define	ADSI_SWITCH_TO_VOICE 135

#define	ADSI_SWITCH_TO_VOICE2 0x93 /* Switch CPE to voice mode */

#define	ADSI_TAB_COLUMN 0x8A /* Display specified display column of current line */

#define	AST_ADSI_VERSION 1

Functions
int	ast_adsi_available (struct ast_channel *chan)
	Returns non-zero if Channel does or might support ADSI.

int	ast_adsi_begin_download (struct ast_channel chan, char service, unsigned char fdn, unsigned char sec, int version)

int	ast_adsi_channel_restore (struct ast_channel *chan)

int	ast_adsi_clear_screen (unsigned char *buf)

int	ast_adsi_clear_soft_keys (unsigned char *buf)

int	ast_adsi_connect_session (unsigned char buf, unsigned char fdn, int ver)
	Connects an ADSI Display Session.

int	ast_adsi_data_mode (unsigned char *buf)
	Puts CPE in data mode.

int	ast_adsi_disconnect_session (unsigned char *buf)
	Disconnects a running session.

int	ast_adsi_display (unsigned char buf, int page, int line, int just, int wrap, char col1, char *col2)
	Loads a line of info into the display.

int	ast_adsi_download_connect (unsigned char buf, char service, unsigned char fdn, unsigned char sec, int ver)
	Begin an ADSI script download.

int	ast_adsi_download_disconnect (unsigned char *buf)
	Disconnects (and hopefully saves) a downloaded script.

int	ast_adsi_end_download (struct ast_channel *chan)

int	ast_adsi_get_cpeid (struct ast_channel chan, unsigned char cpeid, int voice)

int	ast_adsi_get_cpeinfo (struct ast_channel chan, int width, int height, int buttons, int voice)

int	ast_adsi_input_control (unsigned char *buf, int page, int line, int display, int format, int just)
	Set input information.

int	ast_adsi_input_format (unsigned char buf, int num, int dir, int wrap, char format1, char *format2)
	Set input format.

void	ast_adsi_install_funcs (const struct adsi_funcs *funcs)

int	ast_adsi_load_session (struct ast_channel chan, unsigned char app, int ver, int data)
	Check if scripts for a given app are already loaded. Version may be -1, if any version is okay, or 0-255 for a specific version.

int	ast_adsi_load_soft_key (unsigned char buf, int key, const char llabel, const char slabel, char ret, int data)
	Creates "load soft key" parameters.

int	ast_adsi_print (struct ast_channel chan, char lines, int align, int voice)
	Display some stuff on the screen.

int	ast_adsi_query_cpeid (unsigned char *buf)

int	ast_adsi_query_cpeinfo (unsigned char *buf)

int	ast_adsi_read_encoded_dtmf (struct ast_channel chan, unsigned char buf, int maxlen)

int	ast_adsi_set_keys (unsigned char buf, unsigned char keys)
	Set which soft keys should be displayed.

int	ast_adsi_set_line (unsigned char *buf, int page, int line)
	Sets the current line and page.

int	ast_adsi_transmit_message (struct ast_channel chan, unsigned char msg, int msglen, int msgtype)

int	ast_adsi_transmit_message_full (struct ast_channel chan, unsigned char msg, int msglen, int msgtype, int dowait)

int	ast_adsi_unload_session (struct ast_channel *chan)

int	ast_adsi_voice_mode (unsigned char *buf, int when)
	Puts CPE in voice mode.

Detailed Description

ADSI Support (built upon Caller*ID)

Definition in file adsi.h.

Macro Definition Documentation

◆ ADSI_BACKSPACE

#define ADSI_BACKSPACE 0x89 /* Erase last collected digit */

Definition at line 78 of file adsi.h.

◆ ADSI_BLANK

#define ADSI_BLANK 0x86 /* Blank (does nothing) */

Definition at line 75 of file adsi.h.

◆ ADSI_CLEAR_CALL_B

#define ADSI_CLEAR_CALL_B 0x95 /* Clear specified call buffer */

Definition at line 90 of file adsi.h.

◆ ADSI_CLEAR_CALL_BUF

#define ADSI_CLEAR_CALL_BUF 145

Definition at line 53 of file adsi.h.

◆ ADSI_CLEAR_CHARS

#define ADSI_CLEAR_CHARS 0x88 /* Clear characters/digits collected */

Definition at line 77 of file adsi.h.

◆ ADSI_CLEAR_SCREEN

#define ADSI_CLEAR_SCREEN 148

Definition at line 56 of file adsi.h.

◆ ADSI_CLEAR_SOFTKEY

#define ADSI_CLEAR_SOFTKEY 136

Definition at line 44 of file adsi.h.

◆ ADSI_CLEAR_TYPE_AHEAD

#define ADSI_CLEAR_TYPE_AHEAD 143

Definition at line 51 of file adsi.h.

◆ ADSI_COMM_PAGE

#define ADSI_COMM_PAGE 0x1

Definition at line 107 of file adsi.h.

◆ ADSI_CONNECT_SESSION

#define ADSI_CONNECT_SESSION 142

Definition at line 50 of file adsi.h.

◆ ADSI_DELAY

#define ADSI_DELAY 0x90 /* Delay for given # (times 10) of ms */

Definition at line 85 of file adsi.h.

◆ ADSI_DIAL_PULSE_ONE

#define ADSI_DIAL_PULSE_ONE 0x91 /* Send a dial pulse "1" */

Definition at line 86 of file adsi.h.

◆ ADSI_DIAL_TONE_DETECT

#define ADSI_DIAL_TONE_DETECT 0x84 /* Wait for dialtone */

Definition at line 73 of file adsi.h.

◆ ADSI_DIR_FROM_LEFT

#define ADSI_DIR_FROM_LEFT (0)

Definition at line 120 of file adsi.h.

◆ ADSI_DIR_FROM_RIGHT

#define ADSI_DIR_FROM_RIGHT (1)

Definition at line 121 of file adsi.h.

◆ ADSI_DISC_SESSION

#define ADSI_DISC_SESSION 133

Definition at line 41 of file adsi.h.

◆ ADSI_DISP_CALL_BUF

#define ADSI_DISP_CALL_BUF 0x94 /* Display specified call buffer */

Definition at line 89 of file adsi.h.

◆ ADSI_DISPLAY_CALL_BUF

#define ADSI_DISPLAY_CALL_BUF 144

Definition at line 52 of file adsi.h.

◆ ADSI_DOWNLOAD_CONNECT

#define ADSI_DOWNLOAD_CONNECT 131

Definition at line 65 of file adsi.h.

◆ ADSI_DOWNLOAD_DISC

#define ADSI_DOWNLOAD_DISC 132

Definition at line 66 of file adsi.h.

◆ ADSI_ENCODED_DTMF

#define ADSI_ENCODED_DTMF 0x80 /* Transmit following chars with encoded dtmf */

Definition at line 69 of file adsi.h.

◆ ADSI_EXTENDED_DTMF

#define ADSI_EXTENDED_DTMF 0x8F /* Send DTMF tones for 250ms instead of 60 ms */

Definition at line 84 of file adsi.h.

◆ ADSI_FLASH

#define ADSI_FLASH 0x83 /* Flash switch-hook */

Definition at line 72 of file adsi.h.

◆ ADSI_GOTO_LINE

#define ADSI_GOTO_LINE 0x8B /* Go to given page and line number */

Definition at line 80 of file adsi.h.

◆ ADSI_GOTO_LINE_REL

#define ADSI_GOTO_LINE_REL 0x8C /* Go to given line (relative to current) */

Definition at line 81 of file adsi.h.

◆ ADSI_INFO_PAGE

#define ADSI_INFO_PAGE 0x0

Definition at line 106 of file adsi.h.

◆ ADSI_INFORMATION

#define ADSI_INFORMATION 132

Definition at line 40 of file adsi.h.

◆ ADSI_INIT_SOFTKEY_LINE

#define ADSI_INIT_SOFTKEY_LINE 129

Definition at line 37 of file adsi.h.

◆ ADSI_INPUT_CONTROL

#define ADSI_INPUT_CONTROL 137

Definition at line 45 of file adsi.h.

◆ ADSI_INPUT_FORMAT

#define ADSI_INPUT_FORMAT 138

Definition at line 46 of file adsi.h.

◆ ADSI_JUST_CENT

#define ADSI_JUST_CENT 0x0 /* Center */

Definition at line 114 of file adsi.h.

◆ ADSI_JUST_IND

#define ADSI_JUST_IND 0x3 /* Indent */

Definition at line 115 of file adsi.h.

◆ ADSI_JUST_LEFT

#define ADSI_JUST_LEFT 0x2

Definition at line 112 of file adsi.h.

◆ ADSI_JUST_RIGHT

#define ADSI_JUST_RIGHT 0x1

Definition at line 113 of file adsi.h.

◆ ADSI_KEY_APPS

#define ADSI_KEY_APPS 16 /* 16 to 33 reserved for applications */

Definition at line 109 of file adsi.h.

◆ ADSI_KEY_HILITE

#define ADSI_KEY_HILITE 0x40 /* Highlight key */

Definition at line 118 of file adsi.h.

◆ ADSI_KEY_SKT

#define ADSI_KEY_SKT 0x80 /* Load from SKT */

Definition at line 117 of file adsi.h.

◆ ADSI_LINE_CONTROL

#define ADSI_LINE_CONTROL 131

Definition at line 39 of file adsi.h.

◆ ADSI_LINE_NUMBER

#define ADSI_LINE_NUMBER 0x85 /* Send current line number using DTMF/encoded DTMF */

Definition at line 74 of file adsi.h.

◆ ADSI_LOAD_DEFAULT

#define ADSI_LOAD_DEFAULT 141

Definition at line 49 of file adsi.h.

◆ ADSI_LOAD_PREDEF_DISP

#define ADSI_LOAD_PREDEF_DISP 129 /* Load predefined display */

Definition at line 63 of file adsi.h.

◆ ADSI_LOAD_SCRIPT

#define ADSI_LOAD_SCRIPT 130

Definition at line 64 of file adsi.h.

◆ ADSI_LOAD_SOFTKEY

#define ADSI_LOAD_SOFTKEY 128

Definition at line 36 of file adsi.h.

◆ ADSI_LOAD_SOFTKEY_TABLE

#define ADSI_LOAD_SOFTKEY_TABLE 128 /* Conveniently identical to the soft version */

Definition at line 62 of file adsi.h.

◆ ADSI_LOAD_VIRTUAL_DISP

#define ADSI_LOAD_VIRTUAL_DISP 130

Definition at line 38 of file adsi.h.

◆ ADSI_MOVE_DATA

#define ADSI_MOVE_DATA 140

Definition at line 48 of file adsi.h.

◆ ADSI_MSG_DISPLAY

#define ADSI_MSG_DISPLAY 132

Definition at line 32 of file adsi.h.

◆ ADSI_MSG_DOWNLOAD

#define ADSI_MSG_DOWNLOAD 133

Definition at line 33 of file adsi.h.

◆ ADSI_OFF_HOOK

#define ADSI_OFF_HOOK 0x82 /* Close switch-hook */

Definition at line 71 of file adsi.h.

◆ ADSI_ON_HOOK

#define ADSI_ON_HOOK 0x81 /* Open switch-hook */

Definition at line 70 of file adsi.h.

◆ ADSI_PAGE_DOWN

#define ADSI_PAGE_DOWN 0x8E /* Go down one page */

Definition at line 83 of file adsi.h.

◆ ADSI_PAGE_UP

#define ADSI_PAGE_UP 0x8D /* Go up one page */

Definition at line 82 of file adsi.h.

◆ ADSI_QUERY_CONFIG

#define ADSI_QUERY_CONFIG 149

Definition at line 57 of file adsi.h.

◆ ADSI_QUERY_CPEID

#define ADSI_QUERY_CPEID 150

Definition at line 58 of file adsi.h.

◆ ADSI_SEND_CHARS

#define ADSI_SEND_CHARS 0x87 /* Send collected digits/characters */

Definition at line 76 of file adsi.h.

◆ ADSI_SWITCH_TO_ALT

#define ADSI_SWITCH_TO_ALT 146

Definition at line 54 of file adsi.h.

◆ ADSI_SWITCH_TO_APP

#define ADSI_SWITCH_TO_APP 151

Definition at line 59 of file adsi.h.

◆ ADSI_SWITCH_TO_DATA

#define ADSI_SWITCH_TO_DATA 134

Definition at line 42 of file adsi.h.

◆ ADSI_SWITCH_TO_DATA2

#define ADSI_SWITCH_TO_DATA2 0x92 /* Switch CPE to data mode */

Definition at line 87 of file adsi.h.

◆ ADSI_SWITCH_TO_GRAPHICS

#define ADSI_SWITCH_TO_GRAPHICS 147

Definition at line 55 of file adsi.h.

◆ ADSI_SWITCH_TO_PERIPH

#define ADSI_SWITCH_TO_PERIPH 139

Definition at line 47 of file adsi.h.

◆ ADSI_SWITCH_TO_VOICE

#define ADSI_SWITCH_TO_VOICE 135

Definition at line 43 of file adsi.h.

◆ ADSI_SWITCH_TO_VOICE2

#define ADSI_SWITCH_TO_VOICE2 0x93 /* Switch CPE to voice mode */

Definition at line 88 of file adsi.h.

◆ ADSI_TAB_COLUMN

#define ADSI_TAB_COLUMN 0x8A /* Display specified display column of current line */

Definition at line 79 of file adsi.h.

◆ AST_ADSI_VERSION

#define AST_ADSI_VERSION 1

Definition at line 123 of file adsi.h.

Function Documentation

◆ ast_adsi_available()

int ast_adsi_available ( struct ast_channel * chan )

Returns non-zero if Channel does or might support ADSI.

Parameters

chan	Channel to check

Definition at line 263 of file adsi.c.

{
    int res = 0;
    ast_rwlock_rdlock(&func_lock);
    if (installed_funcs && installed_funcs->available) {
        res = installed_funcs->available(chan);
    }
    ast_rwlock_unlock(&func_lock);
    return res;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, adsi_funcs::available, func_lock, and installed_funcs.

Referenced by adsi_begin(), adsi_delete(), adsi_exec(), adsi_folders(), adsi_goodbye(), adsi_login(), adsi_message(), adsi_password(), adsi_status(), adsi_status2(), AST_TEST_DEFINE(), directory_exec(), vm_newuser_setup(), vm_options(), and vm_tempgreeting().

◆ ast_adsi_begin_download()

int ast_adsi_begin_download	(	struct ast_channel *	chan,
		char *	service,
		unsigned char *	fdn,
		unsigned char *	sec,
		int	version
	)

Definition at line 32 of file adsi.c.

{
    int res = 0;
    ast_rwlock_rdlock(&func_lock);
    if (installed_funcs && installed_funcs->begin_download) {
        res = installed_funcs->begin_download(chan, service, fdn, sec, version);
    }
    ast_rwlock_unlock(&func_lock);
    return res;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, adsi_funcs::begin_download, func_lock, installed_funcs, service, and version.

Referenced by adsi_load_vmail(), and adsi_prog().

◆ ast_adsi_channel_restore()

int ast_adsi_channel_restore ( struct ast_channel * chan )

Restore ADSI initialization (for applications that play with ADSI and want to restore it to normal. If you touch "INFO" then you have to use the ast_adsi_channel_init again instead.

Parameters

chan	Channel to restore

Return values

0	on success (or adsi unavailable)
-1	on hangup

Definition at line 54 of file adsi.c.

{
    int res = 0;
    ast_rwlock_rdlock(&func_lock);
    if (installed_funcs && installed_funcs->channel_restore) {
        res = installed_funcs->channel_restore(chan);
    }
    ast_rwlock_unlock(&func_lock);
    return res;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, adsi_funcs::channel_restore, func_lock, and installed_funcs.

◆ ast_adsi_clear_screen()

int ast_adsi_clear_screen ( unsigned char * buf )

Definition at line 241 of file adsi.c.

{
    int res = 0;
    ast_rwlock_rdlock(&func_lock);
    if (installed_funcs && installed_funcs->clear_screen) {
        res = installed_funcs->clear_screen(buf);
    }
    ast_rwlock_unlock(&func_lock);
    return res;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, buf, adsi_funcs::clear_screen, func_lock, and installed_funcs.

◆ ast_adsi_clear_soft_keys()

int ast_adsi_clear_soft_keys ( unsigned char * buf )

Definition at line 230 of file adsi.c.

{
    int res = 0;
    ast_rwlock_rdlock(&func_lock);
    if (installed_funcs && installed_funcs->clear_soft_keys) {
        res = installed_funcs->clear_soft_keys(buf);
    }
    ast_rwlock_unlock(&func_lock);
    return res;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, buf, adsi_funcs::clear_soft_keys, func_lock, and installed_funcs.

◆ ast_adsi_connect_session()

int ast_adsi_connect_session	(	unsigned char *	buf,
		unsigned char *	fdn,
		int	ver
	)

Connects an ADSI Display Session.

Parameters

buf	Character buffer to create parameter in (must have at least 256 free)
fdn	Optional 4 byte Feature Download Number (for loading soft keys)
ver	Optional version number (0-255, or -1 to omit)

Return values

number	of bytes added to buffer
-1	on error.

Definition at line 131 of file adsi.c.

{
    int res = 0;
    ast_rwlock_rdlock(&func_lock);
    if (installed_funcs && installed_funcs->connect_session) {
        res = installed_funcs->connect_session(buf, fdn, ver);
    }
    ast_rwlock_unlock(&func_lock);
    return res;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, buf, adsi_funcs::connect_session, func_lock, and installed_funcs.

◆ ast_adsi_data_mode()

int ast_adsi_data_mode ( unsigned char * buf )

Puts CPE in data mode.

Parameters

buf	Character buffer to create parameter in (must have at least 256 free)

Return values

number	of bytes added to buffer
-1	on error.

Definition at line 219 of file adsi.c.

{
    int res = 0;
    ast_rwlock_rdlock(&func_lock);
    if (installed_funcs && installed_funcs->data_mode) {
        res = installed_funcs->data_mode(buf);
    }
    ast_rwlock_unlock(&func_lock);
    return res;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, buf, adsi_funcs::data_mode, func_lock, and installed_funcs.

Referenced by adsi_load_vmail().

◆ ast_adsi_disconnect_session()

int ast_adsi_disconnect_session ( unsigned char * buf )

Disconnects a running session.

Parameters

buf	Character buffer to create parameter in (must have at least 256 free)

Return values

number	of bytes added to buffer
-1	on error.

Definition at line 197 of file adsi.c.

{
    int res = 0;
    ast_rwlock_rdlock(&func_lock);
    if (installed_funcs && installed_funcs->disconnect_session) {
        res = installed_funcs->disconnect_session(buf);
    }
    ast_rwlock_unlock(&func_lock);
    return res;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, buf, adsi_funcs::disconnect_session, func_lock, and installed_funcs.

◆ ast_adsi_display()

int ast_adsi_display	(	unsigned char *	buf,
		int	page,
		int	line,
		int	just,
		int	wrap,
		char *	col1,
		char *	col2
	)

Loads a line of info into the display.

Parameters

buf	Character buffer to create parameter in (must have at least 256 free)
page	Page to load (ADSI_COMM_PAGE or ADSI_INFO_PAGE)
line	Line number to load (1-4 for Comm page, 1-33 for info page)
just	Line justification (ADSI_JUST_LEFT, ADSI_JUST_RIGHT, ADSI_JUST_CENT, ADSI_JUST_IND)
wrap	Wrap (1 = yes, 0 = no)
col1	Text to place in first column
col2	Text to place in second column

Return values

number	of bytes added to buffer
-1	on error.

Definition at line 274 of file adsi.c.

{
    int res = 0;
    ast_rwlock_rdlock(&func_lock);
    if (installed_funcs && installed_funcs->display) {
        res = installed_funcs->display(buf, page, line, just, wrap, col1, col2);
    }
    ast_rwlock_unlock(&func_lock);
    return res;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, buf, adsi_funcs::display, func_lock, and installed_funcs.

Referenced by adsi_confirm_match(), adsi_folders(), adsi_goodbye(), adsi_load_vmail(), adsi_login(), adsi_logo(), adsi_message(), adsi_prog(), adsi_search_input(), adsi_status(), adsi_status2(), vm_newuser_setup(), vm_options(), and vm_tempgreeting().

◆ ast_adsi_download_connect()

int ast_adsi_download_connect	(	unsigned char *	buf,
		char *	service,
		unsigned char *	fdn,
		unsigned char *	sec,
		int	ver
	)

Begin an ADSI script download.

Parameters

buf	Character buffer to create parameter in (must have at least 256 free)
service	a 1-18 byte name of the feature
fdn	4 byte Feature Download Number (for loading soft keys)
sec	4 byte vendor security code
ver	version number (0-255, or -1 to omit)

Return values

number	of bytes added to buffer
-1	on error.

Definition at line 186 of file adsi.c.

{
    int res = 0;
    ast_rwlock_rdlock(&func_lock);
    if (installed_funcs && installed_funcs->download_connect) {
        res = installed_funcs->download_connect(buf, service, fdn, sec, ver);
    }
    ast_rwlock_unlock(&func_lock);
    return res;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, buf, adsi_funcs::download_connect, func_lock, installed_funcs, and service.

◆ ast_adsi_download_disconnect()

int ast_adsi_download_disconnect ( unsigned char * buf )

Disconnects (and hopefully saves) a downloaded script.

Parameters

buf	Character buffer to create parameter in (must have at least 256 free)

Return values

number	of bytes added to buffer
-1	on error.

Definition at line 208 of file adsi.c.

{
    int res = 0;
    ast_rwlock_rdlock(&func_lock);
    if (installed_funcs && installed_funcs->download_disconnect) {
        res = installed_funcs->download_disconnect(buf);
    }
    ast_rwlock_unlock(&func_lock);
    return res;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, buf, adsi_funcs::download_disconnect, func_lock, and installed_funcs.

Referenced by adsi_load_vmail().

◆ ast_adsi_end_download()

int ast_adsi_end_download ( struct ast_channel * chan )

Definition at line 43 of file adsi.c.

{
    int res = 0;
    ast_rwlock_rdlock(&func_lock);
    if (installed_funcs && installed_funcs->end_download) {
        res = installed_funcs->end_download(chan);
    }
    ast_rwlock_unlock(&func_lock);
    return res;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, adsi_funcs::end_download, func_lock, and installed_funcs.

Referenced by adsi_load_vmail(), and adsi_prog().

◆ ast_adsi_get_cpeid()

int ast_adsi_get_cpeid	(	struct ast_channel *	chan,
		unsigned char *	cpeid,
		int	voice
	)

Get CPE ID from an attached ADSI compatible CPE. Returns 1 on success, storing 4 bytes of CPE ID at buf or -1 on hangup, or 0 if there was no hangup but it failed to find the device ID. Returns to voice mode if "voice" is non-zero.

Definition at line 164 of file adsi.c.

{
    int res = 0;
    ast_rwlock_rdlock(&func_lock);
    if (installed_funcs && installed_funcs->get_cpeid) {
        res = installed_funcs->get_cpeid(chan, cpeid, voice);
    }
    ast_rwlock_unlock(&func_lock);
    return res;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, func_lock, adsi_funcs::get_cpeid, and installed_funcs.

Referenced by cpeid_exec().

◆ ast_adsi_get_cpeinfo()

int ast_adsi_get_cpeinfo	(	struct ast_channel *	chan,
		int *	width,
		int *	height,
		int *	buttons,
		int	voice
	)

Definition at line 175 of file adsi.c.

{
    int res = 0;
    ast_rwlock_rdlock(&func_lock);
    if (installed_funcs && installed_funcs->get_cpeinfo) {
        res = installed_funcs->get_cpeinfo(chan, width, height, buttons, voice);
    }
    ast_rwlock_unlock(&func_lock);
    return res;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, func_lock, adsi_funcs::get_cpeinfo, and installed_funcs.

Referenced by cpeid_exec().

◆ ast_adsi_input_control()

int ast_adsi_input_control	(	unsigned char *	buf,
		int	page,
		int	line,
		int	display,
		int	format,
		int	just
	)

Set input information.

Parameters

buf	Character buffer to create parameter in (must have at least 256 free)
page	Which page to input on (ADSI_COMM_PAGE or ADSI_INFO_PAGE)
line	Line number to input on
display	Set to zero to obscure input, or 1 to leave visible
format	Format number to use (0-7)
just	Justification (left, right center, indent)

Return values

number	of bytes added to buffer
-1	on error.

Definition at line 318 of file adsi.c.

{
    int res = 0;
    ast_rwlock_rdlock(&func_lock);
    if (installed_funcs && installed_funcs->input_control) {
        res = installed_funcs->input_control(buf, page, line, display, format, just);
    }
    ast_rwlock_unlock(&func_lock);
    return res;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, buf, adsi_funcs::display, func_lock, adsi_funcs::input_control, and installed_funcs.

Referenced by adsi_login(), adsi_password(), and adsi_search_input().

◆ ast_adsi_input_format()

int ast_adsi_input_format	(	unsigned char *	buf,
		int	num,
		int	dir,
		int	wrap,
		char *	format1,
		char *	format2
	)

Set input format.

Parameters

buf	Character buffer to create parameter in (must have at least 256 free)
num	Which format we are setting
dir	Which direction (ADSI_DIR_FROM_LEFT or ADSI_DIR_FROM_RIGHT)
wrap	Set to 1 to permit line wrap, or 0 if not
format1	Format for column 1
format2	Format for column 2

Return values

number	of bytes added to buffer
-1	on error.

Definition at line 329 of file adsi.c.

{
    int res = 0;
    ast_rwlock_rdlock(&func_lock);
    if (installed_funcs && installed_funcs->input_format) {
        res = installed_funcs->input_format(buf, num, dir, wrap, format1, format2);
    }
    ast_rwlock_unlock(&func_lock);
    return res;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, buf, func_lock, adsi_funcs::input_format, and installed_funcs.

Referenced by adsi_login(), adsi_password(), and adsi_search_input().

◆ ast_adsi_install_funcs()

void ast_adsi_install_funcs ( const struct adsi_funcs * funcs )

Definition at line 340 of file adsi.c.

{
    if (funcs && funcs->version < current_adsi_version) {
        ast_log(LOG_WARNING, "Cannot install ADSI function pointers due to version mismatch."
                "Ours: %d, Theirs: %u\n", current_adsi_version, funcs->version);
        return;
    }
 
    ast_rwlock_wrlock(&func_lock);
    installed_funcs = funcs;
    ast_rwlock_unlock(&func_lock);
}

References ast_log, ast_rwlock_unlock, ast_rwlock_wrlock, current_adsi_version, func_lock, installed_funcs, LOG_WARNING, and adsi_funcs::version.

Referenced by load_module(), and unload_module().

◆ ast_adsi_load_session()

int ast_adsi_load_session	(	struct ast_channel *	chan,
		unsigned char *	app,
		int	ver,
		int	data
	)

Check if scripts for a given app are already loaded. Version may be -1, if any version is okay, or 0-255 for a specific version.

Parameters

chan	Channel to test for loaded app
app	Four character app name (must be unique to your application)
ver	optional version number
data	Non-zero if you want to be put in data mode

Return values

0	if scripts is not loaded or not an ADSI CPE
-1	on hangup
1	if script already loaded.

Definition at line 76 of file adsi.c.

{
    int res = 0;
    ast_rwlock_rdlock(&func_lock);
    if (installed_funcs && installed_funcs->load_session) {
        res = installed_funcs->load_session(chan, app, ver, data);
    }
    ast_rwlock_unlock(&func_lock);
    return res;
}

References app, ast_rwlock_rdlock, ast_rwlock_unlock, func_lock, installed_funcs, and adsi_funcs::load_session.

Referenced by adsi_begin(), adsi_load_vmail(), adsi_prog(), cpeid_exec(), and directory_exec().

◆ ast_adsi_load_soft_key()

int ast_adsi_load_soft_key	(	unsigned char *	buf,
		int	key,
		const char *	llabel,
		const char *	slabel,
		char *	ret,
		int	data
	)

Creates "load soft key" parameters.

Parameters

buf	Character buffer to create parameter in (must have at least 256 free)
key	Key code from 2 to 33, for which key we are loading
llabel	Long label for key (1-18 bytes)
slabel	Short label for key (1-7 bytes)
ret	Optional return sequence (NULL for none)
data	whether to put CPE in data mode before sending digits

Return values

number	of bytes added to buffer
-1	on error.

Definition at line 296 of file adsi.c.

{
    int res = 0;
    ast_rwlock_rdlock(&func_lock);
    if (installed_funcs && installed_funcs->load_soft_key) {
        res = installed_funcs->load_soft_key(buf, key, llabel, slabel, ret, data);
    }
    ast_rwlock_unlock(&func_lock);
    return res;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, buf, func_lock, installed_funcs, and adsi_funcs::load_soft_key.

Referenced by adsi_confirm_match(), adsi_load_vmail(), adsi_login(), and adsi_search_input().

◆ ast_adsi_print()

int ast_adsi_print	(	struct ast_channel *	chan,
		char **	lines,
		int *	align,
		int	voice
	)

Display some stuff on the screen.

Parameters

chan	Channel to display on
lines	NULL-terminated list of things to print (no more than 4 recommended)
align	list of alignments to use (ADSI_JUST_LEFT, ADSI_JUST_RIGHT, ADSI_JUST_CEN, etc..)
voice	whether to jump into voice mode when finished

Return values

0	on success (or adsi unavailable)
-1	on hangup

Definition at line 65 of file adsi.c.

{
    int res = 0;
    ast_rwlock_rdlock(&func_lock);
    if (installed_funcs && installed_funcs->print) {
        res = installed_funcs->print(chan, lines, align, voice);
    }
    ast_rwlock_unlock(&func_lock);
    return res;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, func_lock, installed_funcs, and adsi_funcs::print.

Referenced by cpeid_setstatus().

◆ ast_adsi_query_cpeid()

int ast_adsi_query_cpeid ( unsigned char * buf )

Build Query CPE ID of equipment. Returns number of bytes added to message

Definition at line 142 of file adsi.c.

{
    int res = 0;
    ast_rwlock_rdlock(&func_lock);
    if (installed_funcs && installed_funcs->query_cpeid) {
        res = installed_funcs->query_cpeid(buf);
    }
    ast_rwlock_unlock(&func_lock);
    return res;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, buf, func_lock, installed_funcs, and adsi_funcs::query_cpeid.

◆ ast_adsi_query_cpeinfo()

int ast_adsi_query_cpeinfo ( unsigned char * buf )

Definition at line 153 of file adsi.c.

{
    int res = 0;
    ast_rwlock_rdlock(&func_lock);
    if (installed_funcs && installed_funcs->query_cpeinfo) {
        res = installed_funcs->query_cpeinfo(buf);
    }
    ast_rwlock_unlock(&func_lock);
    return res;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, buf, func_lock, installed_funcs, and adsi_funcs::query_cpeinfo.

◆ ast_adsi_read_encoded_dtmf()

int ast_adsi_read_encoded_dtmf	(	struct ast_channel *	chan,
		unsigned char *	buf,
		int	maxlen
	)

Read some encoded DTMF data. Returns number of bytes received

Definition at line 120 of file adsi.c.

{
    int res = 0;
    ast_rwlock_rdlock(&func_lock);
    if (installed_funcs && installed_funcs->read_encoded_dtmf) {
        res = installed_funcs->read_encoded_dtmf(chan, buf, maxlen);
    }
    ast_rwlock_unlock(&func_lock);
    return res;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, buf, func_lock, installed_funcs, and adsi_funcs::read_encoded_dtmf.

◆ ast_adsi_set_keys()

int ast_adsi_set_keys	(	unsigned char *	buf,
		unsigned char *	keys
	)

Set which soft keys should be displayed.

Parameters

buf	Character buffer to create parameter in (must have at least 256 free)
keys	Array of 8 unsigned chars with the key numbers, may be OR'd with ADSI_KEY_HILITE But remember, the last two keys aren't real keys, they're for scrolling

Return values

number	of bytes added to buffer
-1	on error.

Definition at line 307 of file adsi.c.

{
    int res = 0;
    ast_rwlock_rdlock(&func_lock);
    if (installed_funcs && installed_funcs->set_keys) {
        res = installed_funcs->set_keys(buf, keys);
    }
    ast_rwlock_unlock(&func_lock);
    return res;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, buf, func_lock, installed_funcs, and adsi_funcs::set_keys.

Referenced by adsi_confirm_match(), adsi_delete(), adsi_folders(), adsi_login(), adsi_message(), adsi_password(), adsi_search_input(), adsi_status(), and adsi_status2().

◆ ast_adsi_set_line()

int ast_adsi_set_line	(	unsigned char *	buf,
		int	page,
		int	line
	)

Sets the current line and page.

Parameters

buf	Character buffer to create parameter in (must have at least 256 free)
page	Which page (ADSI_COMM_PAGE or ADSI_INFO_PAGE)
line	Line number (1-33 for info page, 1-4 for comm page)

Return values

number	of bytes added to buffer
-1	on error.

Definition at line 285 of file adsi.c.

{
    int res = 0;
    ast_rwlock_rdlock(&func_lock);
    if (installed_funcs && installed_funcs->set_line) {
        res = installed_funcs->set_line(buf, page, line);
    }
    ast_rwlock_unlock(&func_lock);
    return res;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, buf, func_lock, installed_funcs, and adsi_funcs::set_line.

Referenced by adsi_confirm_match(), adsi_folders(), adsi_goodbye(), adsi_load_vmail(), adsi_login(), adsi_message(), adsi_password(), adsi_prog(), adsi_search_input(), adsi_status(), adsi_status2(), vm_newuser_setup(), vm_options(), and vm_tempgreeting().

◆ ast_adsi_transmit_message()

int ast_adsi_transmit_message	(	struct ast_channel *	chan,
		unsigned char *	msg,
		int	msglen,
		int	msgtype
	)

Definition at line 98 of file adsi.c.

{
    int res = 0;
    ast_rwlock_rdlock(&func_lock);
    if (installed_funcs && installed_funcs->transmit_message) {
        res = installed_funcs->transmit_message(chan, msg, msglen, msgtype);
    }
    ast_rwlock_unlock(&func_lock);
    return res;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, func_lock, installed_funcs, and adsi_funcs::transmit_message.

Referenced by adsi_confirm_match(), adsi_delete(), adsi_folders(), adsi_goodbye(), adsi_load_vmail(), adsi_login(), adsi_message(), adsi_password(), adsi_prog(), adsi_search_input(), adsi_status(), adsi_status2(), vm_newuser_setup(), vm_options(), and vm_tempgreeting().

◆ ast_adsi_transmit_message_full()

int ast_adsi_transmit_message_full	(	struct ast_channel *	chan,
		unsigned char *	msg,
		int	msglen,
		int	msgtype,
		int	dowait
	)

Definition at line 109 of file adsi.c.

{
    int res = 0;
    ast_rwlock_rdlock(&func_lock);
    if (installed_funcs && installed_funcs->transmit_message_full) {
        res = installed_funcs->transmit_message_full(chan, msg, msglen, msgtype, dowait);
    }
    ast_rwlock_unlock(&func_lock);
    return res;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, func_lock, installed_funcs, and adsi_funcs::transmit_message_full.

◆ ast_adsi_unload_session()

int ast_adsi_unload_session ( struct ast_channel * chan )

Definition at line 87 of file adsi.c.

{
    int res = 0;
    ast_rwlock_rdlock(&func_lock);
    if (installed_funcs && installed_funcs->unload_session) {
        res = installed_funcs->unload_session(chan);
    }
    ast_rwlock_unlock(&func_lock);
    return res;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, func_lock, installed_funcs, and adsi_funcs::unload_session.

Referenced by adsi_prog(), cpeid_exec(), and vm_execmain().

◆ ast_adsi_voice_mode()

int ast_adsi_voice_mode	(	unsigned char *	buf,
		int	when
	)

Puts CPE in voice mode.

Parameters

buf	Character buffer to create parameter in (must have at least 256 free)
when	(a time in seconds) to make the switch

Return values

number	of bytes added to buffer
-1	on error.

Definition at line 252 of file adsi.c.

{
    int res = 0;
    ast_rwlock_rdlock(&func_lock);
    if (installed_funcs && installed_funcs->voice_mode) {
        res = installed_funcs->voice_mode(buf, when);
    }
    ast_rwlock_unlock(&func_lock);
    return res;
}

References ast_rwlock_rdlock, ast_rwlock_unlock, buf, func_lock, installed_funcs, and adsi_funcs::voice_mode.

Referenced by adsi_confirm_match(), adsi_delete(), adsi_folders(), adsi_goodbye(), adsi_load_vmail(), adsi_login(), adsi_message(), adsi_password(), adsi_search_input(), adsi_status(), adsi_status2(), vm_newuser_setup(), vm_options(), and vm_tempgreeting().

Data Structures

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ ADSI_BACKSPACE

◆ ADSI_BLANK

◆ ADSI_CLEAR_CALL_B

◆ ADSI_CLEAR_CALL_BUF

◆ ADSI_CLEAR_CHARS

◆ ADSI_CLEAR_SCREEN

◆ ADSI_CLEAR_SOFTKEY

◆ ADSI_CLEAR_TYPE_AHEAD

◆ ADSI_COMM_PAGE

◆ ADSI_CONNECT_SESSION

◆ ADSI_DELAY

◆ ADSI_DIAL_PULSE_ONE

◆ ADSI_DIAL_TONE_DETECT

◆ ADSI_DIR_FROM_LEFT

◆ ADSI_DIR_FROM_RIGHT

◆ ADSI_DISC_SESSION

◆ ADSI_DISP_CALL_BUF

◆ ADSI_DISPLAY_CALL_BUF

◆ ADSI_DOWNLOAD_CONNECT

◆ ADSI_DOWNLOAD_DISC

◆ ADSI_ENCODED_DTMF

◆ ADSI_EXTENDED_DTMF

◆ ADSI_FLASH

◆ ADSI_GOTO_LINE

◆ ADSI_GOTO_LINE_REL

◆ ADSI_INFO_PAGE

◆ ADSI_INFORMATION

◆ ADSI_INIT_SOFTKEY_LINE

◆ ADSI_INPUT_CONTROL

◆ ADSI_INPUT_FORMAT

◆ ADSI_JUST_CENT

◆ ADSI_JUST_IND

◆ ADSI_JUST_LEFT

◆ ADSI_JUST_RIGHT

◆ ADSI_KEY_APPS

◆ ADSI_KEY_HILITE

◆ ADSI_KEY_SKT

◆ ADSI_LINE_CONTROL

◆ ADSI_LINE_NUMBER

◆ ADSI_LOAD_DEFAULT

◆ ADSI_LOAD_PREDEF_DISP

◆ ADSI_LOAD_SCRIPT

◆ ADSI_LOAD_SOFTKEY

◆ ADSI_LOAD_SOFTKEY_TABLE

◆ ADSI_LOAD_VIRTUAL_DISP

◆ ADSI_MOVE_DATA

◆ ADSI_MSG_DISPLAY

◆ ADSI_MSG_DOWNLOAD

◆ ADSI_OFF_HOOK

◆ ADSI_ON_HOOK

◆ ADSI_PAGE_DOWN

◆ ADSI_PAGE_UP

◆ ADSI_QUERY_CONFIG

◆ ADSI_QUERY_CPEID

◆ ADSI_SEND_CHARS

◆ ADSI_SWITCH_TO_ALT

◆ ADSI_SWITCH_TO_APP

◆ ADSI_SWITCH_TO_DATA

◆ ADSI_SWITCH_TO_DATA2

◆ ADSI_SWITCH_TO_GRAPHICS

◆ ADSI_SWITCH_TO_PERIPH

◆ ADSI_SWITCH_TO_VOICE

◆ ADSI_SWITCH_TO_VOICE2

◆ ADSI_TAB_COLUMN

◆ AST_ADSI_VERSION

Function Documentation

◆ ast_adsi_available()

◆ ast_adsi_begin_download()

◆ ast_adsi_channel_restore()

◆ ast_adsi_clear_screen()

◆ ast_adsi_clear_soft_keys()

◆ ast_adsi_connect_session()

◆ ast_adsi_data_mode()

◆ ast_adsi_disconnect_session()

◆ ast_adsi_display()