Event Functions for Intel/Dialogic Telephony line cards.

This class transmits line events to the controlling application for decision processing.

Source:

DialogicEvents.h:13

Author:

Green Lizard Staff

Version:

1.01

Entity	Inherited From	Type	Scope	Short Description
~CDialogicEvents		destructor	public	automatically generated
CDialogicEvents		constructor	public	automatically generated
CDialogicEvents		constructor	public	automatically generated
AgentTransferConnected		method	public	An agent has been connected with a client.
Blocked		method	public	The Line Blocked event has been received.
CallComplete		method	public	This function signals that a call has completed.
CallConnected		method	public	This function is used to signal that the call is connected.
CallDisconnected		method	public	This function is used to signal that the call is connected.
CallProgress		method	public	This function is used to signal that a call progress result is available.
Dial	CDialogicMethods	method	public	Make a phone call
DisableTone	CDialogicBoards	method	public	Disable custon tone detection tables
DoDxDial		method	public	A Null dial used to set off Call Progress Analysis with Global Call
DropCall	CDialogicMethods	method	public	Same as Hanging up
EnableTone	CDialogicBoards	method	public	Enable custom tone detection tables
FaxComplete		method	public	This function signals that a fax has been transmitted with or without error.
GetAllDigits		method	public	Helper function for sperating tone digits from dx event
GetDigits		method	public	Helper function for sperating tone digits from dx event
GetPlayMessage		method	public	Helper function for getting message text for log
HangUp	CDialogicMethods	method	public	Hang up a call
InitCall	CDialogicMethods	method	public	Parameterize the call before it is made.
InitInstance		method	public	This is the Dialogic Event Thread Entry Point.
InitPlay	CDialogicMethods	method	public	Set up the play structures and termination string
InitRecord	CDialogicMethods	method	public	Set up record structures
Log	CDialogicBoards	method	public	Send a Log Message.
NowString		method	public	Print the time and date for the log
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	CDialogicMethods	method	public	Play a file over a phone call
PlayComplete		method	public	A Play is complete When a play is started, it completes asynchronously.
print_GC_error	CDialogicBoards	method	public	Print a Global Call Error.
ProcessAgentConnectedEvent		method	public	Connect a live agent to a line
ProcessCallStateTransition		method	public	Helper function for tones received during a dx event
ProcessConnectedEvent		method	public	Helper for Connection, Called only by "ProcessOutbound Event"
ProcessDisconnectedEvent		method	public	Handle a call being disconnected
ProcessDSPEvent		method	public	A target for DSP generated signals
ProcessDxEvent		method	public	Relay point for Dialogic Standard Runtime Library ("SRL", or "dx_") Call events.
ProcessEvent		method	public	Entry point for Dialogic/Intel events.
ProcessGcEvent		method	public	Relay point for Global Call events.
ProcessMediaDetectedEvent		method	public	Retrieve structures and call helper function
ProcessOutboundEvent		method	public	Handle Dialogic driver supplied events which happen after a call is made; When a call is connected, for example.
Record	CDialogicMethods	method	public	Hald-Duplex Record to a File
Record	CDialogicMethods	method	public	Half Duplex Record to Memory
RecordComplete		method	public	A Record is complete See play for more detail.
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	CDialogicMethods	method	public	Reset control structures of a line
Route_N1_F1	CDialogicBoards	method	public	Network/Fax Routing Function
SendFax	CDialogicMethods	method	public	Send a Fax
Setup	CDialogicBoards	method	public	Setup the Dialogic Board.
StartRecordBG	CDialogicMethods	method	public	Record in the background
StopRecordBG	CDialogicMethods	method	public	Stop Recording in the background
TearDown	CDialogicBoards	method	public	Tear Down the Dialogic Setup.
TransferToAgent	CDialogicMethods	method	public	Transfer a call to another line
Unblocked		method	public	The Line Unblocked event has been received.
Unroute_N1_F1	CDialogicBoards	method	public	Network/Fax Unrouting Function
VoxCall	CDialogicMethods	method	public	Deprecated - Make a phone call

