rvclock.h

来自「基于h323协议的软phone」· C头文件 代码 · 共 139 行

/***********************************************************************
Filename   : rvclock.h
Description: rvclock 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: Clock}
    {superpackage: CCore}
    {include: rvclock.h}
    {description:
        {p: This module provides functions for accessing the wall clock (time of day).}
    }
}
$*/
#ifndef RV_CLOCK_H
#define RV_CLOCK_H

#include "rvccore.h"
#include "rvtime.h"

#if !defined(RV_CLOCK_TYPE) || ((RV_CLOCK_TYPE != RV_CLOCK_LINUX) && \
    (RV_CLOCK_TYPE != RV_CLOCK_VXWORKS) && (RV_CLOCK_TYPE != RV_CLOCK_PSOS) && \
    (RV_CLOCK_TYPE != RV_CLOCK_OSE) && (RV_CLOCK_TYPE != RV_CLOCK_NUCLEUS) && \
    (RV_CLOCK_TYPE != RV_CLOCK_SOLARIS) && (RV_CLOCK_TYPE != RV_CLOCK_WIN32) && \
    (RV_CLOCK_TYPE != RV_CLOCK_TRU64) && (RV_CLOCK_TYPE != RV_CLOCK_UNIXWARE))
#error RV_CLOCK_TYPE not set properly
#endif

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

/* Prototypes: See documentation blocks below for details. */
RvStatus RvClockInit(void);
RvStatus RvClockEnd(void);
RVCOREAPI RvInt32 RVCALLCONV RvClockGet(RvTime *t);
RvInt32 RvClockResolution(RvTime *t);
RvStatus RvClockSet(const RvTime *t);

#if defined(RV_TEST_CODE)
void RvClockTest(void);
#endif /* RV_TEST_CODE */

#if defined(__cplusplus)
}
#endif
/* Function Documentation */
/*$
{function scope="protected":
    {name: RvClockInit}
    {superpackage: Clock}
    {include: rvclock.h}
    {description:
        {p: Initializes the Clock module. Must be called once (and
            only once) before any other functions in the module are called.}
    }
    {proto: RvStatus RvClockInit(void); }
    {returns: RV_OK if successful otherwise an error code.}
}
$*/
/*$
{function scope="protected":
    {name: RvClockEnd}
    {superpackage: Clock}
    {include: rvclock.h}
    {description:
        {p: Shuts down the Clock module. Must be called once (and
            only once) when no further calls to this module will be made.}
    }
    {proto: RvStatus RvClockEnd(void);}
    {returns: RV_OK if successful otherwise an error code.}
}
$*/
/*$
{function:
    {name: RvClockGet}
    {superpackage: Clock}
    {include: rvclock.h}
    {description:
        {p: Gets time of day in seconds and nanoseconds since January 1, 1970.
            If NULL, the seconds will still be returned.}
    }
    {proto: RvInt32 RvClockGet(RvTime *t);}
    {params:
        {param: {n: t}  {d: Pointer to time structure where time will be stored.}}
    }
    {returns: number of seconds since January 1, 1970.}
}
$*/
/*$
{function:
    {name: RvClockResolution}
    {superpackage: Clock}
    {include: rvclock.h}
    {description:
        {p: Gets the resolution of the wall clock in seconds and nanoseconds.}
    }
    {proto: RvInt32 RvClockResolution(RvTime *t);}
    {params:
        {param: {n: t}  {d: Pointer to time structure where resolution will be stored.
                            If NULL, the nanseconds will still be returned.}}
    }
    {returns: nanoseconds portion of the clock resoultion.}
}
$*/
/*$
{function:
    {name: RvClockSet}
    {superpackage: Clock}
    {include: rvclock.h}
    {description:
        {p: Sets time of day in seconds and nanoseconds since January 1, 1970.}
    }
    {proto: RvInt32 RvClockSet(const RvTime *t);}
    {params:
        {param: {n: t}  {d: Pointer to time structure with the time to be set.}}
    }
    {returns: RV_OK if successful otherwise an error code.}
    {notes:
        {note: On some systems the nanoseconds portion of the time will be ignored.}
        {note: On some systems setting the clock requires special privledges.}
    }
}
$*/

#endif