/***********************************************************************
Filename   : rvhost.h
Description: host related functions
************************************************************************
        Copyright (c) 2001 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.
***********************************************************************/
#ifndef _RV_HOST_H
#define _RV_HOST_H

#include "rvccore.h"
#include "rvaddress.h"


/* Error checks to make sure configuration has been done properly */
#if !defined(RV_HOST_TYPE) || ((RV_HOST_TYPE != RV_HOST_BSD) && \
    (RV_HOST_TYPE != RV_HOST_POSIX) && (RV_HOST_TYPE != RV_HOST_VXWORKS) && \
    (RV_HOST_TYPE != RV_HOST_PSOS) && (RV_HOST_TYPE != RV_HOST_OSE) && \
    (RV_HOST_TYPE != RV_HOST_NUCLEUS) && (RV_HOST_TYPE != RV_HOST_WIN32))
#error RV_HOST_TYPE not set properly
#endif

#if !defined(RV_HOST_MAX_NAMESIZE) || (RV_HOST_MAX_NAMESIZE < 1)
#error RV_HOST_MAX_NAMESIZE not set properly
#endif

#if !defined(RV_HOST_MAX_ADDRS) || (RV_HOST_MAX_ADDRS < 1)
#error RV_HOST_MAX_ADDRS not set properly
#endif

#if !defined(RV_HOST_HAS_STATIC_ADDR) || (RV_HOST_HAS_STATIC_ADDR < 0) || (RV_HOST_HAS_STATIC_ADDR > 1)
#error RV_HOST_HAS_STATIC_ADDR not set properly
#endif

/* End of configuration error checks */


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


RvStatus RvHostInit(void);
RvStatus RvHostEnd(void);


/********************************************************************************************
 * RvHostLocalGetName
 *
 * purpose : Get the name of the local host.
 * input   : nameLength - Length of the name buffer in bytes
 * output  : name       - Null terminated name of the local host
 * return  : RV_OK on success
 *           Other values on failure
 ********************************************************************************************/
RVCOREAPI RvStatus RVCALLCONV RvHostLocalGetName(
    IN  RvSize_t    nameLength,
    OUT RvChar*     name);


/********************************************************************************************
 * RvHostLocalGetAddress
 *
 * purpose : Get the addresses of the local host.
 * input   : numberOfAddresses  - Maximum number of addresses to get
 *           addresses          - Array of addresses to fill in
 * output  : NumberOfAddresses  - Number of addresses filled in
 *           addresses          - Constructed addresses. These addresses should be destructed
 *                                using RvAddressDestruct() when not needed anymore.
 * return  : RV_OK on success
 *           Other values on failure
 ********************************************************************************************/
RVCOREAPI RvStatus RVCALLCONV RvHostLocalGetAddress(
    INOUT   RvUint32*   numberOfAddresses,
    INOUT   RvAddress*  addresses);



#if defined(__cplusplus)
}
#endif

#endif /* _RV_HOST_H */