net_Accept: -1 (infinite) delay is valid
[vlc.git] / include / vlc_network.h
1 /*****************************************************************************
2  * vlc_network.h: interface to communicate with network plug-ins
3  *****************************************************************************
4  * Copyright (C) 2002-2005 the VideoLAN team
5  * Copyright © 2006-2007 Rémi Denis-Courmont
6  * $Id$
7  *
8  * Authors: Christophe Massiot <massiot@via.ecp.fr>
9  *          Laurent Aimar <fenrir@via.ecp.fr>
10  *          Rémi Denis-Courmont <rem # videolan.org>
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25  *****************************************************************************/
26
27 #ifndef VLC_NETWORK_H
28 # define VLC_NETWORK_H
29
30 /**
31  * \file
32  * This file defines interface to communicate with network plug-ins
33  */
34
35 #if defined( WIN32 )
36 #   if !defined(UNDER_CE)
37 #       define _NO_OLDNAMES 1
38 #       include <io.h>
39 #   endif
40 #   include <winsock2.h>
41 #   include <ws2tcpip.h>
42 #   define ENETUNREACH WSAENETUNREACH
43 #   define net_errno (WSAGetLastError())
44 extern const char *net_strerror( int val );
45
46 struct iovec
47 {
48     void  *iov_base;
49     size_t iov_len;
50 };
51
52 struct msghdr
53 {
54     void         *msg_name;
55     size_t        msg_namelen;
56     struct iovec *msg_iov;
57     size_t        msg_iovlen;
58     void         *msg_control;
59     size_t        msg_controllen;
60     int           msg_flags;
61 };
62
63 #define sendmsg vlc_sendmsg
64 #define recvmsg vlc_recvmsg
65
66 #   ifndef IPV6_V6ONLY
67 #       define IPV6_V6ONLY 27
68 #   endif
69 #else
70 #   include <sys/socket.h>
71 #   ifdef HAVE_NETINET_IN_H
72 #      include <netinet/in.h>
73 #   endif
74 #   ifdef HAVE_ARPA_INET_H
75 #      include <arpa/inet.h>
76 #   elif defined( SYS_BEOS )
77 #      include <net/netdb.h>
78 #   endif
79 #   include <netdb.h>
80 #   define net_errno errno
81 #endif
82
83 VLC_EXPORT( ssize_t, vlc_sendmsg, ( int, struct msghdr *, int ) );
84 VLC_EXPORT( ssize_t, vlc_recvmsg, ( int, struct msghdr *, int ) );
85
86 # ifdef __cplusplus
87 extern "C" {
88 # endif
89
90 /* Portable networking layer communication */
91 int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
92 int net_SetupSocket (int fd);
93
94 #define net_Connect(a, b, c, d, e) __net_Connect(VLC_OBJECT(a), b, c, d, e)
95 VLC_EXPORT( int, __net_Connect, (vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol) );
96
97 VLC_EXPORT( int *, net_Listen, (vlc_object_t *p_this, const char *psz_host, int i_port, int protocol) );
98
99 #define net_ListenTCP(a, b, c) net_Listen(VLC_OBJECT(a), b, c, IPPROTO_TCP)
100 #define net_ConnectTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)
101
102 static inline int __net_ConnectTCP (vlc_object_t *obj, const char *host, int port)
103 {
104     return __net_Connect (obj, host, port, SOCK_STREAM, IPPROTO_TCP);
105 }
106
107
108 VLC_EXPORT( int, net_AcceptSingle, (vlc_object_t *obj, int lfd) );
109
110 VLC_EXPORT( int, __net_Accept, ( vlc_object_t *, int *, mtime_t ) );
111 #define net_Accept(a, b, c) \
112       __net_Accept(VLC_OBJECT(a), b, (c == -1) ? -1 : (c ? check_delay(c) : 0))
113
114 #define net_ConnectDgram(a, b, c, d, e ) __net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
115 VLC_EXPORT( int, __net_ConnectDgram, ( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto ) );
116
117 static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
118 {
119     return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
120 }
121
122 #define net_OpenDgram( a, b, c, d, e, g, h ) __net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g, h)
123 VLC_EXPORT( int, __net_OpenDgram, ( vlc_object_t *p_this, const char *psz_bind, int i_bind, const char *psz_server, int i_server, int family, int proto ) );
124
125 static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
126 {
127     return net_OpenDgram (obj, host, port, NULL, 0, 0, IPPROTO_UDP);
128 }
129
130 VLC_EXPORT( void, net_ListenClose, ( int *fd ) );
131
132 int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
133                    socklen_t addrlen);
134
135 VLC_EXPORT( int, net_SetCSCov, ( int fd, int sendcov, int recvcov ) );
136
137 /* Functions to read from or write to the networking layer */
138 struct virtual_socket_t
139 {
140     void *p_sys;
141     int (*pf_recv) ( void *, void *, int );
142     int (*pf_send) ( void *, const void *, int );
143 };
144
145 #define net_Read(a,b,c,d,e,f) __net_Read(VLC_OBJECT(a),b,c,d,e,f)
146 VLC_EXPORT( ssize_t, __net_Read, ( vlc_object_t *p_this, int fd, const v_socket_t *, uint8_t *p_data, size_t i_data, bool b_retry ) );
147
148 #define net_Write(a,b,c,d,e) __net_Write(VLC_OBJECT(a),b,c,d,e)
149 VLC_EXPORT( ssize_t, __net_Write, ( vlc_object_t *p_this, int fd, const v_socket_t *, const uint8_t *p_data, size_t i_data ) );
150
151 #define net_Gets(a,b,c) __net_Gets(VLC_OBJECT(a),b,c)
152 VLC_EXPORT( char *, __net_Gets, ( vlc_object_t *p_this, int fd, const v_socket_t * ) );
153
154 VLC_EXPORT( ssize_t, net_Printf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, ... ) LIBVLC_FORMAT( 4, 5 ) );
155
156 #define net_vaPrintf(a,b,c,d,e) __net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
157 VLC_EXPORT( ssize_t, __net_vaPrintf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args ) );
158
159
160 /* Don't go to an extra call layer if we have the symbol */
161 #ifndef HAVE_INET_PTON
162 #define inet_pton vlc_inet_pton
163 #endif
164 #ifndef HAVE_INET_NTOP
165 #define inet_ntop vlc_inet_ntop
166 #endif
167
168 VLC_EXPORT (int, vlc_inet_pton, (int af, const char *src, void *dst) );
169 VLC_EXPORT (const char *, vlc_inet_ntop, (int af, const void *src,
170                                           char *dst, socklen_t cnt) );
171
172 #ifndef HAVE_POLL
173 enum
174 {
175     POLLIN=1,
176     POLLOUT=2,
177     POLLPRI=4,
178     POLLERR=8,  // unsupported stub
179     POLLHUP=16, // unsupported stub
180     POLLNVAL=32 // unsupported stub
181 };
182
183 struct pollfd
184 {
185     int fd;
186     int events;
187     int revents;
188 };
189 # define poll(a, b, c) vlc_poll(a, b, c)
190 #endif
191 struct pollfd;
192 VLC_EXPORT (int, vlc_poll, (struct pollfd *fds, unsigned nfds, int timeout));
193
194
195 #ifdef WIN32
196 /* Microsoft: same semantic, same value, different name... go figure */
197 # define SHUT_RD SD_RECEIVE
198 # define SHUT_WR SD_SEND
199 # define SHUT_RDWR SD_BOTH
200 # define net_Close( fd ) closesocket ((SOCKET)fd)
201 #else
202 #ifdef HAVE_UNISTD_H
203 #include <unistd.h>
204 #endif
205 # define net_Close( fd ) (void)close (fd)
206 #endif
207
208 /* Portable network names/addresses resolution layer */
209
210 /* GAI error codes */
211 # ifndef EAI_BADFLAGS
212 #  define EAI_BADFLAGS -1
213 # endif
214 # ifndef EAI_NONAME
215 #  define EAI_NONAME -2
216 # endif
217 # ifndef EAI_AGAIN
218 #  define EAI_AGAIN -3
219 # endif
220 # ifndef EAI_FAIL
221 #  define EAI_FAIL -4
222 # endif
223 # ifndef EAI_NODATA
224 #  define EAI_NODATA -5
225 # endif
226 # ifndef EAI_FAMILY
227 #  define EAI_FAMILY -6
228 # endif
229 # ifndef EAI_SOCKTYPE
230 #  define EAI_SOCKTYPE -7
231 # endif
232 # ifndef EAI_SERVICE
233 #  define EAI_SERVICE -8
234 # endif
235 # ifndef EAI_ADDRFAMILY
236 #  define EAI_ADDRFAMILY -9
237 # endif
238 # ifndef EAI_MEMORY
239 #  define EAI_MEMORY -10
240 # endif
241 #ifndef EAI_OVERFLOW
242 #  define EAI_OVERFLOW -11
243 #endif
244 # ifndef EAI_SYSTEM
245 #  define EAI_SYSTEM -12
246 # endif
247
248
249 # ifndef NI_MAXHOST
250 #  define NI_MAXHOST 1025
251 #  define NI_MAXSERV 32
252 # endif
253 # define NI_MAXNUMERICHOST 64
254
255 # ifndef NI_NUMERICHOST
256 #  define NI_NUMERICHOST 0x01
257 #  define NI_NUMERICSERV 0x02
258 #  define NI_NOFQDN      0x04
259 #  define NI_NAMEREQD    0x08
260 #  define NI_DGRAM       0x10
261 # endif
262
263 # ifndef HAVE_STRUCT_ADDRINFO
264 struct addrinfo
265 {
266     int ai_flags;
267     int ai_family;
268     int ai_socktype;
269     int ai_protocol;
270     size_t ai_addrlen;
271     struct sockaddr *ai_addr;
272     char *ai_canonname;
273     struct addrinfo *ai_next;
274 };
275 #  define AI_PASSIVE     1
276 #  define AI_CANONNAME   2
277 #  define AI_NUMERICHOST 4
278 # endif /* if !HAVE_STRUCT_ADDRINFO */
279
280 #ifndef AI_NUMERICSERV
281 # define AI_NUMERICSERV 0
282 #endif
283
284 VLC_EXPORT( const char *, vlc_gai_strerror, ( int ) );
285 VLC_EXPORT( int, vlc_getnameinfo, ( const struct sockaddr *, int, char *, int, int *, int ) );
286 VLC_EXPORT( int, vlc_getaddrinfo, ( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** ) );
287 VLC_EXPORT( void, vlc_freeaddrinfo, ( struct addrinfo * ) );
288
289
290 static inline bool
291 net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
292 {
293     switch (addr->sa_family)
294     {
295 #ifdef IN_MULTICAST
296         case AF_INET:
297         {
298             const struct sockaddr_in *v4 = (const struct sockaddr_in *)addr;
299             if ((size_t)len < sizeof (*v4))
300                 return false;
301             return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
302         }
303 #endif
304
305 #ifdef IN6_IS_ADDR_MULTICAST
306         case AF_INET6:
307         {
308             const struct sockaddr_in6 *v6 = (const struct sockaddr_in6 *)addr;
309             if ((size_t)len < sizeof (*v6))
310                 return false;
311             return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
312         }
313 #endif
314     }
315
316     return false;
317 }
318
319
320 static inline int net_GetSockAddress( int fd, char *address, int *port )
321 {
322     struct sockaddr_storage addr;
323     socklen_t addrlen = sizeof( addr );
324
325     return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
326         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
327                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
328         ? VLC_EGENERIC : 0;
329 }
330
331 static inline int net_GetPeerAddress( int fd, char *address, int *port )
332 {
333     struct sockaddr_storage addr;
334     socklen_t addrlen = sizeof( addr );
335
336     return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
337         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
338                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
339         ? VLC_EGENERIC : 0;
340 }
341
342 static inline uint16_t net_GetPort (const struct sockaddr *addr)
343 {
344     switch (addr->sa_family)
345     {
346 #ifdef AF_INET6
347         case AF_INET6:
348             return ((const struct sockaddr_in6 *)addr)->sin6_port;
349 #endif
350         case AF_INET:
351             return ((const struct sockaddr_in *)addr)->sin_port;
352     }
353     return 0;
354 }
355
356 static inline void net_SetPort (struct sockaddr *addr, uint16_t port)
357 {
358     switch (addr->sa_family)
359     {
360 #ifdef AF_INET6
361         case AF_INET6:
362             ((struct sockaddr_in6 *)addr)->sin6_port = port;
363         break;
364 #endif
365         case AF_INET:
366             ((struct sockaddr_in *)addr)->sin_port = port;
367         break;
368     }
369 }
370 # ifdef __cplusplus
371 }
372 # endif
373
374 #endif