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 net_errno (WSAGetLastError())
43 extern const char *net_strerror( int val );
55 struct iovec *msg_iov;
58 size_t msg_controllen;
63 # define IPV6_V6ONLY 27
66 # include <sys/types.h>
68 # include <sys/socket.h>
69 # include <netinet/in.h>
71 # define net_errno errno
74 #if defined( __SYMBIAN32__ )
76 # undef IN6_IS_ADDR_MULTICAST
78 # undef IPV6_MULTICAST_HOPS
79 # undef IPV6_MULTICAST_IF
81 # undef IPV6_JOIN_GROUP
84 VLC_API int vlc_socket (int, int, int, bool nonblock) VLC_USED;
87 VLC_API int vlc_accept( int, struct sockaddr *, socklen_t *, bool ) VLC_USED;
93 /* Portable networking layer communication */
94 int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
96 VLC_API int net_Connect(vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol);
97 #define net_Connect(a, b, c, d, e) net_Connect(VLC_OBJECT(a), b, c, d, e)
99 VLC_API int * net_Listen(vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol);
101 #define net_ListenTCP(a, b, c) net_Listen(VLC_OBJECT(a), b, c, \
102 SOCK_STREAM, IPPROTO_TCP)
104 static inline int net_ConnectTCP (vlc_object_t *obj, const char *host, int port)
106 return net_Connect (obj, host, port, SOCK_STREAM, IPPROTO_TCP);
108 #define net_ConnectTCP(a, b, c) net_ConnectTCP(VLC_OBJECT(a), b, c)
110 VLC_API int net_AcceptSingle(vlc_object_t *obj, int lfd);
112 VLC_API int net_Accept( vlc_object_t *, int * );
113 #define net_Accept(a, b) \
114 net_Accept(VLC_OBJECT(a), b)
116 VLC_API int net_ConnectDgram( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto );
117 #define net_ConnectDgram(a, b, c, d, e ) \
118 net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
120 static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
122 return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
125 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 );
126 #define net_OpenDgram( a, b, c, d, e, g ) \
127 net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g)
129 static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
131 return net_OpenDgram (obj, host, port, NULL, 0, IPPROTO_UDP);
134 VLC_API void net_ListenClose( int *fd );
136 int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
139 VLC_API int net_SetCSCov( int fd, int sendcov, int recvcov );
141 /* Functions to read from or write to the networking layer */
142 struct virtual_socket_t
145 int (*pf_recv) ( void *, void *, size_t );
146 int (*pf_send) ( void *, const void *, size_t );
149 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 );
150 #define net_Read(a,b,c,d,e,f) net_Read(VLC_OBJECT(a),b,c,d,e,f)
151 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 );
152 #define net_Write(a,b,c,d,e) net_Write(VLC_OBJECT(a),b,c,d,e)
153 VLC_API char * net_Gets( vlc_object_t *p_this, int fd, const v_socket_t * );
154 #define net_Gets(a,b,c) net_Gets(VLC_OBJECT(a),b,c)
157 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 );
158 #define net_Printf(o,fd,vs,...) net_Printf(VLC_OBJECT(o),fd,vs, __VA_ARGS__)
159 VLC_API ssize_t net_vaPrintf( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args );
160 #define net_vaPrintf(a,b,c,d,e) net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
163 /* Microsoft: same semantic, same value, different name... go figure */
164 # define SHUT_RD SD_RECEIVE
165 # define SHUT_WR SD_SEND
166 # define SHUT_RDWR SD_BOTH
167 # define net_Close( fd ) closesocket ((SOCKET)fd)
174 # define net_Close( fd ) (void)close (fd)
177 /* Portable network names/addresses resolution layer */
179 /* GAI error codes */
180 # ifndef EAI_BADFLAGS
181 # define EAI_BADFLAGS -1
184 # define EAI_NONAME -2
187 # define EAI_AGAIN -3
193 # define EAI_NODATA -5
196 # define EAI_FAMILY -6
198 # ifndef EAI_SOCKTYPE
199 # define EAI_SOCKTYPE -7
202 # define EAI_SERVICE -8
204 # ifndef EAI_ADDRFAMILY
205 # define EAI_ADDRFAMILY -9
208 # define EAI_MEMORY -10
211 # define EAI_OVERFLOW -11
214 # define EAI_SYSTEM -12
219 # define NI_MAXHOST 1025
220 # define NI_MAXSERV 32
222 # define NI_MAXNUMERICHOST 64
224 #ifndef AI_NUMERICSERV
225 # define AI_NUMERICSERV 0
229 # ifndef NI_NUMERICHOST
230 # define NI_NUMERICHOST 0x01
231 # define NI_NUMERICSERV 0x02
232 # define NI_NOFQDN 0x04
233 # define NI_NAMEREQD 0x08
234 # define NI_DGRAM 0x10
244 struct sockaddr *ai_addr;
246 struct addrinfo *ai_next;
249 # define AI_PASSIVE 1
250 # define AI_CANONNAME 2
251 # define AI_NUMERICHOST 4
253 VLC_API const char *gai_strerror( int errnum );
255 VLC_API int getaddrinfo ( const char *, const char *,
256 const struct addrinfo *, struct addrinfo ** );
257 VLC_API void freeaddrinfo( struct addrinfo * );
258 VLC_API int getnameinfo ( const struct sockaddr *, socklen_t,
259 char *, int, char *, int, int );
262 VLC_API int vlc_getnameinfo( const struct sockaddr *, int, char *, int, int *, int );
263 VLC_API int vlc_getaddrinfo( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** );
267 /* OS/2 does not support IPv6, yet. But declare these only for compilation */
278 uint32_t sin6_flowinfo;
279 struct in6_addr sin6_addr;
280 uint32_t sin6_scope_id;
283 # define IN6_IS_ADDR_MULTICAST(a) (((__const uint8_t *) (a))[0] == 0xff)
285 static const struct in6_addr in6addr_any =
286 { { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 } };
290 net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
292 switch (addr->sa_family)
297 const struct sockaddr_in *v4 = (const struct sockaddr_in *)addr;
298 if ((size_t)len < sizeof (*v4))
300 return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
304 #ifdef IN6_IS_ADDR_MULTICAST
307 const struct sockaddr_in6 *v6 = (const struct sockaddr_in6 *)addr;
308 if ((size_t)len < sizeof (*v6))
310 return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
319 static inline int net_GetSockAddress( int fd, char *address, int *port )
321 struct sockaddr_storage addr;
322 socklen_t addrlen = sizeof( addr );
324 return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
325 || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
326 NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
330 static inline int net_GetPeerAddress( int fd, char *address, int *port )
332 struct sockaddr_storage addr;
333 socklen_t addrlen = sizeof( addr );
335 return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
336 || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
337 NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
341 static inline uint16_t net_GetPort (const struct sockaddr *addr)
343 switch (addr->sa_family)
347 return ((const struct sockaddr_in6 *)addr)->sin6_port;
350 return ((const struct sockaddr_in *)addr)->sin_port;
355 static inline void net_SetPort (struct sockaddr *addr, uint16_t port)
357 switch (addr->sa_family)
361 ((struct sockaddr_in6 *)addr)->sin6_port = port;
365 ((struct sockaddr_in *)addr)->sin_port = port;