rvccore.h

基于h323协议的软phone

/***********************************************************************
Filename   : rvccore.h
Description: ccore 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: CCore}
	{superpackage: Common}
	{include: rvccore.h}
	{description:	
		{p: This library provides functions which require OS dependent implementations.}
	}
	{notes:
		{note:  Build related configuration settings are done via the global default.mak file.}
		{note:  Specific configurations for this library are done in the rvccoreconfig.h file
				and use options defined by the rvccoredefs.h file.}
	}
}
$*/

#ifndef RV_CCORE_H
#define RV_CCORE_H

#include "rvconfig.h"
#include "rvtypes.h"
#include "rverror.h"
#include "rvccoreconfig.h"

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

/* Prototypes: See documentation blocks below for details. */
RvStatus RvCCoreInit(void);
RvStatus RvCCoreEnd(void);
RVCOREAPI const RvChar * RVCALLCONV RvCCoreVersion(void);

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

#if defined(__cplusplus)
}
#endif 

/* Function Documentation */
/*$
{function:
	{name: RvCCoreInit}
	{superpackage: CCore}
	{include: rvccore.h}
	{description:
		{p: Initializes the all of the modules in the ccore library. Must be
			called before any other functions in this library are called.}
	}
	{proto: RvStatus RvCCoreInit(void);}
	{returns: RV_OK if successful otherwise an error code.}
	{notes:
		{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 RvCCoreEnd will not actually
				shut down until it has been called the same number of times.}
	}
}
$*/
/*$
{function:
	{name: RvCCoreEnd}
	{superpackage: CCore}
	{include: rvccore.h}
	{description:
		{p: Shuts down the all of the modules in the ccore library. No further
			calls to any other functions in this library may be made after this
			function is called.}
	}
	{proto: RvStatus RvCCoreEnd(void);}
	{returns: RV_OK if successful otherwise an error code.}
	{notes:
		{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 RvCCoreInit was called.}
	}
}
$*/
/*$
{function:
	{name: RvCCoreVersion}
	{superpackage: CCore}
	{include: rvccore.h}
	{description:
		{p: returns a pointer to a the version string for the ccore library.}
	}
	{proto: const RvChar *RvCCoreVersion(void);}
	{returns: a pointer to a the version string for the ccore library.}
}
$*/

#endif /* RV_CCORE_H */