vm_socket.h

audio-video-codecs.rar语音编解码器

/*
//
//                  INTEL CORPORATION PROPRIETARY INFORMATION
//     This software is supplied under the terms of a license agreement or
//     nondisclosure agreement with Intel Corporation and may not be copied
//     or disclosed except in accordance with the terms of that agreement.
//       Copyright(c) 2003-2006 Intel Corporation. All Rights Reserved.
//
*/

#ifndef __VM_SOCKET_H__
#define __VM_SOCKET_H__

#include "vm_types.h"

/*
 * TCP, UDP, and MCAST protocols are supported. The functions are as follows:
 *  vm_socket_init
 *  vm_socket_select/next
 *  vm_socket_accept (for TCP servers only)
 *  vm_socket_read/write
 *  vm_socket_close
 * where vm_socket_init initializes the connection for server or client. The
 * optional functions vm_socket_select and vm_socket_next are used to detect
 * if an accept, read or write operation is non-blocking. For TCP servers,
 * vm_socket_accept accepts an incoming connection and allocates a channel
 * for further communication. Then read/write operations can be performed on
 * the channel. For UDP/MCAST, no channel is required thus the read/write
 * operation can be performed directly. Finally, vm_socket_close closes the
 * socket.
 *
 * Channels
 *
 * A TCP server might accept multiple connections and then read/write to
 * those connections, or channels simutenously. The maximum number of
 * channels a socket can queue is VM_SOCKET_QUEUE. Upon vm_socket_accept,
 * a channel number (1..VM_SOCKET_QUEUE) is returned for subsequent read
 * and write. The channel can be droped by vm_socket_close_chn.
 *
 * For UDP/MCAST or TCP client, always use channel zero.
 *
 * Read/Write
 *
 * There is no garentee on the completeness of reading/writing to a socket.
 * The function vm_socket_read/write always returns the number of bytes
 * actually read/written. A returned value less than 1 indicates an error
 * on the channel and the channel is closed.
 *
 * MCAST Server/Client
 *
 * In the context, a MCAST server refers to the computer broadcasting
 * contents. A MCAST client refers to the computers receiving contents.
 *
 */

#ifdef __cplusplus
extern "C"
{
#endif /* __cplusplus */

typedef struct
{
   vm_char *hostname; /* hostname */
   Ipp16u port;       /* port number */
} vm_socket_host;

/* Initialize network connection and return socket handle.
 * hd       the returned socket handle.
 * local    the local interface to be binded.
 * remote   the remote interface to be binded.
 * flags    bit-or'ed socket flags
 *
 * In "local"/"remote", hostname can be NULL to indicate any interface.
 * Hostname can be either an IP address or a qualified domain name. Port
 * can be zero to indicate any port. For MCAST, "remote" specifies the
 * multicast group, which must fall into 224.0.0.0-239.255.255.255.
 */
#define VM_SOCKET_UDP    0x1    /* SOCKET_DGRAM   */
#define VM_SOCKET_MCAST  0x2    /* Multicasting   */
#define VM_SOCKET_SERVER 0x4    /* Network Server */

vm_status vm_socket_init(vm_socket *hd,              /* return socket handle */
                         vm_socket_host *local,      /* local binding */
                         vm_socket_host *remote,     /* remote binding */
                         Ipp32s flags);              /* bit-or'ed flags */

/* Wait until one of the sockets can accept connection or read/write
 * operations on the sockets can be performed without blocking.
 *
 * masks:       bit-or'ed masks
 * hidx:        the index of the socket that signals.
 * chn:         the channel that signals.
 * type:        the signal type
 *
 * The function vm_socket_select blocks until one of the sockets
 * signals and returns the number of signaled sockets. The function
 * vm_socket_next is then used to iterate via all signaled sockets.
 *
 * For portability, always iterate all singaled sockets and perform
 * necessary operations until vm_socket_next returns zero.
 */
#define VM_SOCKET_READ   0x1   /* test for read capability   */
#define VM_SOCKET_WRITE  0x2   /* test for write capability  */
#define VM_SOCKET_ACCEPT 0x4   /* test for accept capability */

Ipp32s vm_socket_select(vm_socket *handles, Ipp32s nhandle, Ipp32s masks);
Ipp32s vm_socket_next(vm_socket *handles, Ipp32s nhandle, Ipp32s *idx, Ipp32s *chn, Ipp32s *type);

/* Accept remote connection and return the channel number, to which subsequent
 * read and write are directed. Return -1 if failed.
 */
Ipp32s vm_socket_accept(vm_socket *handle);

/* Read data from a socket and return the number of bytes actually read.
 * In case of error or eof, return -1 or 0, and the channel is closed.
 * Use channel zero for TCP client, UDP or MCAST.
 */
Ipp32s vm_socket_read(vm_socket *handle, Ipp32s chn, void *buffer, Ipp32s nbytes);

/* Write data to a socket and return the number of bytes actually written.
 * In case of error or eof, return -1 or 0, and the channel is closed.
 * Use channel zero for TCP client, UDP or MCAST.
 */
Ipp32s vm_socket_write(vm_socket *handle, Ipp32s chn, void *buffer, Ipp32s nbytes);

/* clean up a socket channel */
void vm_socket_close_chn(vm_socket *handle, Ipp32s chn);

/* clean up all socket connections */
void vm_socket_close(vm_socket *handle);

/* get client IP for successefully initialized socket
* In case of error return -1.
*/
Ipp32s vm_socket_get_client_ip(vm_socket *handle, Ipp8u* buffer, Ipp32s len);

/*****************************************************************************/
/** Old part **/
#if defined(_WIN32) || defined (_WIN64) || defined(_WIN32_WCE)

typedef Ipp32s socklen_t;

Ipp32s vm_sock_startup(vm_char a, vm_char b);
Ipp32s vm_sock_cleanup(void);
Ipp32s vm_sock_host_by_name(vm_char *name, struct in_addr *paddr);

#define vm_sock_get_error() WSAGetLastError()

#else /* !(defined(_WIN32) || defined (_WIN64) || defined(_WIN32_WCE)) */

#include <netinet/in.h>
#include <netdb.h>
#include <sys/socket.h>
#include <unistd.h>
#include <errno.h>

typedef Ipp32s SOCKET;
enum
{
    INVALID_SOCKET              =-1,
    SOCKET_ERROR                =-1
};

typedef struct sockaddr_in SOCKADDR_IN;
typedef struct sockaddr * LPSOCKADDR;

#define vm_sock_startup(_a,_b) (0)
#define vm_sock_cleanup() (0)
#define closesocket close

#define vm_sock_get_error() errno

Ipp32s vm_sock_host_by_name(vm_char *name, struct in_addr *paddr);

#endif /* defined(_WIN32) || defined (_WIN64) || defined(_WIN32_WCE) */

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* __VM_SOCKET_H__ */