vlc_network.h 9.19 KB
Newer Older
Sam Hocevar's avatar
 
Sam Hocevar committed
1
/*****************************************************************************
Clément Stenac's avatar
Clément Stenac committed
2
 * vlc_network.h: interface to communicate with network plug-ins
Sam Hocevar's avatar
 
Sam Hocevar committed
3
 *****************************************************************************
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
4
 * Copyright (C) 2002-2005 VLC authors and VideoLAN
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
5
 * Copyright © 2006-2007 Rémi Denis-Courmont
6
 * $Id$
Sam Hocevar's avatar
 
Sam Hocevar committed
7
 *
8
 * Authors: Christophe Massiot <massiot@via.ecp.fr>
9
 *          Laurent Aimar <fenrir@via.ecp.fr>
10
 *          Rémi Denis-Courmont <rem # videolan.org>
Sam Hocevar's avatar
 
Sam Hocevar committed
11
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
12 13 14
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
Sam Hocevar's avatar
 
Sam Hocevar committed
15 16 17 18
 * (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
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
19 20
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
Sam Hocevar's avatar
 
Sam Hocevar committed
21
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
22 23 24
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
Sam Hocevar's avatar
 
Sam Hocevar committed
25 26
 *****************************************************************************/

27 28
#ifndef VLC_NETWORK_H
# define VLC_NETWORK_H
29

30 31 32 33 34
/**
 * \file
 * This file defines interface to communicate with network plug-ins
 */

35
#if defined( WIN32 )
36
#   if !defined(UNDER_CE)
37
#       define _NO_OLDNAMES 1
38 39
#       include <io.h>
#   endif
40
#   include <winsock2.h>
41
#   include <ws2tcpip.h>
42
#   define ENETUNREACH WSAENETUNREACH
43 44
#   define net_errno (WSAGetLastError())
extern const char *net_strerror( int val );
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62

struct iovec
{
    void  *iov_base;
    size_t iov_len;
};

struct msghdr
{
    void         *msg_name;
    size_t        msg_namelen;
    struct iovec *msg_iov;
    size_t        msg_iovlen;
    void         *msg_control;
    size_t        msg_controllen;
    int           msg_flags;
};

63
#   ifndef IPV6_V6ONLY
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
64
#       define IPV6_V6ONLY 27
65
#   endif
66
#else
67 68
#   include <sys/types.h>
#   include <unistd.h>
69
#   include <sys/socket.h>
70
#   include <netinet/in.h>
71
#   include <netdb.h>
72
#   define net_errno errno
73 74
#endif

75
#if defined( __SYMBIAN32__ )
76 77 78 79 80 81 82
#   undef AF_INET6
#   undef IN6_IS_ADDR_MULTICAST
#   undef IPV6_V6ONLY
#   undef IPV6_MULTICAST_HOPS
#   undef IPV6_MULTICAST_IF
#   undef IPV6_TCLASS
#   undef IPV6_JOIN_GROUP
83 84
#endif

85
int vlc_socket (int, int, int, bool nonblock) VLC_USED;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
86 87

struct sockaddr;
88
VLC_API int vlc_accept( int, struct sockaddr *, socklen_t *, bool ) VLC_USED;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
89

90 91 92
# ifdef __cplusplus
extern "C" {
# endif
93

94
/* Portable networking layer communication */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
95 96
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)
Laurent Aimar's avatar
 
Laurent Aimar committed
99

100
VLC_API int * net_Listen(vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol);
101

102 103
#define net_ListenTCP(a, b, c) net_Listen(VLC_OBJECT(a), b, c, \
                                          SOCK_STREAM, IPPROTO_TCP)
104

105
static inline int net_ConnectTCP (vlc_object_t *obj, const char *host, int port)
106
{
107
    return net_Connect (obj, host, port, SOCK_STREAM, IPPROTO_TCP);
108
}
109
#define net_ConnectTCP(a, b, c) net_ConnectTCP(VLC_OBJECT(a), b, c)
110

111
VLC_API int net_AcceptSingle(vlc_object_t *obj, int lfd);
112

113
VLC_API int net_Accept( vlc_object_t *, int * );
114 115
#define net_Accept(a, b) \
        net_Accept(VLC_OBJECT(a), b)
116

