rtxSocket.h

Go to the documentation of this file.

/*
 * Copyright (c) 2003-2023 Objective Systems, Inc.
 *
 * This software is furnished under a license and may be used and copied
 * only in accordance with the terms of such license and with the
 * inclusion of the above copyright notice. This software or any other
 * copies thereof may not be provided or otherwise made available to any
 * other person. No title to and ownership of the software is hereby
 * transferred.
 *
 * The information in this software is subject to change without notice
 * and should not be construed as a commitment by Objective Systems, Inc.
 *
 * PROPRIETARY NOTICE
 *
 * This software is an unpublished work subject to a confidentiality agreement
 * and is protected by copyright and trade secret law.  Unauthorized copying,
 * redistribution or other use of this work is prohibited.
 *
 * The above notice of copyright on this source code product does not indicate
 * any actual or intended publication of such source code.
 *
 *****************************************************************************/
#ifndef _RTXSOCKET_H_
#define _RTXSOCKET_H_

#ifndef _OS_NOSOCKET

#ifdef _WIN32_WCE
#include <winsock.h>
#define perror(a)
#elif defined(_WIN32) || defined(_WIN64)
#include <sys/types.h>
#define INCL_WINSOCK_API_TYPEDEFS   1
#define INCL_WINSOCK_API_PROTOTYPES 0
#include <winsock2.h>
#include <winerror.h>
#include <tchar.h>
#else
#include <sys/types.h>
#include <sys/time.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <netdb.h>
#include <unistd.h>
#include <arpa/inet.h>
#endif

#include "rtxsrc/osSysTypes.h"
#include "rtxsrc/rtxExternDefs.h"

#ifdef __cplusplus
extern "C" {
#endif

#if (defined (_WIN32) || defined (_WIN64)) && !defined(__SYMBIAN32__)
typedef SOCKET OSRTSOCKET;
#else
typedef int OSRTSOCKET;
#endif

#define OSRTSOCKET_INVALID ((OSRTSOCKET)-1)

typedef unsigned long OSIPADDR;

#define OSIPADDR_ANY   ((OSIPADDR)0)
#define OSIPADDR_LOCAL ((OSIPADDR)0x7f000001UL) /* 127.0.0.1 */

struct in_addr;

EXTERNRT int rtxSocketAccept (OSRTSOCKET socket, OSRTSOCKET *pNewSocket,
                              OSIPADDR* destAddr, int* destPort);

EXTERNRT int rtxSocketAddrToStr (OSIPADDR ipAddr, char* pbuf, size_t bufsize);

EXTERNRT int rtxSocketBind (OSRTSOCKET socket, OSIPADDR addr, int port);

EXTERNRT int rtxSocketClose (OSRTSOCKET socket);

EXTERNRT int rtxSocketConnect (OSRTSOCKET socket, const char* host, int port);

EXTERNRT int rtxSocketConnectTimed
(OSRTSOCKET socket, const char* host, int port, int nsecs);

EXTERNRT int rtxSocketCreate (OSRTSOCKET* psocket);

/*
 * This function creates a UDP socket.
 *
 * @param psocket    The Pointer to the socket handle variable to receive
 *                   the handle of the new socket.
 *
 * @return           0 upon success, < 0 upon failure. */
EXTERNRT int rtxSocketCreateUDP (OSRTSOCKET *psocket);

EXTERNRT int rtxSocketGetHost (const char* host, struct in_addr *inaddr);

EXTERNRT int rtxSocketsInit (OSVOIDARG);

EXTERNRT int rtxSocketListen (OSRTSOCKET socket, int maxConnection);

EXTERNRT int rtxSocketParseURL
(char* url, char** protocol, char** address, int* port);

EXTERNRT int rtxSocketRecv (OSRTSOCKET socket, OSOCTET* pbuf, size_t bufsize);

EXTERNRT int rtxSocketRecvTimed
(OSRTSOCKET socket, OSOCTET* pbuf, size_t bufsize, OSUINT32 secs);

EXTERNRT int rtxSocketSelect (int nfds, fd_set* readfds, fd_set* writefds,
                              fd_set* exceptfds, struct timeval* timeout);

EXTERNRT int rtxSocketSend
(OSRTSOCKET socket, const OSOCTET* pdata, size_t size);

EXTERNRT int rtxSocketSetBlocking (OSRTSOCKET socket, OSBOOL value);

EXTERNRT int rtxSocketStrToAddr (const char* pIPAddrStr, OSIPADDR* pIPAddr);

#ifdef __cplusplus
}
#endif

#endif /* _OS_NOSOCKET */

#endif /* _RTXSOCKET_H_ */