vlc_network.h 11.1 KB
Newer Older
Sam Hocevar's avatar
   
Sam Hocevar committed
1
/*****************************************************************************
zorglub's avatar
zorglub committed
2
 * vlc_network.h: interface to communicate with network plug-ins
Sam Hocevar's avatar
   
Sam Hocevar committed
3
 *****************************************************************************
4
 * Copyright (C) 2002-2005 the VideoLAN team
zorglub's avatar
zorglub committed
5
 * $Id$
Sam Hocevar's avatar
   
Sam Hocevar committed
6
 *
7
 * Authors: Christophe Massiot <massiot@via.ecp.fr>
8
 *          Laurent Aimar <fenrir@via.ecp.fr>
9
 *          Rémi Denis-Courmont <rem # videolan.org>
Sam Hocevar's avatar
   
Sam Hocevar committed
10
11
12
13
14
15
16
17
18
19
20
21
22
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
dionoea's avatar
dionoea committed
23
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
Sam Hocevar's avatar
   
Sam Hocevar committed
24
25
 *****************************************************************************/

zorglub's avatar
zorglub committed
26
27
28
29
#if !defined( __LIBVLC__ )
  #error You are not libvlc or one of its plugins. You cannot include this file
#endif

30
31
#ifndef __VLC_NETWORK_H
# define __VLC_NETWORK_H
32

33
34
35
36
#if defined( WIN32 )
#   if defined(UNDER_CE) && defined(sockaddr_storage)
#       undef sockaddr_storage
#   endif
gbazin's avatar
gbazin committed
37
38
39
#   if defined(UNDER_CE)
#       define HAVE_STRUCT_ADDRINFO
#   else
40
#       define _NO_OLDNAMES 1
gbazin's avatar
gbazin committed
41
42
#       include <io.h>
#   endif
damienf's avatar
damienf committed
43
#   include <winsock2.h>
44
#   include <ws2tcpip.h>
gbazin's avatar
gbazin committed
45
#   define ENETUNREACH WSAENETUNREACH
46
47
#   define net_errno (WSAGetLastError())
extern const char *net_strerror( int val );
48
#else
49
50
51
52
53
54
55
56
57
58
59
#   if HAVE_SYS_SOCKET_H
#      include <sys/socket.h>
#   endif
#   if HAVE_NETINET_IN_H
#      include <netinet/in.h>
#   endif
#   if HAVE_ARPA_INET_H
#      include <arpa/inet.h>
#   elif defined( SYS_BEOS )
#      include <net/netdb.h>
#   endif
60
#   include <netdb.h>
61
62
#   define net_errno errno
#   define net_strerror strerror
63
64
#endif

65
66
67
# ifdef __cplusplus
extern "C" {
# endif
68

69
/* Portable networking layer communication */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
70
71
int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);

72
73
74
#define net_ConnectTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)
#define net_OpenTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)
VLC_EXPORT( int, __net_ConnectTCP, ( vlc_object_t *p_this, const char *psz_host, int i_port ) );
Laurent Aimar's avatar
   
Laurent Aimar committed
75

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
76
77
int *net_Listen (vlc_object_t *p_this, const char *psz_host, int i_port,
                                int family, int socktype, int protocol);
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
78
VLC_EXPORT( int, net_ListenSingle, (vlc_object_t *p_this, const char *psz_host, int i_port, int family, int socktype, int protocol) );
79

80
#define net_ListenTCP(a, b, c) __net_ListenTCP(VLC_OBJECT(a), b, c)
81
VLC_EXPORT( int *, __net_ListenTCP, ( vlc_object_t *, const char *, int ) );
82

83
#define net_Accept(a, b, c) __net_Accept(VLC_OBJECT(a), b, c)
84
VLC_EXPORT( int, __net_Accept, ( vlc_object_t *, int *, mtime_t ) );
85

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
86
87
88
89
90
91
92
#define net_ConnectDgram(a, b, c, d, e ) __net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
VLC_EXPORT( int, __net_ConnectDgram, ( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto ) );

static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
{
    return net_ConnectDgram (obj, host, port, hlim, 0);
}
93

Rémi Denis-Courmont's avatar
Cleanup    
Rémi Denis-Courmont committed
94
95
static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
96
    return net_ListenSingle (obj, host, port, AF_UNSPEC, SOCK_DGRAM, 0);
Rémi Denis-Courmont's avatar
Cleanup    
Rémi Denis-Courmont committed
97
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
98

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
99
100
#define net_OpenDgram( a, b, c, d, e, g, h ) __net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g, h)
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 ) );
Laurent Aimar's avatar
Laurent Aimar committed
101

Laurent Aimar's avatar
   
Laurent Aimar committed
102
VLC_EXPORT( void, net_Close, ( int fd ) );
103
VLC_EXPORT( void, net_ListenClose, ( int *fd ) );
Laurent Aimar's avatar
   
