util.h

Go to the documentation of this file.

/*
 * Copyright (C) 2017 Kaspar Schleiser <kaspar@schleiser.de>
 *               2018 Freie Universität Berlin
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#pragma once

 
#include <stdbool.h>
#include <stdint.h>
 
#include "net/sock/config.h"
 
#if MODULE_GNRC_SOCK_UDP || MODULE_LWIP_SOCK_UDP || MODULE_OPENWSN_SOCK_UDP || DOXYGEN
#  include "net/sock/udp.h"
#  define SOCK_HAS_UDP  1   
#endif
#if MODULE_GNRC_SOCK_TCP || MODULE_LWIP_SOCK_TCP || DOXYGEN
#  include "net/sock/tcp.h"
#  define SOCK_HAS_TCP  1   
#endif
#ifdef MODULE_SOCK_DTLS
#  include "net/credman.h"
#  include "net/sock/dtls.h"
#endif
 
#if MODULE_GNRC_SOCK_UDP || MODULE_LWIP_SOCK_UDP || MODULE_OPENWSN_SOCK_UDP \
    || MODULE_GNRC_SOCK_TCP || MODULE_LWIP_SOCK_TCP || DOXYGEN
#  define HAVE_SOCK_TL_EP   1 
#endif
 
#ifdef __cplusplus
extern "C" {
#endif

int sock_urlsplit(const char *url, char *hostport, char *urlpath);

const char *sock_urlpath(const char *url);
 
#if HAVE_SOCK_TL_EP
int sock_tl_ep_fmt(const struct _sock_tl_ep *endpoint,
                   char *addr_str, uint16_t *port);
 
#if IS_ACTIVE(SOCK_HAS_TCP) || DOXYGEN
static inline int sock_tcp_ep_fmt(const sock_tcp_ep_t *endpoint,
                                  char *addr_str, uint16_t *port)
{
    return sock_tl_ep_fmt(endpoint, addr_str, port);
}
#endif
 
#if IS_ACTIVE(SOCK_HAS_UDP) || DOXYGEN
static inline int sock_udp_ep_fmt(const sock_udp_ep_t *endpoint,
                                  char *addr_str, uint16_t *port)
{
    return sock_tl_ep_fmt(endpoint, addr_str, port);
}
#endif

int sock_tl_str2ep(struct _sock_tl_ep *ep_out, const char *str);

int sock_tl_name2ep(struct _sock_tl_ep *ep_out, const char *str);
 
#if IS_ACTIVE(SOCK_HAS_TCP) || DOXYGEN
static inline int sock_tcp_str2ep(sock_tcp_ep_t *ep_out, const char *str)
{
    return sock_tl_str2ep(ep_out, str);
}

static inline int sock_tcp_name2ep(sock_tcp_ep_t *ep_out, const char *str)
{
    return sock_tl_name2ep(ep_out, str);
}
#endif
 
#if IS_ACTIVE(SOCK_HAS_UDP) || DOXYGEN
static inline int sock_udp_str2ep(sock_udp_ep_t *ep_out, const char *str)
{
    return sock_tl_str2ep(ep_out, str);
}

static inline int sock_udp_name2ep(sock_udp_ep_t *ep_out, const char *str)
{
    return sock_tl_name2ep(ep_out, str);
}
#endif

bool sock_tl_ep_equal(const struct _sock_tl_ep *a,
                      const struct _sock_tl_ep *b);
 
#if IS_ACTIVE(SOCK_HAS_TCP) || DOXYGEN
static inline bool sock_tcp_ep_equal(const sock_tcp_ep_t *a,
                                     const sock_tcp_ep_t *b)
{
    return sock_tl_ep_equal(a, b);
}
#endif
 
#if IS_ACTIVE(SOCK_HAS_UDP) || DOXYGEN
static inline bool sock_udp_ep_equal(const sock_udp_ep_t *a,
                                     const sock_udp_ep_t *b)
{
    return sock_tl_ep_equal(a, b);
}
#endif
#endif
 
#if defined(MODULE_SOCK_DTLS) || DOXYGEN
int sock_dtls_establish_session(sock_udp_t *sock_udp, sock_dtls_t *sock_dtls,
                                sock_dtls_session_t *session, credman_tag_t tag,
                                sock_udp_ep_t *local, const sock_udp_ep_t *remote,
                                void *work_buf, size_t work_buf_len);
#endif
 
#ifdef __cplusplus
}
#endif