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 # define _NO_OLDNAMES 1
38 # include <winsock2.h>
39 # include <ws2tcpip.h>
40 # define net_errno (WSAGetLastError())
41 extern const char *net_strerror( int val
);
53 struct iovec
*msg_iov
;
56 size_t msg_controllen
;
61 # define IPV6_V6ONLY 27
64 # include <sys/types.h>
66 # include <sys/socket.h>
67 # include <netinet/in.h>
69 # define net_errno errno
72 #if defined( __SYMBIAN32__ )
74 # undef IN6_IS_ADDR_MULTICAST
76 # undef IPV6_MULTICAST_HOPS
77 # undef IPV6_MULTICAST_IF
79 # undef IPV6_JOIN_GROUP
82 VLC_API
int vlc_socket (int, int, int, bool nonblock
) VLC_USED
;
85 VLC_API
int vlc_accept( int, struct sockaddr
*, socklen_t
*, bool ) VLC_USED
;
91 /* Portable networking layer communication */
92 int net_Socket (vlc_object_t
*obj
, int family
, int socktype
, int proto
);
94 VLC_API
int net_Connect(vlc_object_t
*p_this
, const char *psz_host
, int i_port
, int socktype
, int protocol
);
95 #define net_Connect(a, b, c, d, e) net_Connect(VLC_OBJECT(a), b, c, d, e)
97 VLC_API
int * net_Listen(vlc_object_t
*p_this
, const char *psz_host
, int i_port
, int socktype
, int protocol
);
99 #define net_ListenTCP(a, b, c) net_Listen(VLC_OBJECT(a), b, c, \
100 SOCK_STREAM, IPPROTO_TCP)
102 static inline int net_ConnectTCP (vlc_object_t
*obj
, const char *host
, int port
)
104 return net_Connect (obj
, host
, port
, SOCK_STREAM
, IPPROTO_TCP
);
106 #define net_ConnectTCP(a, b, c) net_ConnectTCP(VLC_OBJECT(a), b, c)
108 VLC_API
int net_AcceptSingle(vlc_object_t
*obj
, int lfd
);
110 VLC_API
int net_Accept( vlc_object_t
*, int * );
111 #define net_Accept(a, b) \
112 net_Accept(VLC_OBJECT(a), b)
114 VLC_API
int net_ConnectDgram( vlc_object_t
*p_this
, const char *psz_host
, int i_port
, int hlim
, int proto
);
115 #define net_ConnectDgram(a, b, c, d, e ) \
116 net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
118 static inline int net_ConnectUDP (vlc_object_t
*obj
, const char *host
, int port
, int hlim
)
120 return net_ConnectDgram (obj
, host
, port
, hlim
, IPPROTO_UDP
);
123 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
);
124 #define net_OpenDgram( a, b, c, d, e, g ) \
125 net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g)
127 static inline int net_ListenUDP1 (vlc_object_t
*obj
, const char *host
, int port
)
129 return net_OpenDgram (obj
, host
, port
, NULL
, 0, IPPROTO_UDP
);
132 VLC_API
void net_ListenClose( int *fd
);
134 int net_Subscribe (vlc_object_t
*obj
, int fd
, const struct sockaddr
*addr
,
137 VLC_API
int net_SetCSCov( int fd
, int sendcov
, int recvcov
);
139 /* Functions to read from or write to the networking layer */
140 struct virtual_socket_t
143 int (*pf_recv
) ( void *, void *, size_t );
144 int (*pf_send
) ( void *, const void *, size_t );
147 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
);
148 #define net_Read(a,b,c,d,e,f) net_Read(VLC_OBJECT(a),b,c,d,e,f)
149 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
);
150 #define net_Write(a,b,c,d,e) net_Write(VLC_OBJECT(a),b,c,d,e)
151 VLC_API
char * net_Gets( vlc_object_t
*p_this
, int fd
, const v_socket_t
* );
152 #define net_Gets(a,b,c) net_Gets(VLC_OBJECT(a),b,c)
155 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 );
156 #define net_Printf(o,fd,vs,...) net_Printf(VLC_OBJECT(o),fd,vs, __VA_ARGS__)
157 VLC_API ssize_t
net_vaPrintf( vlc_object_t
*p_this
, int fd
, const v_socket_t
*, const char *psz_fmt
, va_list args
);
158 #define net_vaPrintf(a,b,c,d,e) net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
161 /* Microsoft: same semantic, same value, different name... go figure */
162 # define SHUT_RD SD_RECEIVE
163 # define SHUT_WR SD_SEND
164 # define SHUT_RDWR SD_BOTH
165 # define net_Close( fd ) closesocket ((SOCKET)fd)
172 # define net_Close( fd ) (void)close (fd)
175 /* Portable network names/addresses resolution layer */
177 /* GAI error codes */
178 # ifndef EAI_BADFLAGS
179 # define EAI_BADFLAGS -1
182 # define EAI_NONAME -2
185 # define EAI_AGAIN -3
191 # define EAI_NODATA -5
194 # define EAI_FAMILY -6
196 # ifndef EAI_SOCKTYPE
197 # define EAI_SOCKTYPE -7
200 # define EAI_SERVICE -8
202 # ifndef EAI_ADDRFAMILY
203 # define EAI_ADDRFAMILY -9
206 # define EAI_MEMORY -10
209 # define EAI_OVERFLOW -11
212 # define EAI_SYSTEM -12
217 # define NI_MAXHOST 1025
218 # define NI_MAXSERV 32
220 # define NI_MAXNUMERICHOST 64
222 #ifndef AI_NUMERICSERV
223 # define AI_NUMERICSERV 0
226 # define AI_IDN 0 /* GNU/libc extension */
231 # define gai_strerror gai_strerrorA
235 # ifndef NI_NUMERICHOST
236 # define NI_NUMERICHOST 0x01
237 # define NI_NUMERICSERV 0x02
238 # define NI_NOFQDN 0x04
239 # define NI_NAMEREQD 0x08
240 # define NI_DGRAM 0x10
250 struct sockaddr
*ai_addr
;
252 struct addrinfo
*ai_next
;
255 # define AI_PASSIVE 1
256 # define AI_CANONNAME 2
257 # define AI_NUMERICHOST 4
259 VLC_API
const char *gai_strerror( int errnum
);
261 VLC_API
int getaddrinfo ( const char *, const char *,
262 const struct addrinfo
*, struct addrinfo
** );
263 VLC_API
void freeaddrinfo( struct addrinfo
* );
264 VLC_API
int getnameinfo ( const struct sockaddr
*, socklen_t
,
265 char *, int, char *, int, int );
268 VLC_API
int vlc_getnameinfo( const struct sockaddr
*, int, char *, int, int *, int );
269 VLC_API
int vlc_getaddrinfo (const char *, unsigned,
270 const struct addrinfo
*, struct addrinfo
**);
274 /* OS/2 does not support IPv6, yet. But declare these only for compilation */
285 uint32_t sin6_flowinfo
;
286 struct in6_addr sin6_addr
;
287 uint32_t sin6_scope_id
;
290 # define IN6_IS_ADDR_MULTICAST(a) (((__const uint8_t *) (a))[0] == 0xff)
292 static const struct in6_addr in6addr_any
=
293 { { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 } };
297 net_SockAddrIsMulticast (const struct sockaddr
*addr
, socklen_t len
)
299 switch (addr
->sa_family
)
304 const struct sockaddr_in
*v4
= (const struct sockaddr_in
*)addr
;
305 if ((size_t)len
< sizeof (*v4
))
307 return IN_MULTICAST (ntohl (v4
->sin_addr
.s_addr
)) != 0;
311 #ifdef IN6_IS_ADDR_MULTICAST
314 const struct sockaddr_in6
*v6
= (const struct sockaddr_in6
*)addr
;
315 if ((size_t)len
< sizeof (*v6
))
317 return IN6_IS_ADDR_MULTICAST (&v6
->sin6_addr
) != 0;
326 static inline int net_GetSockAddress( int fd
, char *address
, int *port
)
328 struct sockaddr_storage addr
;
329 socklen_t addrlen
= sizeof( addr
);
331 return getsockname( fd
, (struct sockaddr
*)&addr
, &addrlen
)
332 || vlc_getnameinfo( (struct sockaddr
*)&addr
, addrlen
, address
,
333 NI_MAXNUMERICHOST
, port
, NI_NUMERICHOST
)
337 static inline int net_GetPeerAddress( int fd
, char *address
, int *port
)
339 struct sockaddr_storage addr
;
340 socklen_t addrlen
= sizeof( addr
);
342 return getpeername( fd
, (struct sockaddr
*)&addr
, &addrlen
)
343 || vlc_getnameinfo( (struct sockaddr
*)&addr
, addrlen
, address
,
344 NI_MAXNUMERICHOST
, port
, NI_NUMERICHOST
)
348 static inline uint16_t net_GetPort (const struct sockaddr
*addr
)
350 switch (addr
->sa_family
)
354 return ((const struct sockaddr_in6
*)addr
)->sin6_port
;
357 return ((const struct sockaddr_in
*)addr
)->sin_port
;
362 static inline void net_SetPort (struct sockaddr
*addr
, uint16_t port
)
364 switch (addr
->sa_family
)
368 ((struct sockaddr_in6
*)addr
)->sin6_port
= port
;
372 ((struct sockaddr_in
*)addr
)->sin_port
= port
;
377 VLC_API
char *vlc_getProxyUrl(const char *);