messages.h

telcobridges tone develop

/*--------------------------------------------------------------------------------------------------------------------------------
 |
 |	Project:    	VoiceLink TB640 sample (tone)
 |
 |	Filename:   	messages.h
 |
 |	Copyright:  	TelcoBridges 2002-2003, All Rights Reserved
 |
 |	Description:	This file contains the required user defined message definitions
 |
 |	Notes:      	Tabs = 4
 |
 *-------------------------------------------------------------------------------------------------------------------------------
 |
 |	Revision:   	$Revision: 1.3 $
 |
 *------------------------------------------------------------------------------------------------------------------------------*/


/*--------------------------------------------------------------------------------------------------------------------------------
 |  Define header file
 *------------------------------------------------------------------------------------------------------------------------------*/
#ifndef __TONE_MESSAGES_H__
#define __TONE_MESSAGES_H__


/*--------------------------------------------------------------------------------------------------------------------------------
 |  C++ support
 *------------------------------------------------------------------------------------------------------------------------------*/
#ifdef __cplusplus
extern "C"
{
#endif /* __cplusplus */


/*--------------------------------------------------------------------------------------------------------------------------------
 |  Forward declarations
 *------------------------------------------------------------------------------------------------------------------------------*/

/*--------------------------------------------------------------------------------------------------------------------------------
 |  Defines
 *------------------------------------------------------------------------------------------------------------------------------*/

/*--------------------------------------------------------------------------------------------------------------------------------
 |  Types
 *------------------------------------------------------------------------------------------------------------------------------*/

/*--------------------------------------------------------------------------------------------------------------------------------
 |
 |  Messages - User Define
 |
 *------------------------------------------------------------------------------------------------------------------------------*/

/*
 * Msg Clases
 */
#define TONE_ID_CLASS_TIMER				(TBX_ID_CLASS_ALLOCATION_USER_BEGIN + 0x000) /* Timer thread Msg Class */
#define TONE_ID_CLASS_COLLECTOR			(TBX_ID_CLASS_ALLOCATION_USER_BEGIN + 0x001) /* Tone collection thread Msg Class */

/*
 * Msg Ids
 */

/* Timer Thread Msg Ids */
#define	TONE_MSG_ID_TIMER_NOTIF				TBX_MSG_ID_GEN (TONE_ID_CLASS_TIMER, 		0x01)

/* Tone Collector Msg Ids */
#define	TONE_MSG_ID_COLLECTOR_ALLOC			TBX_MSG_ID_GEN (TONE_ID_CLASS_COLLECTOR, 	0x01)
#define	TONE_MSG_ID_COLLECTOR_FREE			TBX_MSG_ID_GEN (TONE_ID_CLASS_COLLECTOR, 	0x02)
#define	TONE_MSG_ID_COLLECTOR_NOTIF			TBX_MSG_ID_GEN (TONE_ID_CLASS_COLLECTOR, 	0x03)


/*-------------------------------------------------------------------------------------------------------------------------------
 |
 |	Message:
 |		TONE_MSG_ID_TIMER_NOTIF
 |
 |	Description:
 |		This request message can be used to initialize an instance of the ISDN Q.931 protocol stack and associate it to
 |		specific trunk(s).   Multiple trunks association is used only when NFAS is used.
 |
 |	Event parameters:
 |		Header					Generic message header. Should not be directly changed by the application.
 |		un32MsgVersion			Version of the message. Should bet set to 1.
 |
 *------------------------------------------------------------------------------------------------------------------------------*/
typedef struct _TONE_EVT_NOTIF_TIMER
{
	TBX_MSG_HEADER						Header;
	TBX_UINT32							un32MsgVersion;

	TBX_UINT32							un32MsTime;				/* Time (ms) value at the time the timer thread send this event */
	TBX_UINT32							un32MsDelta;			/* Time (ms) Delta between last event and current */
	TBX_UINT32							un32Padding;			/* 64 bits align */

} TONE_EVT_NOTIF_TIMER, *PTONE_EVT_NOTIF_TIMER;

typedef union _TONE_MSG_NOTIF_TIMER
{
	TBX_MSG_HEADER						Header;
	TONE_EVT_NOTIF_TIMER				Event;

} TONE_MSG_NOTIF_TIMER, *PTONE_MSG_NOTIF_TIMER;

/*-------------------------------------------------------------------------------------------------------------------------------
 |
 |	Message:
 |		TONE_MSG_ID_COLLECTOR_ALLOC
 |
 |	Description:
 |
 |	Event parameters:
 |		Header					Generic message header. Should not be directly changed by the application.
 |		un32MsgVersion			Version of the message. Should bet set to 1.
 |
 *------------------------------------------------------------------------------------------------------------------------------*/
typedef struct _TONE_REQ_COLLECTOR_ALLOC
{
	TBX_MSG_HEADER						Header;
	TBX_UINT32							un32MsgVersion;

	TB640_RESOURCE_HANDLE				hRes;
	TBX_UINT32							un32MsFirstDigitTimeout;
	TBX_UINT32							un32MsInterDigitTimeout;
	TBX_UINT32							un32NbToneMax;
	TB640_VP_DIGIT_TYPE					TerminatingDigit;

	TBX_UINT64							un64UserCtx1;
	TBX_UINT64							un64UserCtx2;

} TONE_REQ_COLLECTOR_ALLOC, *PTONE_REQ_COLLECTOR_ALLOC;

typedef struct _TONE_RSP_COLLECTOR_ALLOC
{
	TBX_MSG_HEADER						Header;
	TBX_UINT32							un32MsgVersion;
	TBX_RESULT							Result;

} TONE_RSP_COLLECTOR_ALLOC, *PTONE_RSP_COLLECTOR_ALLOC;

typedef union _TONE_MSG_COLLECTOR_ALLOC
{
	TBX_MSG_HEADER						Header;
	TONE_REQ_COLLECTOR_ALLOC			Request;
	TONE_RSP_COLLECTOR_ALLOC			Response;

} TONE_MSG_COLLECTOR_ALLOC, *PTONE_MSG_COLLECTOR_ALLOC;

/*-------------------------------------------------------------------------------------------------------------------------------
 |
 |	Message:
 |		TONE_MSG_ID_COLLECTOR_FREE
 |
 |	Description:
 |
 |	Event parameters:
 |		Header					Generic message header. Should not be directly changed by the application.
 |		un32MsgVersion			Version of the message. Should bet set to 1.
 |
 *------------------------------------------------------------------------------------------------------------------------------*/
typedef struct _TONE_REQ_COLLECTOR_FREE
{
	TBX_MSG_HEADER						Header;
	TBX_UINT32							un32MsgVersion;

	TB640_RESOURCE_HANDLE				hRes;

} TONE_REQ_COLLECTOR_FREE, *PTONE_REQ_COLLECTOR_FREE;

typedef union _TONE_MSG_COLLECTOR_FREE
{
	TBX_MSG_HEADER						Header;
	TONE_REQ_COLLECTOR_FREE				Request;

} TONE_MSG_COLLECTOR_FREE, *PTONE_MSG_COLLECTOR_FREE;

/*-------------------------------------------------------------------------------------------------------------------------------
 |
 |	Message:
 |		TONE_MSG_ID_COLLECTOR_NOTIF
 |
 |	Description:
 |
 |	Event parameters:
 |		Header					Generic message header. Should not be directly changed by the application.
 |		un32MsgVersion			Version of the message. Should bet set to 1.
 |
 *------------------------------------------------------------------------------------------------------------------------------*/
typedef struct _TONE_EVT_COLLECTOR_NOTIF
{
	TBX_MSG_HEADER						Header;
	TBX_UINT32							un32MsgVersion;

	TB640_RESOURCE_HANDLE				hRes;
	TBX_BOOL							fFirstDigitTimeout;			/* True when time out occurs */
	TBX_UINT32							un32InterDigitTime;

	TBX_BOOL							fInterDigitTimeout;			/* True when time out occurs */
	TBX_UINT32							un32FirstDigitTime;

	TBX_UINT32							un32NbCollectedTones;
	TBX_UINT32							un32Padding1;

	TB640_VP_DIGIT_TYPE					aDigit[1];

} TONE_EVT_COLLECTOR_NOTIF, *PTONE_EVT_COLLECTOR_NOTIF;

typedef union _TONE_MSG_COLLECTOR_NOTIF
{
	TBX_MSG_HEADER						Header;
	TONE_EVT_COLLECTOR_NOTIF			Event;

} TONE_MSG_COLLECTOR_NOTIF, *PTONE_MSG_COLLECTOR_NOTIF;

/*--------------------------------------------------------------------------------------------------------------------------------
 |  C++ support
 *------------------------------------------------------------------------------------------------------------------------------*/
#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __TONE_MESSAGES_H__ */