Laurent Aimar committed
104

105
VLC_EXPORT( int, net_SetDSCP, ( int fd, uint8_t dscp ) );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
106
107
int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
                   socklen_t addrlen);
Laurent Aimar's avatar
   
Laurent Aimar committed
108

109
110
111
112
113
114
115
116
117
/* Functions to read from or write to the networking layer */
struct virtual_socket_t
{
    void *p_sys;
    int (*pf_recv) ( void *, void *, int );
    int (*pf_send) ( void *, const void *, int );
};

#define net_Read(a,b,c,d,e,f) __net_Read(VLC_OBJECT(a),b,c,d,e,f)
118
VLC_EXPORT( int, __net_Read, ( vlc_object_t *p_this, int fd, const v_socket_t *, uint8_t *p_data, int i_data, vlc_bool_t b_retry ) );
zorglub's avatar
zorglub committed
119

120
#define net_ReadNonBlock(a,b,c,d,e,f) __net_ReadNonBlock(VLC_OBJECT(a),b,c,d,e,f)
121
VLC_EXPORT( int, __net_ReadNonBlock, ( vlc_object_t *p_this, int fd, const v_socket_t *, uint8_t *p_data, int i_data, mtime_t i_wait ) );
zorglub's avatar
zorglub committed
122

123
#define net_Select(a,b,c,d,e,f,g) __net_Select(VLC_OBJECT(a),b,c,d,e,f,g)
124
VLC_EXPORT( int, __net_Select, ( vlc_object_t *p_this, const int *pi_fd, const v_socket_t *const *, int i_fd, uint8_t *p_data, int i_data, mtime_t i_wait ) );
zorglub's avatar
zorglub committed
125

126
#define net_Write(a,b,c,d,e) __net_Write(VLC_OBJECT(a),b,c,d,e)
127
VLC_EXPORT( int, __net_Write, ( vlc_object_t *p_this, int fd, const v_socket_t *, const uint8_t *p_data, int i_data ) );
Laurent Aimar's avatar
   
Laurent Aimar committed
128

129
#define net_Gets(a,b,c) __net_Gets(VLC_OBJECT(a),b,c)
130
VLC_EXPORT( char *, __net_Gets, ( vlc_object_t *p_this, int fd, const v_socket_t * ) );
Laurent Aimar's avatar
   
Laurent Aimar committed
131

132
VLC_EXPORT( int, net_Printf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, ... ) );
Laurent Aimar's avatar
   
Laurent Aimar committed
133

134
#define net_vaPrintf(a,b,c,d,e) __net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
135
VLC_EXPORT( int, __net_vaPrintf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args ) );
136

137

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
138
#ifndef HAVE_INET_PTON
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
139
140
141
142
143
/* only in core, so no need for C++ extern "C" */
int inet_pton(int af, const char *src, void *dst);
#endif


144
145
146
147
148
149
150
/*****************************************************************************
 * net_StopRecv/Send
 *****************************************************************************
 * Wrappers for shutdown()
 *****************************************************************************/
#if defined (SHUT_WR)
/* the standard way */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
151
152
# define net_StopSend( fd ) (void)shutdown( fd, SHUT_WR )
# define net_StopRecv( fd ) (void)shutdown( fd, SHUT_RD )
153
154
#elif defined (SD_SEND)
/* the Microsoft seemingly-purposedly-different-for-the-sake-of-it way */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
155
156
# define net_StopSend( fd ) (void)shutdown( fd, SD_SEND )
# define net_StopRecv( fd ) (void)shutdown( fd, SD_RECEIVE )
157
#else
Eric Petit's avatar
Eric Petit committed
158
159
160
# ifndef SYS_BEOS /* R5 just doesn't have a working shutdown() */
#  warning FIXME: implement shutdown on your platform!
# endif
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
161
162
# define net_StopSend( fd ) (void)0
# define net_StopRecv( fd ) (void)0
163
#endif
164

165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
/* Portable network names/addresses resolution layer */

/* GAI error codes */
# ifndef EAI_BADFLAGS
#  define EAI_BADFLAGS -1
# endif
# ifndef EAI_NONAME
#  define EAI_NONAME -2
# endif
# ifndef EAI_AGAIN
#  define EAI_AGAIN -3
# endif
# ifndef EAI_FAIL
#  define EAI_FAIL -4
# endif
# ifndef EAI_NODATA
#  define EAI_NODATA -5
# endif
# ifndef EAI_FAMILY
#  define EAI_FAMILY -6
# endif
# ifndef EAI_SOCKTYPE
#  define EAI_SOCKTYPE -7
# endif
# ifndef EAI_SERVICE
#  define EAI_SERVICE -8
# endif
# ifndef EAI_ADDRFAMILY
#  define EAI_ADDRFAMILY -9
# endif
# ifndef EAI_MEMORY
#  define EAI_MEMORY -10
# endif
# ifndef EAI_SYSTEM
#  define EAI_SYSTEM -11
# endif


