rvcbase.h

基于h323协议的软phone

/***********************************************************************
Filename   : rvcbase.h
Description: cbase main header file
************************************************************************
      Copyright (c) 2001,2002 RADVISION Inc. and RADVISION Ltd.
************************************************************************
NOTICE:
This document contains information that is confidential and proprietary
to RADVISION Inc. and RADVISION Ltd.. No part of this document may be
reproduced in any form whatsoever without written prior approval by
RADVISION Inc. or RADVISION Ltd..

RADVISION Inc. and RADVISION Ltd. reserve the right to revise this
publication and make changes without obligation to notify any person of
such revisions or changes.
***********************************************************************/
/*$
{package:
	{name: CBase}
	{superpackage: Common}
	{include: rvcbase.h}
	{description:	
		{p: This library provides common functions which are OS independent but
			require the ccore library (and, thus, the cutils library).}
	}
	{notes:
		{note:  Build related configuration settings are done via the global default.mak file.}
		{note:  Specific configurations for this library are done in the rvcbaseconfig.h file
				and use options defined by the rvcbasedefs.h file.}
	}
}
$*/
#ifndef RV_CBASE_H
#define RV_CBASE_H

#include "rvccore.h"
#include "rvcbaseconfig.h"

/* Module codes (1..1023). One for each module in cbase. See rverror.h for details */
#define RV_CBASE_MODULE_CBASE 1
#define RV_CBASE_MODULE_QUEUE 2
#define RV_CBASE_MODULE_TIMER 3
#define RV_CBASE_MODULE_TIMERENGINE 4
#define RV_CBASE_MODULE_NETHOST 5
#define RV_CBASE_MODULE_IOLAYER 6
#define RV_CBASE_MODULE_DEFAULTNETDRV 7 /* default network driver */
#define RV_CBASE_MODULE_NETBUF 8

#if defined(__cplusplus)
extern "C" {
#endif

/* Prototypes: See documentation blocks below for details. */
RVCOREAPI RvStatus RVCALLCONV RvCBaseInit(void);
RVCOREAPI RvStatus RVCALLCONV RvCBaseEnd(void);
RVCOREAPI const RvChar * RVCALLCONV RvCBaseVersion(void);

#if defined(RV_TEST_CODE)
void RvCBaseTest(void);
#endif

#if defined(__cplusplus)
}
#endif

/* Function Documentation */
/*$
{function:
	{name: RvCBaseInit}
	{superpackage: CBase}
	{include: rvcbase.h}
	{description:
		{p: Initializes the all of the modules in the cbase library. Must be
			called before any other functions in this library are called.}
	}
	{proto: RvStatus RvCBaseInit(void);}
	{returns: RV_OK if successful otherwise an error code.}
	{notes:
		{note:  The CCore library must be initialized (with the RvCCoreInit function)
				before calling RvCbaseInit.}
		{note:  This function is not reentrant and it must not be called simultaneously
				from multiple threads.}
		{note:  Further calls to this function will do nothing except keep track of the
				number of times it has been called so that RvCBaseEnd will not actually
				shut down until it has been called the same number of times.}
	}
}
$*/
/*$
{function:
	{name: RvCBaseEnd}
	{superpackage: CBase}
	{include: rvcbase.h}
	{description:
		{p: Shuts down the all of the modules in the cbase library. No further
			calls to any other functions in this library may be made after this
			function is called.}
	}
	{proto: RvStatus RvCBaseEnd(void);}
	{returns: RV_OK if successful otherwise an error code.}
	{notes:
		{note:  The CCore library should not be shut down (using the RvCCoreEnd function)
				until after calling RvCbaseEnd.}
		{note:  This function is not reentrant and it must not be called simultaneously
				from multiple threads.}
		{note:  The shut down will not actually be performed until it has been called
				the same number of times that RvCBaseInit was called.}
	}
}
$*/
/*$
{function:
	{name: RvCBaseVersion}
	{superpackage: CBase}
	{include: rvcbase.h}
	{description:
		{p: returns a pointer to a the version string for the cbase library.}
	}
	{proto: const RvChar *RvCBaseVersion(void);}
	{returns: a pointer to a the version string for the cbase library.}
}
$*/

#endif /* RV_CBASE_H */