psocketaddress.h

Go to the documentation of this file.

/*
 * The MIT License
 *
 * Copyright (C) 2010-2017 Alexander Saprykin <saprykin.spb@gmail.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * 'Software'), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#if !defined (PLIBSYS_H_INSIDE) && !defined (PLIBSYS_COMPILATION)
#  error "Header files shouldn't be included directly, consider using <plibsys.h> instead."
#endif

#ifndef PLIBSYS_HEADER_PSOCKETADDRESS_H
#define PLIBSYS_HEADER_PSOCKETADDRESS_H

#include <pmacros.h>
#include <ptypes.h>

#ifndef P_OS_WIN
#  include <sys/types.h>
#  include <sys/socket.h>
#  include <netinet/in.h>
#endif

P_BEGIN_DECLS

typedef enum PSocketFamily_ {
        P_SOCKET_FAMILY_UNKNOWN = 0,            
        P_SOCKET_FAMILY_INET    = AF_INET,      
#ifdef AF_INET6
        P_SOCKET_FAMILY_INET6   = AF_INET6      
#else
        P_SOCKET_FAMILY_INET6   = -1            
#endif
} PSocketFamily;

typedef struct PSocketAddress_ PSocketAddress;

P_LIB_API PSocketAddress *      p_socket_address_new_from_native        (pconstpointer          native,
                                                                         psize                  len);

P_LIB_API PSocketAddress *      p_socket_address_new                    (const pchar            *address,
                                                                         puint16                port);

P_LIB_API PSocketAddress *      p_socket_address_new_any                (PSocketFamily          family,
                                                                         puint16                port);

P_LIB_API PSocketAddress *      p_socket_address_new_loopback           (PSocketFamily          family,
                                                                         puint16                port);

P_LIB_API pboolean              p_socket_address_to_native              (const PSocketAddress   *addr,
                                                                         ppointer               dest,
                                                                         psize                  destlen);

P_LIB_API psize                 p_socket_address_get_native_size        (const PSocketAddress   *addr);

P_LIB_API PSocketFamily         p_socket_address_get_family             (const PSocketAddress   *addr);

P_LIB_API pchar *               p_socket_address_get_address            (const PSocketAddress   *addr);

P_LIB_API puint16               p_socket_address_get_port               (const PSocketAddress   *addr);

P_LIB_API puint32               p_socket_address_get_flow_info          (const PSocketAddress   *addr);

P_LIB_API puint32               p_socket_address_get_scope_id           (const PSocketAddress   *addr);

P_LIB_API void                  p_socket_address_set_flow_info          (PSocketAddress         *addr,
                                                                         puint32                flowinfo);

P_LIB_API void                  p_socket_address_set_scope_id           (PSocketAddress         *addr,
                                                                         puint32                scope_id);

P_LIB_API pboolean              p_socket_address_is_flow_info_supported (void);

P_LIB_API pboolean              p_socket_address_is_scope_id_supported  (void);

P_LIB_API pboolean              p_socket_address_is_ipv6_supported      (void);

P_LIB_API pboolean              p_socket_address_is_any                 (const PSocketAddress   *addr);

P_LIB_API pboolean              p_socket_address_is_loopback            (const PSocketAddress   *addr);

P_LIB_API void                  p_socket_address_free                   (PSocketAddress         *addr);

P_END_DECLS

#endif /* PLIBSYS_HEADER_PSOCKETADDRESS_H */