# ifndef NI_MAXHOST
#  define NI_MAXHOST 1025
#  define NI_MAXSERV 32
# endif
207
# define NI_MAXNUMERICHOST 64
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234

# ifndef NI_NUMERICHOST
#  define NI_NUMERICHOST 0x01
#  define NI_NUMERICSERV 0x02
#  define NI_NOFQDN      0x04
#  define NI_NAMEREQD    0x08
#  define NI_DGRAM       0x10
# endif

# ifndef HAVE_STRUCT_ADDRINFO
struct addrinfo
{
    int ai_flags;
    int ai_family;
    int ai_socktype;
    int ai_protocol;
    size_t ai_addrlen;
    struct sockaddr *ai_addr;
    char *ai_canonname;
    struct addrinfo *ai_next;
};
#  define AI_PASSIVE     1
#  define AI_CANONNAME   2
#  define AI_NUMERICHOST 4
# endif /* if !HAVE_STRUCT_ADDRINFO */

VLC_EXPORT( const char *, vlc_gai_strerror, ( int ) );
235
VLC_EXPORT( int, vlc_getnameinfo, ( const struct sockaddr *, int, char *, int, int *, int ) );
236
VLC_EXPORT( int, vlc_getaddrinfo, ( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** ) );
237
238
VLC_EXPORT( void, vlc_freeaddrinfo, ( struct addrinfo * ) );

239
240
241
242
243
244
245
246
247
248

static inline vlc_bool_t
net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
{
    switch (addr->sa_family)
    {
#ifdef IN_MULTICAST
        case AF_INET:
        {
            struct sockaddr_in *v4 = (struct sockaddr_in *)addr;
249
            if ((size_t)len < sizeof (*v4))
250
                return VLC_FALSE;
251
            return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
252
253
254
255
256
257
258
        }
#endif

#ifdef IN6_IS_ADDR_MULTICAST
        case AF_INET6:
        {
            struct sockaddr_in6 *v6 = (struct sockaddr_in6 *)addr;
259
            if ((size_t)len < sizeof (*v6))
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
                return VLC_FALSE;
            return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
        }
#endif
    }

    return VLC_FALSE;
}



/**
 * net_AddressIsMulticast
 * @return VLC_FALSE iff the psz_addr does not specify a multicast address,
 * or the address is not a valid address.
 */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
276
static inline vlc_bool_t net_AddressIsMulticast( vlc_object_t *p_object, const char *psz_addr )
277
278
279
{
    struct addrinfo hints, *res;

280
    memset (&hints, 0, sizeof (hints));
281
282
283
    hints.ai_socktype = SOCK_DGRAM; /* UDP */
    hints.ai_flags = AI_NUMERICHOST;

284
285
286
    int i = vlc_getaddrinfo (p_object, psz_addr, 0,
                             &hints, &res);
    if (i)
287
    {
288
289
        msg_Err (p_object, "invalid address \"%s\" for net_AddressIsMulticast (%s)",
                 psz_addr, vlc_gai_strerror (i));
290
        return VLC_FALSE;
291
    }
292

293
294
295
    vlc_bool_t b = net_SockAddrIsMulticast (res->ai_addr, res->ai_addrlen);
    vlc_freeaddrinfo (res);
    return b;
296
297
}

298
static inline int net_GetSockAddress( int fd, char *address, int *port )
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
299
300
301
302
{
    struct sockaddr_storage addr;
    socklen_t addrlen = sizeof( addr );

303
    return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
304
305
306
307
        || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
                            NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
        ? VLC_EGENERIC : 0;
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
308

309
310
311
312
static inline int net_GetPeerAddress( int fd, char *address, int *port )
{
    struct sockaddr_storage addr;
    socklen_t addrlen = sizeof( addr );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
313

314
315
316
317
    return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
        || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
                            NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
        ? VLC_EGENERIC : 0;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
318
319
}

320
321
322
323
324
325
326
327
328
329
330
331
332
333
static inline uint16_t net_GetPort (const struct sockaddr *addr)
{
    switch (addr->sa_family)
    {
#ifdef AF_INET6
        case AF_INET6:
            return ((const struct sockaddr_in6 *)addr)->sin6_port;
#endif
        case AF_INET:
            return ((const struct sockaddr_in *)addr)->sin_port;
    }
    return 0;
}

334
335
336
337
338
339
340
341
342
343
344
345
346
347
static inline void net_SetPort (struct sockaddr *addr, uint16_t port)
{
    switch (addr->sa_family)
    {
#ifdef AF_INET6
        case AF_INET6:
            ((struct sockaddr_in6 *)addr)->sin6_port = port;
	    break;
#endif
        case AF_INET:
            ((struct sockaddr_in *)addr)->sin_port = port;
	    break;
    }
}
348
349
350
351
# ifdef __cplusplus
}
# endif

352
#endif