1 /*****************************************************************************
2 * vlc_network.h: interface to communicate with network plug-ins
3 *****************************************************************************
4 * Copyright (C) 2002-2005 VLC authors and VideoLAN
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 it
13 * under the terms of the GNU Lesser General Public License as published by
14 * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
22 * You should have received a copy of the GNU Lesser General Public License
23 * along with this program; if not, write to the Free Software Foundation,
24 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25 *****************************************************************************/
28 # define VLC_NETWORK_H
32 * This file defines interface to communicate with network plug-ins
36 # if !defined(UNDER_CE)
37 # define _NO_OLDNAMES 1
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 );
56 struct iovec *msg_iov;
59 size_t msg_controllen;
64 # define IPV6_V6ONLY 27
67 # include <sys/types.h>
69 # include <sys/socket.h>
70 # include <netinet/in.h>
72 # define net_errno errno
75 #if defined( __SYMBIAN32__ )
77 # undef IN6_IS_ADDR_MULTICAST
79 # undef IPV6_MULTICAST_HOPS
80 # undef IPV6_MULTICAST_IF
82 # undef IPV6_JOIN_GROUP
85 int vlc_socket (int, int, int, bool nonblock) VLC_USED;
88 VLC_API int vlc_accept( int, struct sockaddr *, socklen_t *, bool ) VLC_USED;
94 /* Portable networking layer communication */
95 int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
97 VLC_API int net_Connect(vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol);
98 #define net_Connect(a, b, c, d, e) net_Connect(VLC_OBJECT(a), b, c, d, e)
100 VLC_API int * net_Listen(vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol);
102 #define net_ListenTCP(a, b, c) net_Listen(VLC_OBJECT(a), b, c, \
103 SOCK_STREAM, IPPROTO_TCP)
105 static inline int net_ConnectTCP (vlc_object_t *obj, const char *host, int port)
107 return net_Connect (obj, host, port, SOCK_STREAM, IPPROTO_TCP);
109 #define net_ConnectTCP(a, b, c) net_ConnectTCP(VLC_OBJECT(a), b, c)
111 VLC_API int net_AcceptSingle(vlc_object_t *obj, int lfd);
113 VLC_API int net_Accept( vlc_object_t *, int * );
114 #define net_Accept(a, b) \
115 net_Accept(VLC_OBJECT(a), b)
117 VLC_API int net_ConnectDgram( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto );
118 #define net_ConnectDgram(a, b, c, d, e ) \
119 net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
121 static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
123 return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
126 VLC_API int net_OpenDgram( vlc_object_t *p_this, const char *psz_bind, int i_bind, const char *psz_server, int i_server, int proto );
127 #define net_OpenDgram( a, b, c, d, e, g ) \
128 net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g)
130 static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
132 return net_OpenDgram (obj, host, port, NULL, 0, IPPROTO_UDP);
135 VLC_API void net_ListenClose( int *fd );
137 int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
140 VLC_API int net_SetCSCov( int fd, int sendcov, int recvcov );
142 /* Functions to read from or write to the networking layer */
143 struct virtual_socket_t
146 int (*pf_recv) ( void *, void *, size_t );
147 int (*pf_send) ( void *, const void *, size_t );
150 VLC_API ssize_t net_Read( vlc_object_t *p_this, int fd, const v_socket_t *, void *p_data, size_t i_data, bool b_retry );
151 #define net_Read(a,b,c,d,e,f) net_Read(VLC_OBJECT(a),b,c,d,e,f)
152 VLC_API ssize_t net_Write( vlc_object_t *p_this, int fd, const v_socket_t *, const void *p_data, size_t i_data );
153 #define net_Write(a,b,c,d,e) net_Write(VLC_OBJECT(a),b,c,d,e)
154 VLC_API char * net_Gets( vlc_object_t *p_this, int fd, const v_socket_t * );
155 #define net_Gets(a,b,c) net_Gets(VLC_OBJECT(a),b,c)
158 VLC_API ssize_t net_Printf( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, ... ) VLC_FORMAT( 4, 5 );
159 #define net_Printf(o,fd,vs,...) net_Printf(VLC_OBJECT(o),fd,vs, __VA_ARGS__)
160 VLC_API ssize_t net_vaPrintf( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args );
161 #define net_vaPrintf(a,b,c,d,e) net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
164 /* Microsoft: same semantic, same value, different name... go figure */
165 # define SHUT_RD SD_RECEIVE
166 # define SHUT_WR SD_SEND
167 # define SHUT_RDWR SD_BOTH
168 # define net_Close( fd ) closesocket ((SOCKET)fd)
175 # define net_Close( fd ) (void)close (fd)
178 /* Portable network names/addresses resolution layer */
180 /* GAI error codes */
181 # ifndef EAI_BADFLAGS
182 # define EAI_BADFLAGS -1
185 # define EAI_NONAME -2
188 # define EAI_AGAIN -3
194 # define EAI_NODATA -5
197 # define EAI_FAMILY -6
199 # ifndef EAI_SOCKTYPE
200 # define EAI_SOCKTYPE -7
203 # define EAI_SERVICE -8
205 # ifndef EAI_ADDRFAMILY
206 # define EAI_ADDRFAMILY -9
209 # define EAI_MEMORY -10
212 # define EAI_OVERFLOW -11
215 # define EAI_SYSTEM -12
220 # define NI_MAXHOST 1025
221 # define NI_MAXSERV 32
223 # define NI_MAXNUMERICHOST 64
225 #ifndef AI_NUMERICSERV
226 # define AI_NUMERICSERV 0
230 # ifndef NI_NUMERICHOST
231 # define NI_NUMERICHOST 0x01
232 # define NI_NUMERICSERV 0x02
233 # define NI_NOFQDN 0x04
234 # define NI_NAMEREQD 0x08
235 # define NI_DGRAM 0x10
245 struct sockaddr *ai_addr;
247 struct addrinfo *ai_next;
250 # define AI_PASSIVE 1
251 # define AI_CANONNAME 2
252 # define AI_NUMERICHOST 4
254 VLC_API const char *gai_strerror( int errnum );
256 VLC_API int getaddrinfo ( const char *, const char *,
257 const struct addrinfo *, struct addrinfo ** );
258 VLC_API void freeaddrinfo( struct addrinfo * );
259 VLC_API int getnameinfo ( const struct sockaddr *, socklen_t,
260 char *, int, char *, int, int );
263 VLC_API int vlc_getnameinfo( const struct sockaddr *, int, char *, int, int *, int );
264 VLC_API int vlc_getaddrinfo( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** );
268 /* OS/2 does not support IPv6, yet. But declare these only for compilation */
279 uint32_t sin6_flowinfo;
280 struct in6_addr sin6_addr;
281 uint32_t sin6_scope_id;
284 # define IN6_IS_ADDR_MULTICAST(a) (((__const uint8_t *) (a))[0] == 0xff)
286 static const struct in6_addr in6addr_any =
287 { { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 } };
291 net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
293 switch (addr->sa_family)
298 const struct sockaddr_in *v4 = (const struct sockaddr_in *)addr;
299 if ((size_t)len < sizeof (*v4))
301 return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
305 #ifdef IN6_IS_ADDR_MULTICAST
308 const struct sockaddr_in6 *v6 = (const struct sockaddr_in6 *)addr;
309 if ((size_t)len < sizeof (*v6))
311 return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
320 static inline int net_GetSockAddress( int fd, char *address, int *port )
322 struct sockaddr_storage addr;
323 socklen_t addrlen = sizeof( addr );
325 return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
326 || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
327 NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
331 static inline int net_GetPeerAddress( int fd, char *address, int *port )
333 struct sockaddr_storage addr;
334 socklen_t addrlen = sizeof( addr );
336 return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
337 || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
338 NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
342 static inline uint16_t net_GetPort (const struct sockaddr *addr)
344 switch (addr->sa_family)
348 return ((const struct sockaddr_in6 *)addr)->sin6_port;
351 return ((const struct sockaddr_in *)addr)->sin_port;
356 static inline void net_SetPort (struct sockaddr *addr, uint16_t port)
358 switch (addr->sa_family)
362 ((struct sockaddr_in6 *)addr)->sin6_port = port;
366 ((struct sockaddr_in *)addr)->sin_port = port;