voip_auto_test.h

telcobridges voip develop

/*--------------------------------------------------------------------------------------------------------------------------------
 |
 |	Project:    	voip sample
 |
 |	Filename:   	voip_auto_test.h
 |
 |	Copyright:  	TelcoBridges 2002-2004, All Rights Reserved
 |
 |	Description:	This file contains structure and function prototype needed for auto test.
 |
 |	Notes:      	Tabs = 4
 |
 *-------------------------------------------------------------------------------------------------------------------------------
 |
 |	Revision:   	$Revision: 1.3 $
 |
 *------------------------------------------------------------------------------------------------------------------------------*/


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

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

/*--------------------------------------------------------------------------------------------------------------------------------
 |  Defines
 *------------------------------------------------------------------------------------------------------------------------------*/
#define	VOIP_MAX_TEST_COUNT			32

#define VOIP_TEST_STRESS_TEST_NAME				"STRESSTEST01"
#define VOIP_TEST_STRESS_TEST_START_ARGUMENTS	"ADDR=%d.%d.%d.%d, TESTDUR=%d, FIRSTTYPE=%d, NBCONN=%d, MIN=%d, MAX=%d, ABORT=%d, RESET=%d, DOBERT=%d, ADAPTERNAME=%s"
#define VOIP_TEST_STRESS_TEST_STOP_ARGUMENTS	"ADAPTERNAME=%s"


/*--------------------------------------------------------------------------------------------------------------------------------
 |  Types
 *------------------------------------------------------------------------------------------------------------------------------*/
typedef TBX_RESULT (*PFCT_VOIP_START_TEST)
(
	IN		TBX_MSG_HANDLE				in_hMsg,
	IN		PTBX_CHAR					in_pszTestParameter
);

typedef TBX_RESULT (*PFCT_VOIP_STOP_TEST) 
(
	IN		TBX_MSG_HANDLE				in_hMsg,
	IN		PTBX_CHAR					in_pszTestParameter
);

typedef	struct _VOIP_AUTO_TEST_DELEGATE
{
	TBX_CHAR				szTestId[TB_TESTLIB_SCRIPT_PARAMETER_MAX_LENGTH];
	PFCT_VOIP_START_TEST	pFctStartTest;
	PFCT_VOIP_STOP_TEST		pFctStopTest;

} VOIP_AUTO_TEST_DELEGATE, *PVOIP_AUTO_TEST_DELEGATE;

typedef struct _VOIP_SCRIPT_CONTEXT
{
	/* insure that launch confirmation message is send only once */
	TBX_BOOL							fLaunchConfirmSend;
	TBX_BOOL							fTestMode;
	TBX_UINT32							un32TestId;
	TBX_ADAPTER_HANDLE					hHostHandle;			
	TBX_POOL_OF_BUFFERS_HANDLE			hPoolTestFunction;
	PVOIP_AUTO_TEST_DELEGATE			pCurrentTest;
	TBX_CHAR							szLogFileName[TB_TESTLIB_CONFIG_NAME_MAX_LENGTH];

} VOIP_SCRIPT_CONTEXT, *PVOIP_SCRIPT_CONTEXT;


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

/*--------------------------------------------------------------------------------------------------------------------------------
 |  Function prototypes
 *------------------------------------------------------------------------------------------------------------------------------*/
TBX_HASH_KEY VoipTestDelegatePoolGetKey
(
	IN		PTBX_VOID				in_pUserContext,
	IN		PTBX_VOID				in_pTestDelegate
);

TBX_RESULT	VoipInitAutoTest();

TBX_RESULT	VoipFreeAutoTest();

TBX_VOID	VoipDisplayTestAvailable();

TBX_RESULT	VoipStartTestConnect01
(
	IN		TBX_MSG_HANDLE				in_hMsg,
	IN		PTBX_CHAR					in_pszTestParameter
);

TBX_RESULT	VoipStartStressTest01
(
	IN		TBX_MSG_HANDLE				in_hMsg,
	IN		PTBX_CHAR					in_pszTestParameter
);

TBX_RESULT	VoipStopStressTest01
(
	IN		TBX_MSG_HANDLE				in_hMsg,
	IN		PTBX_CHAR					in_pszTestParameter
);

TBX_RESULT	VoipStopStressTest01ByItself
(
	IN		PTBX_CHAR					in_pszAdapterName,
	IN		TBX_RESULT					in_result
);

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


#endif /* __VOIP_AUTO_TEST_H__ */