2 * Copyright (c) 2002 - 2003
3 * NetGroup, Politecnico di Torino (Italy)
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the Politecnico di Torino nor the names of its
16 * contributors may be used to endorse or promote products derived from
17 * this software without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 #ifndef __SOCKUTILS_H__
34 #define __SOCKUTILS_H__
40 #include "pcap/socket.h"
44 #include <unistd.h> /* close() */
47 * \brief In Winsock, the close() call cannot be used on a socket;
48 * closesocket() must be used.
49 * We define closesocket() to be a wrapper around close() on UN*X,
50 * so that it can be used on both platforms.
52 #define closesocket(a) close(a)
56 * MingW headers include this definition, but only for Windows XP and above.
57 * MSDN states that this function is available for most versions on Windows.
59 #if ((defined(__MINGW32__)) && (_WIN32_WINNT < 0x0501))
60 int WSAAPI getnameinfo(const struct sockaddr*,socklen_t,char*,DWORD,
65 * \defgroup SockUtils Cross-platform socket utilities (IPv4-IPv6)
69 * \addtogroup SockUtils
74 * \defgroup ExportedStruct Exported Structures and Definitions
78 * \addtogroup ExportedStruct
82 /****************************************************
84 * Exported functions / definitions *
86 ****************************************************/
88 /* 'checkonly' flag, into the rpsock_bufferize() */
89 #define SOCKBUF_CHECKONLY 1
90 /* no 'checkonly' flag, into the rpsock_bufferize() */
91 #define SOCKBUF_BUFFERIZE 0
93 /* no 'server' flag; it opens a client socket */
94 #define SOCKOPEN_CLIENT 0
95 /* 'server' flag; it opens a server socket */
96 #define SOCKOPEN_SERVER 1
99 * Flags for sock_recv().
101 #define SOCK_RECEIVEALL_NO 0x00000000 /* Don't wait to receive all data */
102 #define SOCK_RECEIVEALL_YES 0x00000001 /* Wait to receive all data */
104 #define SOCK_EOF_ISNT_ERROR 0x00000000 /* Return 0 on EOF */
105 #define SOCK_EOF_IS_ERROR 0x00000002 /* Return an error on EOF */
116 * \defgroup ExportedFunc Exported Functions
120 * \addtogroup ExportedFunc
124 int sock_init(char *errbuf, int errbuflen);
125 void sock_cleanup(void);
126 void sock_fmterror(const char *caller, int errcode, char *errbuf, int errbuflen);
127 void sock_geterror(const char *caller, char *errbuf, int errbufsize);
128 int sock_initaddress(const char *address, const char *port,
129 struct addrinfo *hints, struct addrinfo **addrinfo,
130 char *errbuf, int errbuflen);
131 int sock_recv(SOCKET sock, void *buffer, size_t size, int receiveall,
132 char *errbuf, int errbuflen);
133 int sock_recv_dgram(SOCKET sock, void *buffer, size_t size,
134 char *errbuf, int errbuflen);
135 SOCKET sock_open(struct addrinfo *addrinfo, int server, int nconn, char *errbuf, int errbuflen);
136 int sock_close(SOCKET sock, char *errbuf, int errbuflen);
138 int sock_send(SOCKET sock, const char *buffer, size_t size,
139 char *errbuf, int errbuflen);
140 int sock_bufferize(const char *buffer, int size, char *tempbuf, int *offset, int totsize, int checkonly, char *errbuf, int errbuflen);
141 int sock_discard(SOCKET sock, int size, char *errbuf, int errbuflen);
142 int sock_check_hostlist(char *hostlist, const char *sep, struct sockaddr_storage *from, char *errbuf, int errbuflen);
143 int sock_cmpaddr(struct sockaddr_storage *first, struct sockaddr_storage *second);
145 int sock_getmyinfo(SOCKET sock, char *address, int addrlen, char *port, int portlen, int flags, char *errbuf, int errbuflen);
147 int sock_getascii_addrport(const struct sockaddr_storage *sockaddr, char *address, int addrlen, char *port, int portlen, int flags, char *errbuf, int errbuflen);
148 int sock_present2network(const char *address, struct sockaddr_storage *sockaddr, int addr_family, char *errbuf, int errbuflen);