tcp.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2015-2017 Simon Brummer
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <stdint.h>
 
#include "compiler_hints.h"
#include "net/gnrc/pkt.h"
#include "net/gnrc/tcp/tcb.h"
 
#ifdef SOCK_HAS_IPV6
#  include "net/sock.h"
#else
#  ifdef MODULE_GNRC_IPV6
#    include "net/gnrc/ipv6.h"
#  endif
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Note: This value if configurable for test purposes. Do not override it.
 *       Changing this value may lead to errors that are hard to track down.
 */
#ifndef GNRC_TCP_NO_TIMEOUT
#define GNRC_TCP_NO_TIMEOUT (UINT32_MAX)
#endif
 
#ifdef SOCK_HAS_IPV6
/* Reuse sock endpoint if sock is available and supporting IPv6. */
typedef struct _sock_tl_ep gnrc_tcp_ep_t;
 
#else
typedef struct {
    int family;                            
    union {
#ifdef MODULE_GNRC_IPV6
        uint8_t ipv6[sizeof(ipv6_addr_t)]; 
#endif
        uint8_t dummy;                     
    } addr;                                
    uint16_t netif;                        
    uint16_t port;                         
} gnrc_tcp_ep_t;
#endif

ACCESS(read_only, 3, 4)
int gnrc_tcp_ep_init(gnrc_tcp_ep_t *ep, int family, const uint8_t *addr, size_t addr_size,
                     uint16_t port, uint16_t netif);

int gnrc_tcp_ep_from_str(gnrc_tcp_ep_t *ep, const char *str);

int gnrc_tcp_init(void);

void gnrc_tcp_tcb_init(gnrc_tcp_tcb_t *tcb);

void gnrc_tcp_tcb_queue_init(gnrc_tcp_tcb_queue_t *queue);

int gnrc_tcp_open(gnrc_tcp_tcb_t *tcb, const gnrc_tcp_ep_t *remote, uint16_t local_port);

int gnrc_tcp_listen(gnrc_tcp_tcb_queue_t *queue, gnrc_tcp_tcb_t *tcbs, size_t tcbs_len,
                    const gnrc_tcp_ep_t *local);

int gnrc_tcp_accept(gnrc_tcp_tcb_queue_t *queue, gnrc_tcp_tcb_t **tcb,
                    const uint32_t user_timeout_duration_ms);

ACCESS(read_only, 2, 3)
ssize_t gnrc_tcp_send(gnrc_tcp_tcb_t *tcb, const void *data, const size_t len,
                      const uint32_t user_timeout_duration_ms);

ACCESS(write_only, 2, 3)
ssize_t gnrc_tcp_recv(gnrc_tcp_tcb_t *tcb, void *data, size_t max_len,
                      uint32_t user_timeout_duration_ms);

void gnrc_tcp_close(gnrc_tcp_tcb_t *tcb);

void gnrc_tcp_abort(gnrc_tcp_tcb_t *tcb);

void gnrc_tcp_stop_listen(gnrc_tcp_tcb_queue_t *queue);

int gnrc_tcp_get_local(gnrc_tcp_tcb_t *tcb, gnrc_tcp_ep_t *ep);

int gnrc_tcp_get_remote(gnrc_tcp_tcb_t *tcb, gnrc_tcp_ep_t *ep);

int gnrc_tcp_queue_get_local(gnrc_tcp_tcb_queue_t *queue, gnrc_tcp_ep_t *ep);

int gnrc_tcp_calc_csum(const gnrc_pktsnip_t *hdr, const gnrc_pktsnip_t *pseudo_hdr);

gnrc_pktsnip_t *gnrc_tcp_hdr_build(gnrc_pktsnip_t *payload, uint16_t src, uint16_t dst);
 
#ifdef __cplusplus
}
#endif