rtxSocket.h

Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 2003-2017 Objective Systems, Inc.
00003  *
00004  * This software is furnished under a license and may be used and copied
00005  * only in accordance with the terms of such license and with the
00006  * inclusion of the above copyright notice. This software or any other
00007  * copies thereof may not be provided or otherwise made available to any
00008  * other person. No title to and ownership of the software is hereby
00009  * transferred.
00010  *
00011  * The information in this software is subject to change without notice
00012  * and should not be construed as a commitment by Objective Systems, Inc.
00013  *
00014  * PROPRIETARY NOTICE
00015  *
00016  * This software is an unpublished work subject to a confidentiality agreement
00017  * and is protected by copyright and trade secret law.  Unauthorized copying,
00018  * redistribution or other use of this work is prohibited.
00019  *
00020  * The above notice of copyright on this source code product does not indicate
00021  * any actual or intended publication of such source code.
00022  *
00023  *****************************************************************************/
00027 #ifndef _RTXSOCKET_H_
00028 #define _RTXSOCKET_H_
00029 
00030 #ifndef _OS_NOSOCKET
00031 
00032 #ifdef _WIN32_WCE
00033 #include <winsock.h>
00034 #define perror(a)
00035 #elif defined(_WIN32) || defined(_WIN64)
00036 #include <sys/types.h>
00037 #define INCL_WINSOCK_API_TYPEDEFS   1
00038 #define INCL_WINSOCK_API_PROTOTYPES 0
00039 #include <winsock2.h>
00040 #include <winerror.h>
00041 #include <tchar.h>
00042 #else
00043 #include <sys/types.h>
00044 #include <sys/time.h>
00045 #include <sys/socket.h>
00046 #include <netinet/in.h>
00047 #include <netdb.h>
00048 #include <unistd.h>
00049 #include <arpa/inet.h>
00050 #endif
00051 
00052 #include "rtxsrc/osSysTypes.h"
00053 #include "rtxsrc/rtxExternDefs.h"
00054 
00055 #ifdef __cplusplus
00056 extern "C" {
00057 #endif
00058 
00062 #if (defined (_WIN32) || defined (_WIN64)) && !defined(__SYMBIAN32__)
00063 typedef SOCKET OSRTSOCKET;
00064 #else
00065 typedef int OSRTSOCKET;
00066 #endif
00067 
00068 #define OSRTSOCKET_INVALID ((OSRTSOCKET)-1)
00069 
00080 typedef unsigned long OSIPADDR;
00081 
00082 #define OSIPADDR_ANY   ((OSIPADDR)0)
00083 #define OSIPADDR_LOCAL ((OSIPADDR)0x7f000001UL) /* 127.0.0.1 */
00084 
00085 struct in_addr;
00086 
00106 EXTERNRT int rtxSocketAccept (OSRTSOCKET socket, OSRTSOCKET *pNewSocket,
00107                               OSIPADDR* destAddr, int* destPort);
00108 
00119 EXTERNRT int rtxSocketAddrToStr (OSIPADDR ipAddr, char* pbuf, size_t bufsize);
00120 
00134 EXTERNRT int rtxSocketBind (OSRTSOCKET socket, OSIPADDR addr, int port);
00135 
00144 EXTERNRT int rtxSocketClose (OSRTSOCKET socket);
00145 
00161 EXTERNRT int rtxSocketConnect (OSRTSOCKET socket, const char* host, int port);
00162 
00179 EXTERNRT int rtxSocketConnectTimed
00180 (OSRTSOCKET socket, const char* host, int port, int nsecs);
00181 
00190 EXTERNRT int rtxSocketCreate (OSRTSOCKET* psocket);
00191 
00192 /*
00193  * This function creates a UDP socket.
00194  *
00195  * @param psocket    The Pointer to the socket handle variable to receive
00196  *                   the handle of the new socket.
00197  *
00198  * @return           0 upon success, < 0 upon failure. */
00199 EXTERNRT int rtxSocketCreateUDP (OSRTSOCKET *psocket);
00200 
00210 EXTERNRT int rtxSocketGetHost (const char* host, struct in_addr *inaddr);
00211 
00219 EXTERNRT int rtxSocketsInit (OSVOIDARG);
00220 
00236 EXTERNRT int rtxSocketListen (OSRTSOCKET socket, int maxConnection);
00237 
00253 EXTERNRT int rtxSocketParseURL
00254 (char* url, char** protocol, char** address, int* port);
00255 
00268 EXTERNRT int rtxSocketRecv (OSRTSOCKET socket, OSOCTET* pbuf, size_t bufsize);
00269 
00286 EXTERNRT int rtxSocketRecvTimed
00287 (OSRTSOCKET socket, OSOCTET* pbuf, size_t bufsize, OSUINT32 secs);
00288 
00306 EXTERNRT int rtxSocketSelect (int nfds, fd_set* readfds, fd_set* writefds,
00307                               fd_set* exceptfds, struct timeval* timeout);
00308 
00321 EXTERNRT int rtxSocketSend
00322 (OSRTSOCKET socket, const OSOCTET* pdata, size_t size);
00323 
00333 EXTERNRT int rtxSocketSetBlocking (OSRTSOCKET socket, OSBOOL value);
00334 
00347 EXTERNRT int rtxSocketStrToAddr (const char* pIPAddrStr, OSIPADDR* pIPAddr);
00348 
00352 #ifdef __cplusplus
00353 }
00354 #endif
00355 
00356 #endif /* _OS_NOSOCKET */
00357 
00358 #endif /* _RTXSOCKET_H_ */
00359