Method Functions for Intel/Dialogic Telephony Line Cards.

This class instantiates all of the "verbs", actions that a controlling process might initiate upon a line.

Source:

DialogicMethods.h:15

Author:

Green Lizard Staff

Version:

1.01

Entity	Inherited From	Type	Scope	Short Description
~CDialogicMethods		destructor	public	automatically generated
CDialogicMethods		constructor	public	automatically generated
CDialogicMethods		constructor	public	automatically generated
Dial		method	public	Make a phone call
DisableTone	CDialogicBoards	method	public	Disable custon tone detection tables
DropCall		method	public	Same as Hanging up
EnableTone	CDialogicBoards	method	public	Enable custom tone detection tables
HangUp		method	public	Hang up a call
InitCall		method	public	Parameterize the call before it is made.
InitPlay		method	public	Set up the play structures and termination string
InitRecord		method	public	Set up record structures
Log	CDialogicBoards	method	public	Send a Log Message.
OpenDevice	CDialogicBoards	method	public	A Helper Function for Setup.
OpenDeviceISDN	CDialogicBoards	method	public	A Helper Function for Setup.
OpenDeviceT1	CDialogicBoards	method	public	A Helper Function for Setup.
OpenDeviceT1Fax	CDialogicBoards	method	public	Open a Fax Resource
OpenDeviceT1FaxChannel	CDialogicBoards	method	public	Open a Fax Channel
operator =		operator	public	automatically generated
Play		method	public	Play a file over a phone call
print_GC_error	CDialogicBoards	method	public	Print a Global Call Error.
Record		method	public	Half Duplex Record to Memory
Record		method	public	Hald-Duplex Record to a File
ReleaseLine	CDialogicBoards	method	public	Release a specific Line.
ReserveAnyLine	CDialogicBoards	method	public	Reserve a line, without caring which one is received.
ReserveLine	CDialogicBoards	method	public	Reserve a specific line for use.
Reset		method	public	Reset control structures of a line
Route_N1_F1	CDialogicBoards	method	public	Network/Fax Routing Function
SendFax		method	public	Send a Fax
Setup	CDialogicBoards	method	public	Setup the Dialogic Board.
StartRecordBG		method	public	Record in the background
StopRecordBG		method	public	Stop Recording in the background
TearDown	CDialogicBoards	method	public	Tear Down the Dialogic Setup.
TransferToAgent		method	public	Transfer a call to another line
Unroute_N1_F1	CDialogicBoards	method	public	Network/Fax Unrouting Function
VoxCall		method	public	Deprecated - Make a phone call

automatically generated

Source:

DialogicMethods.h

Code:

public ~ CDialogicMethods ( )

automatically generated

Source:

DialogicMethods.h

Code:

public CDialogicMethods (

const CDialogicMethods & )

automatically generated

Source:

DialogicMethods.h

Code:

public CDialogicMethods (

)

Make a phone call

Source:

DialogicMethods.h:32

Code:

public long Dial (	LPCSTR PhoneNumber ,
	int LineNumber ,
	LPCSTR rcrd_filename ,
	LPCSTR play_filename ,
	LPCSTR live_filename ,
	LPCSTR fax_filename ,
	LPCSTR digitstring ,
	LPCSTR AgentPhoneNumber ,
	int AgentLineNumber )

Disable custon tone detection tables

Inherited From:

CDialogicBoards

Source:

DialogicBoards.h:180

Code:

public void DisableTone (

Channel * pline )

Same as Hanging up

Source:

DialogicMethods.h:50

Code:

public BOOL DropCall (	int LineNumber ,
	CString Caller )

Enable custom tone detection tables

Inherited From:

CDialogicBoards

Source:

DialogicBoards.h:177

Code:

public void EnableTone (

Channel * pline )

Hang up a call

Source:

DialogicMethods.h:47

Code:

public BOOL HangUp (

int LineNumber )

Parameterize the call before it is made.

Source:

DialogicMethods.h:20

Code:

public void InitCall (

Channel * pline )

Set up the play structures and termination string

Source:

DialogicMethods.h:23

Code:

public void InitPlay (	Channel * pline ,
	LPCSTR TermStr )

Set up record structures

Source:

DialogicMethods.h:26

Code:

public void InitRecord (

Channel * pline )

Send a Log Message.

A Helper function to centralize the peculiar code we use to jump between Micro$oft thread apartments.

Inherited From:

CDialogicBoards

Source:

DialogicBoards.h:141

Code:

public void Log (	int Level ,
	int LineNumber ,
	LPCSTR Message )

A Helper Function for Setup.

This function handles the initialization which must be done for each channel on the board before any one channel can be used.

Inherited From:

CDialogicBoards

Source:

DialogicBoards.h:101

Code:

public void OpenDevice (	int index ,
	char * protocol )

A Helper Function for Setup.

This function handles the initialization which must be done for each channel on an ISDN board before any one channel can be used.

Inherited From:

CDialogicBoards

Source:

DialogicBoards.h:117