automatically generated

Source:

DialogicEvents.h

Code:

public ~ CDialogicEvents ( )

automatically generated

Source:

DialogicEvents.h

Code:

public CDialogicEvents (

)

automatically generated

Source:

DialogicEvents.h

Code:

public CDialogicEvents (

const CDialogicEvents & )

An agent has been connected with a client.

This occurs when a call is made with the intent of a future automatic transfer. When and if the transfer actually occurs, this event is fired.

Source:

DialogicEvents.h:92

Code:

public void AgentTransferConnected (	int AgentLineNumber ,
	int ClientLineNumber ,
	LPCSTR TextInfo )

The Line Blocked event has been received.

When a board is successfully opened, the Dialogic driver then test all of the lines. During this period, the lines are "blocked", that is, not available. Also, if a line fails during the run, the drive will send this message. The most obvious case of this occurs when the lines are unplugged from the card.

Source:

DialogicEvents.h:39

Code:

public void Blocked (

int LineNumber )

This function signals that a call has completed.

An event that a call is complete is dispatched using this function.

Source:

DialogicEvents.h:77

Code:

public void CallComplete (	int LineNumber ,
	int CallResult ,
	LPCSTR TextInfo )

This function is used to signal that the call is connected.

This function is called when the call connection has been made, in order to signal to the application that a line is connected.

Source:

DialogicEvents.h:54

Code:

public void CallConnected (	int LineNumber ,
	int ConnectResult ,
	LPCSTR TextInfo )

This function is used to signal that the call is connected.

This function is called when the call connection has been made, in order to signal to the application that a line is connected.

Source:

DialogicEvents.h:62

Code:

public void CallDisconnected (	int LineNumber ,
	int DisconnectCause ,
	LPCSTR TextInfo )

This function is used to signal that a call progress result is available.

After a call is connected, at a later time, the Dialogic board reports on its analysis. This event is passed along to the application by this signal.

Source:

DialogicEvents.h:70

Code:

public void CallProgress (	int LineNumber ,
	int ProgressResult ,
	LPCSTR TextInfo )

Make a phone call

Inherited From:

CDialogicMethods

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 )

A Null dial used to set off Call Progress Analysis with Global Call

Source:

DialogicEvents.h:132

Code:

public void DoDxDial (	Channel * pline ,
	BOOL EnableCallProgress = TRUE )

Same as Hanging up

Inherited From:

CDialogicMethods

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 )

This function signals that a fax has been transmitted with or without error.

An event that a fax is complete is dispatched using this function.

Source:

DialogicEvents.h:84

Code:

public void FaxComplete (	int LineNumber ,
	int FaxResult ,
	LPCSTR TextInfo )

Helper function for sperating tone digits from dx event

Source:

DialogicEvents.h:147

Code:

public void GetAllDigits (

Channel * pline )

Helper function for sperating tone digits from dx event

Source:

DialogicEvents.h:144

Code:

public long GetDigits (	Channel * pline ,
	int numdigs )

Helper function for getting message text for log

Source:

DialogicEvents.h:153

Code:

public void GetPlayMessage (	long termmsk ,
	char * Messaage )

Hang up a call

Inherited From:

CDialogicMethods

Source:

DialogicMethods.h:47

Code:

public BOOL HangUp (

int LineNumber )

Parameterize the call before it is made.

Inherited From:

CDialogicMethods

Source:

DialogicMethods.h:20

Code:

public void InitCall (

Channel * pline )

This is the Dialogic Event Thread Entry Point.

The Dialogic Event thread begins execution at this point. The boards are all set up, and then a loop polling for events is begun. The termination of the loop occurs when another thread sets the kill event, and then this thread falls out of this function, and terminates. The terminating thread then closes the boards.

Source:

DialogicEvents.h:29

Version:

1.0

Returns:

Always false, which directs the scheduler to terminate the thread on exit.

