voip_api.h

telcobridges voip develop

 |
 |	Compatibility:
 |		~
 |
 |	Side effects:
 |		~
 |
 *------------------------------------------------------------------------------------------------------------------------------*/
typedef struct _VOIP_EVT_OP_RESET_STRESS_TEST_STATS
{
	TBX_MSG_HEADER								Header;
	TBX_UINT32									un32MsgVersion;

} VOIP_EVT_OP_RESET_STRESS_TEST_STATS, *PVOIP_EVT_OP_RESET_STRESS_TEST_STATS;

typedef union _VOIP_MSG_OP_RESET_STRESS_TEST_STATS
{
	TBX_MSG_HEADER								Header;
	VOIP_EVT_OP_RESET_STRESS_TEST_STATS			Event;

} VOIP_MSG_OP_RESET_STRESS_TEST_STATS, *PVOIP_MSG_OP_RESET_STRESS_TEST_STATS;

/*-------------------------------------------------------------------------------------------------------------------------------
 |
 |	Message:
 |		VOIP_MSG_ID_OP_START_DEMO
 |
 |	Description:
 |		This event is sent by the customer-defined application to the main state machine
 |		to start demo
 |
 |	Event parameters:
 |		fSkipPauses		Skip pauses indication
 |		fAutoAbort		Automatically abort demo on failure
 |
 |	Notices:
 |		~
 |
 |	Compatibility:
 |		~
 |
 |	Side effects:
 |		~
 |
 *------------------------------------------------------------------------------------------------------------------------------*/
typedef struct _VOIP_EVT_OP_START_DEMO
{
	TBX_MSG_HEADER								Header;
	TBX_UINT32									un32MsgVersion;
	TBX_BOOL									fSkipPauses;
	TBX_BOOL									fAutoAbort;

} VOIP_EVT_OP_START_DEMO, *PVOIP_EVT_OP_START_DEMO;

typedef union _VOIP_MSG_OP_START_DEMO
{
	TBX_MSG_HEADER								Header;
	VOIP_EVT_OP_START_DEMO						Event;

} VOIP_MSG_OP_START_DEMO, *PVOIP_MSG_OP_START_DEMO;

/*-------------------------------------------------------------------------------------------------------------------------------
 |
 |	Message:
 |		VOIP_MSG_ID_OP_STOP_DEMO
 |
 |	Description:
 |		This event is sent by the customer-defined application to the main state machine
 |		to stop demo
 |
 |	Event parameters:
 |		~
 |
 |	Notices:
 |		~
 |
 |	Compatibility:
 |		~
 |
 |	Side effects:
 |		~
 |
 *------------------------------------------------------------------------------------------------------------------------------*/
typedef struct _VOIP_EVT_OP_STOP_DEMO
{
	TBX_MSG_HEADER								Header;
	TBX_UINT32									un32MsgVersion;

} VOIP_EVT_OP_STOP_DEMO, *PVOIP_EVT_OP_STOP_DEMO;

typedef union _VOIP_MSG_OP_STOP_DEMO
{
	TBX_MSG_HEADER								Header;
	VOIP_EVT_OP_STOP_DEMO						Event;

} VOIP_MSG_OP_STOP_DEMO, *PVOIP_MSG_OP_STOP_DEMO;

/*-------------------------------------------------------------------------------------------------------------------------------
 |
 |	Message:
 |		VOIP_MSG_ID_OP_NEXT_DEMO_STEP
 |
 |	Description:
 |		This event is sent by the customer-defined application to the main state machine
 |		to change next demo step
 |
 |	Event parameters:
 |		~
 |
 |	Notices:
 |		~
 |
 |	Compatibility:
 |		~
 |
 |	Side effects:
 |		~
 |
 *------------------------------------------------------------------------------------------------------------------------------*/
typedef struct _VOIP_EVT_OP_NEXT_DEMO_STEP
{
	TBX_MSG_HEADER								Header;
	TBX_UINT32									un32MsgVersion;

} VOIP_EVT_OP_NEXT_DEMO_STEP, *PVOIP_EVT_OP_NEXT_DEMO_STEP;

typedef union _VOIP_MSG_OP_NEXT_DEMO_STEP
{
	TBX_MSG_HEADER								Header;
	VOIP_EVT_OP_NEXT_DEMO_STEP					Event;

} VOIP_MSG_OP_NEXT_DEMO_STEP, *PVOIP_MSG_OP_NEXT_DEMO_STEP;