Code:

public bool OpenDeviceISDN (

int index )

A Helper Function for Setup.

This function handles the initialization which must be done for each channel on a T1 board before any one channel can be used.

Inherited From:

CDialogicBoards

Source:

DialogicBoards.h:109

Code:

public bool OpenDeviceT1 (

int index )

Open a Fax Resource

Inherited From:

CDialogicBoards

Source:

DialogicBoards.h:189

Code:

public void OpenDeviceT1Fax (

int faxchannels )

Open a Fax Channel

Inherited From:

CDialogicBoards

Source:

DialogicBoards.h:192

Code:

public void OpenDeviceT1FaxChannel (

int faxchannel )

automatically generated

Source:

DialogicMethods.h

Code:

public CDialogicMethods & operator = (

const CDialogicMethods & )

Play a file over a phone call

Source:

DialogicMethods.h:56

Code:

public int Play (	int LineNumber ,
	LPCSTR FileName ,
	LPCSTR TermStr )

Print a Global Call Error.

A Helper Function to get the textual information available from the Dialogic driver if a problem arises, for logging.

Inherited From:

CDialogicBoards

Source:

DialogicBoards.h:133

Code:

public void print_GC_error (	int index ,
	char * msg )

Half Duplex Record to Memory

Source:

DialogicMethods.h:62

Code:

public int Record (	int LineNumber ,
	char * AudioBuffer )

Hald-Duplex Record to a File

Source:

DialogicMethods.h:59

Code:

public int Record (	int LineNumber ,
	LPCSTR FileName )

Release a specific Line.

We call this when we know a line is clear, or when a call has definitely terminated.

Inherited From:

CDialogicBoards

Source:

DialogicBoards.h:174

Code:

public BOOL ReleaseLine (

int LineNumber )

Reserve a line, without caring which one is received.

This function is usefull when a workload is to be accomplished, but there is no need to choose which lines the work is done. The return is the actual line used. Using this approach, the application does not need to maintain information about which lines are available.

Please note, there are not presently any exposed methods which can take advantage of this design!

Inherited From:

CDialogicBoards

Source:

DialogicBoards.h:154

Code:

public int ReserveAnyLine (

void )

Reserve a specific line for use.

This is called by VoxCall to reserve a Line for a call. All lines start out blocked for a few seconds while the Dialogic board tests to be sure the T1 connections are good. Then unblocked events are sent to the application for each line that is good, and we call "ReleaseLine" for each of these events. This implies that there is a period between when "Start" is called and when "ReserveLine" will succeed: this period ends when the UNBLOCKED message is sent to the application.

Inherited From:

CDialogicBoards

Source:

DialogicBoards.h:167

Code:

public BOOL ReserveLine (

int LineNumber )

Reset control structures of a line

Source:

DialogicMethods.h:53

Code:

public BOOL Reset (

int LineNumber )

Network/Fax Routing Function

Inherited From:

CDialogicBoards

Source:

DialogicBoards.h:183

Code:

public void Route_N1_F1 (	int netindex ,
	int faxchannel )

Send a Fax

Source:

DialogicMethods.h:41

Code:

public int SendFax (	int LineNumber ,
	int FaxChannel ,
	LPCSTR FileName )

Setup the Dialogic Board.

This is done manually so that the application may get a channel count, and then initialize any structure it may require, before Dialogic events start arriving. As soon as the board(s) are set up, at the very least, "UNBLOCKED" messages mayh begin to arrive before any functions are called.

The number of lines is probed for and set in this function.

Inherited From:

CDialogicBoards

Source:

DialogicBoards.h:93

Code:

public bool Setup (

void )

Record in the background

Source:

DialogicMethods.h:65

Code:

public int StartRecordBG (	int recording_channel ,
	int recorded_channel ,
	LPCSTR FileName )

Stop Recording in the background

Source:

DialogicMethods.h:68

Code:

public int StopRecordBG (

int recording_channel )

Tear Down the Dialogic Setup.

The complement to "Setup", this is also done manually. Calling it more than once has no harmful effect.

Inherited From:

CDialogicBoards

Source:

DialogicBoards.h:125

Code:

public bool TearDown (

void )

Transfer a call to another line

Source:

DialogicMethods.h:44

Code:

public int TransferToAgent (	int LineNumber ,
	int AgentLineNumber ,
	LPCSTR PhoneNumber )

Network/Fax Unrouting Function

Inherited From:

CDialogicBoards

Source:

DialogicBoards.h:186

Code:

public void Unroute_N1_F1 (	int netindex ,
	int faxchannel )

Deprecated - Make a phone call

Source:

DialogicMethods.h:38

Code:

public long VoxCall (	int LineNumber ,
	LPCSTR PhoneNumber ,
	LPCSTR rcrd_filename ,
	LPCSTR play_filename ,
	LPCSTR live_filename ,
	LPCSTR fax_filename ,
	LPCSTR digitstring ,
	LPCSTR AgentPhoneNumber ,
	int AgentLineNumber )