Code:

public BOOL InitInstance (

void )

Set up the play structures and termination string

Inherited From:

CDialogicMethods

Source:

DialogicMethods.h:23

Code:

public void InitPlay (	Channel * pline ,
	LPCSTR TermStr )

Set up record structures

Inherited From:

CDialogicMethods

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 )

Print the time and date for the log

Source:

DialogicEvents.h:141

Code:

public void NowString (

char * target )

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:

DialogicEvents.h

Code:

public CDialogicEvents & operator = (

const CDialogicEvents & )

Play a file over a phone call

Inherited From:

CDialogicMethods

Source:

DialogicMethods.h:56

Code:

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

A Play is complete

When a play is started, it completes asynchronously.

An event is received when it is complete. This function is called upon the recipt of the play complete event, which signals the application.

Source:

DialogicEvents.h:101

Code:

public void PlayComplete (	int LineNumber ,
	int PlayResult ,
	LPCSTR TextInfo )

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 )

Connect a live agent to a line

Source:

DialogicEvents.h:135

Code:

public void ProcessAgentConnectedEvent (	Channel * pline ,
	METAEVENT * metaeventp )

Helper function for tones received during a dx event

Source:

DialogicEvents.h:150

Code:

public void ProcessCallStateTransition (	Channel * pline ,
	DX_CST * cstp )

Helper for Connection, Called only by "ProcessOutbound Event"

Source:

DialogicEvents.h:126

Code:

public void ProcessConnectedEvent (	Channel * pline ,
	METAEVENT * metaeventp )

Handle a call being disconnected

Source:

DialogicEvents.h:120

Code:

public void ProcessDisconnectedEvent (	Channel * pline ,
	METAEVENT * metaeventp )

A target for DSP generated signals

Source:

DialogicEvents.h:138

Code:

public void ProcessDSPEvent (

int index )

Relay point for Dialogic Standard Runtime Library ("SRL", or "dx_") Call events.

Source:

DialogicEvents.h:117

Code:

public void ProcessDxEvent (

METAEVENT metaevent )

Entry point for Dialogic/Intel events.

Global Call and Standard Runtime Library are dispatched separately from here on a polling thread.

Source:

DialogicEvents.h:111

Code:

public void ProcessEvent (

void )

Relay point for Global Call events.

Source:

DialogicEvents.h:114

Code:

public void ProcessGcEvent (

METAEVENT metaevent )

Retrieve structures and call helper function

Source:

DialogicEvents.h:129

Code:

public void ProcessMediaDetectedEvent (

Channel * pline )

Handle Dialogic driver supplied events which happen after a call is made; When a call is connected, for example.

Source:

DialogicEvents.h:123

Code:

public void ProcessOutboundEvent (	Channel * pline ,
	METAEVENT * metaeventp )

Hald-Duplex Record to a File

Inherited From:

CDialogicMethods

Source:

DialogicMethods.h:59

Code:

public int Record (	int LineNumber ,
	LPCSTR FileName )

Half Duplex Record to Memory

Inherited From:

CDialogicMethods

Source:

DialogicMethods.h:62

Code:

public int Record (	int LineNumber ,
	char * AudioBuffer )

A Record is complete

See play for more detail.

Source:

DialogicEvents.h:108

Code:

public void RecordComplete (	int LineNumber ,
	int StopCause ,
	LPCSTR TextInfo )

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

Inherited From:

CDialogicMethods

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

Inherited From:

CDialogicMethods

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

Inherited From:

CDialogicMethods

Source:

DialogicMethods.h:65

Code:

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

Stop Recording in the background

Inherited From:

CDialogicMethods

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

Inherited From:

CDialogicMethods

Source:

DialogicMethods.h:44

Code:

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

The Line Unblocked event has been received.

This is the signal that the line is ready for a call.

Source:

DialogicEvents.h:46

Code:

public void Unblocked (

int LineNumber )

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

Inherited From:

CDialogicMethods

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 )