/*-------------------------------------------------------------------------------------------------------------------------------
 |
 |	Message:
 |		VOIP_MSG_ID_OP_ALLOCATE_CONNECTION
 |
 |	Description:
 |		This event is sent by the customer-defined application to the main state machine
 |		to connect resources
 |
 |	Event parameters:
 |		Params				Parameters of the connection to create
 |		un32NbConnections	Number of connections to create
 |		un16IPPortIncrement	IP port increment for multiple connections creation
 |
 |	Notices:
 |		~
 |
 |	Compatibility:
 |		~
 |
 |	Side effects:
 |		~
 |
 *------------------------------------------------------------------------------------------------------------------------------*/
typedef struct _VOIP_EVT_OP_ALLOCATE_CONNECTION
{
	TBX_MSG_HEADER								Header;
	TBX_UINT32									un32MsgVersion;
	TBX_UINT32									un32NbConnections;
	VOIP_CONNECTION_PARAMS						Params;
	TBX_UINT16									un16IPPortIncrement;
	TBX_UINT8									un8Padding[6];

} VOIP_EVT_OP_ALLOCATE_CONNECTION, *PVOIP_EVT_OP_ALLOCATE_CONNECTION;

typedef union _VOIP_MSG_OP_ALLOCATE_CONNECTION
{
	TBX_MSG_HEADER								Header;
	VOIP_EVT_OP_ALLOCATE_CONNECTION				Event;

} VOIP_MSG_OP_ALLOCATE_CONNECTION, *PVOIP_MSG_OP_ALLOCATE_CONNECTION;

/*-------------------------------------------------------------------------------------------------------------------------------
 |
 |	Message:
 |		VOIP_MSG_ID_OP_CLEAR_CONNECTION
 |
 |	Description:
 |		This event is sent by the customer-defined application to the main state machine
 |		to disconnect resources
 |
 |	Event parameters:
 |		fAll				Tell to disconnect all resources when TBX_TRUE.
 |		fIncludeInfiniteDurCall	disconnect or not call that have infinite duration
 |		un32ConnectionId	Connection identifier.
 |
 |	Notices:
 |		~
 |
 |	Compatibility:
 |		~
 |
 |	Side effects:
 |		~
 |
 *------------------------------------------------------------------------------------------------------------------------------*/
typedef struct _VOIP_EVT_OP_CLEAR_CONNECTION
{
	TBX_MSG_HEADER								Header;
	TBX_UINT32									un32MsgVersion;
	TBX_BOOL									fAll;
	TBX_BOOL									fIncludeInfiniteDurCall;
	TBX_UINT32									un32ConnectionId;

} VOIP_EVT_OP_CLEAR_CONNECTION, *PVOIP_EVT_OP_CLEAR_CONNECTION;

typedef union _VOIP_MSG_OP_CLEAR_CONNECTION
{
	TBX_MSG_HEADER								Header;
	VOIP_EVT_OP_CLEAR_CONNECTION				Event;

} VOIP_MSG_OP_CLEAR_CONNECTION, *PVOIP_MSG_OP_CLEAR_CONNECTION;


/************************************************************************/
/* Messages used for streaming                                          */
/************************************************************************/
/*-------------------------------------------------------------------------------------------------------------------------------
 |
 |	Message:
 |		VOIP_MSG_ID_OP_STREAMING_GET_DATA_ADDR
 |
 |	Description:
 |		This event is sent internally to handle streamlib get data callback
 |			in the main message loop.
 |
 |	Event parameters:
 |		un32MsgVersion			:	Should be 1
 |		hPlay					:	Handle of the playback that requires more data to play.
 |		un64Id					:	Id of the target raw data file
 |		hAcknowledge			:	Acknowledge handle: Handle that must be used when
 |									TBXStreamAcknowledgeCallback() is called.
 |		ppBuffer				:	Pointer to fill with the pointer to the next data to send.
 |
 |	Notices:
 |		~
 |
 |	Compatibility:
 |		~
 |
 |	Side effects:
 |		~
 |
 *------------------------------------------------------------------------------------------------------------------------------*/
