/include/vlc_network.h
C Header | 348 lines | 254 code | 56 blank | 38 comment | 13 complexity | ec42ccb0d3527c6e12339a372634fb5d MD5 | raw file
- /*****************************************************************************
- * vlc_network.h: interface to communicate with network plug-ins
- *****************************************************************************
- * Copyright (C) 2002-2005 VLC authors and VideoLAN
- * Copyright © 2006-2007 Rémi Denis-Courmont
- * $Id: 8779ad29de4833d90b9bd34419c1c5c2ae2a1038 $
- *
- * Authors: Christophe Massiot <massiot@via.ecp.fr>
- * Laurent Aimar <fenrir@via.ecp.fr>
- * Rémi Denis-Courmont <rem # videolan.org>
- *
- * 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
- * (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 Lesser General Public License for more details.
- *
- * 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.
- *****************************************************************************/
- #ifndef VLC_NETWORK_H
- # define VLC_NETWORK_H
- /**
- * \ingroup file
- * \defgroup sockets Internet sockets
- * @{
- * \file
- * Definitions for sockets and low-level networking
- */
- #if defined( _WIN32 )
- # define _NO_OLDNAMES 1
- # include <io.h>
- # include <winsock2.h>
- # include <ws2tcpip.h>
- # define net_errno (WSAGetLastError())
- # ifndef IPV6_V6ONLY
- # define IPV6_V6ONLY 27
- # endif
- #else
- # include <sys/types.h>
- # include <unistd.h>
- # include <sys/socket.h>
- # include <netinet/in.h>
- # include <netdb.h>
- # define net_errno errno
- #endif
- #ifndef MSG_NOSIGNAL
- # define MSG_NOSIGNAL 0
- #endif
- VLC_API int vlc_socket (int, int, int, bool nonblock) VLC_USED;
- VLC_API int vlc_socketpair (int, int, int, int [2], bool nonblock);
- struct sockaddr;
- VLC_API int vlc_accept( int, struct sockaddr *, socklen_t *, bool ) VLC_USED;
- # ifdef __cplusplus
- extern "C" {
- # endif
- /* Portable networking layer communication */
- int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
- VLC_API int net_Connect(vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol);
- #define net_Connect(a, b, c, d, e) net_Connect(VLC_OBJECT(a), b, c, d, e)
- VLC_API int * net_Listen(vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol);
- #define net_ListenTCP(a, b, c) net_Listen(VLC_OBJECT(a), b, c, \
- SOCK_STREAM, IPPROTO_TCP)
- static inline int net_ConnectTCP (vlc_object_t *obj, const char *host, int port)
- {
- return net_Connect (obj, host, port, SOCK_STREAM, IPPROTO_TCP);
- }
- #define net_ConnectTCP(a, b, c) net_ConnectTCP(VLC_OBJECT(a), b, c)
- VLC_API int net_AcceptSingle(vlc_object_t *obj, int lfd);
- VLC_API int net_Accept( vlc_object_t *, int * );
- #define net_Accept(a, b) \
- net_Accept(VLC_OBJECT(a), b)
- VLC_API int net_ConnectDgram( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto );
- #define net_ConnectDgram(a, b, c, d, e ) \
- net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
- static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
- {
- return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
- }
- 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)
- static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
- {
- return net_OpenDgram (obj, host, port, NULL, 0, IPPROTO_UDP);
- }
- VLC_API void net_ListenClose( int *fd );
- int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
- socklen_t addrlen);
- VLC_API int net_SetCSCov( int fd, int sendcov, int recvcov );
- VLC_API ssize_t net_Read( vlc_object_t *p_this, int fd, void *p_data, size_t i_data );
- #define net_Read(a,b,c,d) net_Read(VLC_OBJECT(a),b,c,d)
- VLC_API ssize_t net_Write( vlc_object_t *p_this, int fd, const void *p_data, size_t i_data );
- #define net_Write(a,b,c,d) net_Write(VLC_OBJECT(a),b,c,d)
- VLC_API char * net_Gets( vlc_object_t *p_this, int fd );
- #define net_Gets(a,b) net_Gets(VLC_OBJECT(a),b)
- VLC_API ssize_t net_Printf( vlc_object_t *p_this, int fd, const char *psz_fmt, ... ) VLC_FORMAT( 3, 4 );
- #define net_Printf(o,fd,...) net_Printf(VLC_OBJECT(o),fd, __VA_ARGS__)
- VLC_API ssize_t net_vaPrintf( vlc_object_t *p_this, int fd, const char *psz_fmt, va_list args );
- #define net_vaPrintf(a,b,c,d) net_vaPrintf(VLC_OBJECT(a),b,c,d)
- #ifdef _WIN32
- /* Microsoft: same semantic, same value, different name... go figure */
- # define SHUT_RD SD_RECEIVE
- # define SHUT_WR SD_SEND
- # define SHUT_RDWR SD_BOTH
- # define net_Close( fd ) closesocket ((SOCKET)fd)
- #else
- # ifdef __OS2__
- # define SHUT_RD 0
- # define SHUT_WR 1
- # define SHUT_RDWR 2
- # endif
- VLC_API int vlc_close(int);
- # define net_Close( fd ) (void)vlc_close (fd)
- #endif
- /* 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_OVERFLOW
- # define EAI_OVERFLOW -11
- #endif
- # ifndef EAI_SYSTEM
- # define EAI_SYSTEM -12
- # endif
- # ifndef NI_MAXHOST
- # define NI_MAXHOST 1025
- # define NI_MAXSERV 32
- # endif
- # define NI_MAXNUMERICHOST 64
- #ifndef AI_NUMERICSERV
- # define AI_NUMERICSERV 0
- #endif
- #ifndef AI_IDN
- # define AI_IDN 0 /* GNU/libc extension */
- #endif
- #ifdef _WIN32
- # if !defined(WINAPI_FAMILY) || WINAPI_FAMILY != WINAPI_FAMILY_APP
- # undef gai_strerror
- # define gai_strerror gai_strerrorA
- # endif
- #endif
- #ifdef __OS2__
- # ifndef NI_NUMERICHOST
- # define NI_NUMERICHOST 0x01
- # define NI_NUMERICSERV 0x02
- # define NI_NOFQDN 0x04
- # define NI_NAMEREQD 0x08
- # define NI_DGRAM 0x10
- # endif
- # define AI_PASSIVE 1
- # define AI_CANONNAME 2
- # define AI_NUMERICHOST 4
- VLC_API const char *gai_strerror( int errnum );
- VLC_API int getaddrinfo ( const char *, const char *,
- const struct addrinfo *, struct addrinfo ** );
- VLC_API void freeaddrinfo( struct addrinfo * );
- VLC_API int getnameinfo ( const struct sockaddr *, socklen_t,
- char *, int, char *, int, int );
- #endif
- VLC_API int vlc_getnameinfo( const struct sockaddr *, int, char *, int, int *, int );
- VLC_API int vlc_getaddrinfo (const char *, unsigned,
- const struct addrinfo *, struct addrinfo **);
- #ifdef __OS2__
- /* OS/2 does not support IPv6, yet. But declare these only for compilation */
- struct in6_addr
- {
- uint8_t s6_addr[16];
- };
- struct sockaddr_in6
- {
- uint8_t sin6_len;
- uint8_t sin6_family;
- uint16_t sin6_port;
- uint32_t sin6_flowinfo;
- struct in6_addr sin6_addr;
- uint32_t sin6_scope_id;
- };
- # define IN6_IS_ADDR_MULTICAST(a) (((__const uint8_t *) (a))[0] == 0xff)
- static const struct in6_addr in6addr_any =
- { { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 } };
- #endif
- static inline bool
- net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
- {
- switch (addr->sa_family)
- {
- #ifdef IN_MULTICAST
- case AF_INET:
- {
- const struct sockaddr_in *v4 = (const struct sockaddr_in *)addr;
- if ((size_t)len < sizeof (*v4))
- return false;
- return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
- }
- #endif
- #ifdef IN6_IS_ADDR_MULTICAST
- case AF_INET6:
- {
- const struct sockaddr_in6 *v6 = (const struct sockaddr_in6 *)addr;
- if ((size_t)len < sizeof (*v6))
- return false;
- return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
- }
- #endif
- }
- return false;
- }
- static inline int net_GetSockAddress( int fd, char *address, int *port )
- {
- struct sockaddr_storage addr;
- socklen_t addrlen = sizeof( addr );
- return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
- || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
- NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
- ? VLC_EGENERIC : 0;
- }
- static inline int net_GetPeerAddress( int fd, char *address, int *port )
- {
- struct sockaddr_storage addr;
- socklen_t addrlen = sizeof( addr );
- return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
- || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
- NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
- ? VLC_EGENERIC : 0;
- }
- 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;
- }
- 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;
- }
- }
- VLC_API char *vlc_getProxyUrl(const char *);
- # ifdef __cplusplus
- }
- # endif
- /** @} */
- #endif