117
VLC_API int net_ConnectDgram( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto );
118 119
#define net_ConnectDgram(a, b, c, d, e ) \
        net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
120 121 122

static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
123
    return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
124
}
125

126 127 128
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 );
#define net_OpenDgram( a, b, c, d, e, g ) \
        net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g)
129

Rémi Denis-Courmont's avatar
Cleanup  
Rémi Denis-Courmont committed
130 131
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);
Rémi Denis-Courmont's avatar
Cleanup  
Rémi Denis-Courmont committed
133
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
134

135
VLC_API void net_ListenClose( int *fd );
Laurent Aimar's avatar
 
Laurent Aimar committed
136

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
137 138
int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
                   socklen_t addrlen);
Laurent Aimar's avatar
 
Laurent Aimar committed
139

140
VLC_API int net_SetCSCov( int fd, int sendcov, int recvcov );
141

142 143 144 145
/* Functions to read from or write to the networking layer */
struct virtual_socket_t
{
    void *p_sys;
146 147
    int (*pf_recv) ( void *, void *, size_t );
    int (*pf_send) ( void *, const void *, size_t );
148 149
};

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)
Laurent Aimar's avatar
 
Laurent Aimar committed
156 157


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)
162

163
struct pollfd;
164
VLC_API int vlc_poll(struct pollfd *fds, unsigned nfds, int timeout);
165

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
166

167
#ifdef WIN32
168 169 170
/* Microsoft: same semantic, same value, different name... go figure */
# define SHUT_RD SD_RECEIVE
# define SHUT_WR SD_SEND
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
171
# define SHUT_RDWR SD_BOTH
172 173
# define net_Close( fd ) closesocket ((SOCKET)fd)
#else
174 175 176 177 178
# ifdef __OS2__
#  define SHUT_RD    0
#  define SHUT_WR    1
#  define SHUT_RDWR  2
# endif
179
# define net_Close( fd ) (void)close (fd)
180 181
#endif

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 207 208 209 210 211 212 213 214
/* 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
Rémi Denis-Courmont's avatar
Fixups  
Rémi Denis-Courmont committed
215 216 217
#ifndef EAI_OVERFLOW
#  define EAI_OVERFLOW -11
#endif
218
# ifndef EAI_SYSTEM
Rémi Denis-Courmont's avatar
Fixups  
Rémi Denis-Courmont committed
219
#  define EAI_SYSTEM -12
220 221 222 223 224 225 226
# endif


# ifndef NI_MAXHOST
#  define NI_MAXHOST 1025
#  define NI_MAXSERV 32
# endif
227
# define NI_MAXNUMERICHOST 64
228

229
#ifndef AI_NUMERICSERV
230
# define AI_NUMERICSERV 0
231 232
#endif

233 234
VLC_API int vlc_getnameinfo( const struct sockaddr *, int, char *, int, int *, int );
VLC_API int vlc_getaddrinfo( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** );
235

236

237
static inline bool
238 239 240 241 242 243 244
net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
{
    switch (addr->sa_family)
    {
#ifdef IN_MULTICAST
        case AF_INET:
        {
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
245
            const struct sockaddr_in *v4 = (const struct sockaddr_in *)addr;
246
            if ((size_t)len < sizeof (*v4))
247
                return false;
248
            return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
249 250 251 252 253 254
        }
#endif

#ifdef IN6_IS_ADDR_MULTICAST
        case AF_INET6:
        {
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
255
            const struct sockaddr_in6 *v6 = (const struct sockaddr_in6 *)addr;
256
            if ((size_t)len < sizeof (*v6))
257
                return false;
258 259 260 261 262
            return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
        }
#endif
    }

263
    return false;
264 265 266
}


267
static inline int net_GetSockAddress( int fd, char *address, int *port )
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
268 269 270 271
{
    struct sockaddr_storage addr;
    socklen_t addrlen = sizeof( addr );

272
    return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
273 274 275 276
        || 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
277

278 279 280 281
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
282

283 284 285 286
    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
287 288
}

289 290 291 292 293 294 295 296 297 298 299 300 301 302
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;
}

303 304 305 306 307 308 309
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;
310
        break;
311 312 313
#endif
        case AF_INET:
            ((struct sockaddr_in *)addr)->sin_port = port;
314
        break;
315 316
    }
}
317 318 319 320
# ifdef __cplusplus
}
# endif

321
#endif