typedef struct _VOIP_EVT_OP_STREAMING_GET_DATA_ADDR
{
	TBX_MSG_HEADER								Header;
	TBX_UINT32									un32MsgVersion;
	TBX_STREAM_LIB_PLAY_HANDLE					hPlay;
	TBX_STREAM_LIB_ACK_HANDLE					hAcknowledge;
	TBX_UINT64									un64Id;
	PTBX_VOID*									ppBuffer;
	
} VOIP_EVT_OP_STREAMING_GET_DATA_ADDR, *PVOIP_EVT_OP_STREAMING_GET_DATA_ADDR;

typedef union _VOIP_MSG_OP_STREAMING_GET_DATA_ADDR
{
	TBX_MSG_HEADER								Header;
	VOIP_EVT_OP_STREAMING_GET_DATA_ADDR			Event;

} VOIP_MSG_OP_STREAMING_GET_DATA_ADDR, *PVOIP_MSG_OP_STREAMING_GET_DATA_ADDR;

/*-------------------------------------------------------------------------------------------------------------------------------
 |
 |	Message:
 |		VOIP_MSG_ID_OP_STREAMING_SAVE_PACKET
 |
 |	Description:
 |		This event is sent internally to handle streamlib save data callback
 |			in the main message loop.
 |
 |	Event parameters:
 |		un32MsgVersion			:	Should be 1
 |		hRecord					:	Handle of the record that has incoming data.
 |		un64Id					:	Id of the target raw data file
 |		pBuffer					:	Pointer to incoming data.
 |		un32Length				:	Length of the data in pBuffer;
 |
 |	Notices:
 |		~
 |
 |	Compatibility:
 |		~
 |
 |	Side effects:
 |		~
 |
 *------------------------------------------------------------------------------------------------------------------------------*/
typedef struct _VOIP_EVT_OP_STREAMING_SAVE_PACKET
{
	TBX_MSG_HEADER								Header;
	TBX_UINT32									un32MsgVersion;
	TBX_STREAM_LIB_PLAY_HANDLE					hRecord;
	TBX_UINT64									un64Id;
	PTBX_VOID									pBuffer;
	TBX_UINT32									un32Length;
	
} VOIP_EVT_OP_STREAMING_SAVE_PACKET, *PVOIP_EVT_OP_STREAMING_SAVE_PACKET;

typedef union _VOIP_MSG_OP_STREAMING_SAVE_PACKET
{
	TBX_MSG_HEADER								Header;
	VOIP_EVT_OP_STREAMING_SAVE_PACKET				Event;

} VOIP_MSG_OP_STREAMING_SAVE_PACKET, *PVOIP_MSG_OP_STREAMING_SAVE_PACKET;

/*-------------------------------------------------------------------------------------------------------------------------------
 |
 |	Message:
 |		VOIP_MSG_ID_OP_STREAMING_STOP_CONFIRMED
 |
 |	Description:
 |		This event is sent internally to handle streamlib stop confirmed callback
 |			in the main message loop.
 |
 |	Event parameters:
 |		un32MsgVersion			:	Should be 1
 |		hPlay					:	Handle of the play or record that has stopped.
 |		un64Id					:	Id of the target raw data file
 |
 |	Notices:
 |		~
 |
 |	Compatibility:
 |		~
 |
 |	Side effects:
 |		~
 |
 *------------------------------------------------------------------------------------------------------------------------------*/
typedef struct _VOIP_EVT_OP_STREAMING_STOP_CONFIRMED
{
	TBX_MSG_HEADER								Header;
	TBX_UINT32									un32MsgVersion;
	TBX_STREAM_LIB_PLAY_HANDLE					hPlay;
	TBX_UINT64									un64Id;
	
} VOIP_EVT_OP_STREAMING_STOP_CONFIRMED, *PVOIP_EVT_OP_STREAMING_STOP_CONFIRMED;

typedef union _VOIP_MSG_OP_STREAMING_STOP_CONFIRMED
{
	TBX_MSG_HEADER								Header;
	VOIP_EVT_OP_STREAMING_STOP_CONFIRMED		Event;

} VOIP_MSG_OP_STREAMING_STOP_CONFIRMED, *PVOIP_MSG_OP_STREAMING_STOP_CONFIRMED;

/*--------------------------------------------------------------------------------------------------------------------------------
 |  Macros
 *------------------------------------------------------------------------------------------------------------------------------*/


/*--------------------------------------------------------------------------------------------------------------------------------
 |  Function prototypes
 *------------------------------------------------------------------------------------------------------------------------------*/


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


#endif /* __VOIP_API_H__ */