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
8 * Authors: Christophe Massiot <massiot@via.ecp.fr>
9 * Laurent Aimar <fenrir@via.ecp.fr>
10 * Rémi Denis-Courmont <rem # videolan.org>
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.
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.
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 *****************************************************************************/
27 #if !defined( __LIBVLC__ )
28 #error You are not libvlc or one of its plugins. You cannot include this file
31 #ifndef __VLC_NETWORK_H
32 # define __VLC_NETWORK_H
35 # if !defined(UNDER_CE)
36 # define _NO_OLDNAMES 1
39 # include <winsock2.h>
40 # include <ws2tcpip.h>
41 # define ENETUNREACH WSAENETUNREACH
42 # define net_errno (WSAGetLastError())
43 extern const char *net_strerror( int val );
45 # define IPV6_V6ONLY 27
48 # include <sys/socket.h>
49 # ifdef HAVE_NETINET_IN_H
50 # include <netinet/in.h>
52 # ifdef HAVE_ARPA_INET_H
53 # include <arpa/inet.h>
54 # elif defined( SYS_BEOS )
55 # include <net/netdb.h>
58 # define net_errno errno
65 /* Portable networking layer communication */
66 int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
67 int net_SetupSocket (int fd);
69 #define net_Connect(a, b, c, d, e) __net_Connect(VLC_OBJECT(a), b, c, d, e)
70 VLC_EXPORT( int, __net_Connect, (vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol) );
72 VLC_EXPORT( int *, net_Listen, (vlc_object_t *p_this, const char *psz_host, int i_port, int protocol) );
74 #define net_ListenTCP(a, b, c) net_Listen(VLC_OBJECT(a), b, c, IPPROTO_TCP)
75 #define net_ConnectTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)
77 static inline int __net_ConnectTCP (vlc_object_t *obj, const char *host, int port)
79 return __net_Connect (obj, host, port, SOCK_STREAM, IPPROTO_TCP);
83 VLC_EXPORT( int, net_AcceptSingle, (vlc_object_t *obj, int lfd) );
85 #define net_Accept(a, b, c) __net_Accept(VLC_OBJECT(a), b, c)
86 VLC_EXPORT( int, __net_Accept, ( vlc_object_t *, int *, mtime_t ) );
88 #define net_ConnectDgram(a, b, c, d, e ) __net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
89 VLC_EXPORT( int, __net_ConnectDgram, ( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto ) );
91 static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
93 return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
96 #define net_OpenDgram( a, b, c, d, e, g, h ) __net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g, h)
97 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 ) );
99 static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
101 return net_OpenDgram (obj, host, port, NULL, 0, 0, IPPROTO_UDP);
104 VLC_EXPORT( void, net_ListenClose, ( int *fd ) );
106 int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
109 VLC_EXPORT( int, net_SetCSCov, ( int fd, int sendcov, int recvcov ) );
111 /* Functions to read from or write to the networking layer */
112 struct virtual_socket_t
115 int (*pf_recv) ( void *, void *, int );
116 int (*pf_send) ( void *, const void *, int );
119 #define net_Read(a,b,c,d,e,f) __net_Read(VLC_OBJECT(a),b,c,d,e,f)
120 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, vlc_bool_t b_retry ) );
122 #define net_Write(a,b,c,d,e) __net_Write(VLC_OBJECT(a),b,c,d,e)
123 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 ) );
125 #define net_Gets(a,b,c) __net_Gets(VLC_OBJECT(a),b,c)
126 VLC_EXPORT( char *, __net_Gets, ( vlc_object_t *p_this, int fd, const v_socket_t * ) );
128 VLC_EXPORT( ssize_t, net_Printf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, ... ) ATTRIBUTE_FORMAT( 4, 5 ) );
130 #define net_vaPrintf(a,b,c,d,e) __net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
131 VLC_EXPORT( ssize_t, __net_vaPrintf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args ) );
134 #ifndef HAVE_INET_PTON
135 /* only in core, so no need for C++ extern "C" */
136 VLC_EXPORT (int, inet_pton, (int af, const char *src, void *dst) );
139 #ifndef HAVE_INET_NTOP
141 /* only in core, so no need for C++ extern "C" */
142 VLC_EXPORT (const char *, inet_ntop, (int af, const void *src,
143 char *dst, socklen_t cnt) );
153 POLLERR=8, // unsupported stub
154 POLLHUP=16, // unsupported stub
155 POLLNVAL=32 // unsupported stub
165 VLC_EXPORT (int, poll, (struct pollfd *fds, unsigned nfds, int timeout));
169 /* Microsoft: same semantic, same value, different name... go figure */
170 # define SHUT_RD SD_RECEIVE
171 # define SHUT_WR SD_SEND
172 # define SHUT_RDWR SD_BOTH
173 # define net_Close( fd ) closesocket ((SOCKET)fd)
178 # define net_Close( fd ) (void)close (fd)
181 /* Portable network names/addresses resolution layer */
183 /* GAI error codes */
184 # ifndef EAI_BADFLAGS
185 # define EAI_BADFLAGS -1
188 # define EAI_NONAME -2
191 # define EAI_AGAIN -3
197 # define EAI_NODATA -5
200 # define EAI_FAMILY -6
202 # ifndef EAI_SOCKTYPE
203 # define EAI_SOCKTYPE -7
206 # define EAI_SERVICE -8
208 # ifndef EAI_ADDRFAMILY
209 # define EAI_ADDRFAMILY -9
212 # define EAI_MEMORY -10
215 # define EAI_OVERFLOW -11
218 # define EAI_SYSTEM -12
223 # define NI_MAXHOST 1025
224 # define NI_MAXSERV 32
226 # define NI_MAXNUMERICHOST 64
228 # ifndef NI_NUMERICHOST
229 # define NI_NUMERICHOST 0x01
230 # define NI_NUMERICSERV 0x02
231 # define NI_NOFQDN 0x04
232 # define NI_NAMEREQD 0x08
233 # define NI_DGRAM 0x10
236 # ifndef HAVE_STRUCT_ADDRINFO
244 struct sockaddr *ai_addr;
246 struct addrinfo *ai_next;
248 # define AI_PASSIVE 1
249 # define AI_CANONNAME 2
250 # define AI_NUMERICHOST 4
251 # endif /* if !HAVE_STRUCT_ADDRINFO */
253 VLC_EXPORT( const char *, vlc_gai_strerror, ( int ) );
254 VLC_EXPORT( int, vlc_getnameinfo, ( const struct sockaddr *, int, char *, int, int *, int ) );
255 VLC_EXPORT( int, vlc_getaddrinfo, ( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** ) );
256 VLC_EXPORT( void, vlc_freeaddrinfo, ( struct addrinfo * ) );
259 static inline vlc_bool_t
260 net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
262 switch (addr->sa_family)
267 const struct sockaddr_in *v4 = (const struct sockaddr_in *)addr;
268 if ((size_t)len < sizeof (*v4))
270 return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
274 #ifdef IN6_IS_ADDR_MULTICAST
277 const struct sockaddr_in6 *v6 = (const struct sockaddr_in6 *)addr;
278 if ((size_t)len < sizeof (*v6))
280 return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
289 static inline int net_GetSockAddress( int fd, char *address, int *port )
291 struct sockaddr_storage addr;
292 socklen_t addrlen = sizeof( addr );
294 return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
295 || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
296 NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
300 static inline int net_GetPeerAddress( int fd, char *address, int *port )
302 struct sockaddr_storage addr;
303 socklen_t addrlen = sizeof( addr );
305 return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
306 || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
307 NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
311 static inline uint16_t net_GetPort (const struct sockaddr *addr)
313 switch (addr->sa_family)
317 return ((const struct sockaddr_in6 *)addr)->sin6_port;
320 return ((const struct sockaddr_in *)addr)->sin_port;
325 static inline void net_SetPort (struct sockaddr *addr, uint16_t port)
327 switch (addr->sa_family)
331 ((struct sockaddr_in6 *)addr)->sin6_port = port;
335 ((struct sockaddr_in *)addr)->sin_port = port;