Blame view

RIOT/sys/include/net/gnrc/udp.h 2.31 KB
a752c7ab   elopes   add first test an...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
  /*
   * Copyright (C) 2015 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.
   */
  
  /**
   * @defgroup    net_gnrc_udp UDP
   * @ingroup     net_gnrc
   * @brief       GNRC's implementation of the UDP protocol
   *
   * @{
   *
   * @file
   * @brief       UDP GNRC definition
   *
   * @author      Hauke Petersen <hauke.petersen@fu-berlin.de>
   */
  
  #ifndef NET_GNRC_UDP_H
  #define NET_GNRC_UDP_H
  
  #include <stdint.h>
  
  #include "byteorder.h"
  #include "net/gnrc.h"
  #include "net/udp.h"
  
  #ifdef __cplusplus
  extern "C" {
  #endif
  
  /**
   * @brief   Default message queue size for the UDP thread
   */
  #ifndef GNRC_UDP_MSG_QUEUE_SIZE
  #define GNRC_UDP_MSG_QUEUE_SIZE (8U)
  #endif
  
  /**
   * @brief   Priority of the UDP thread
   */
  #ifndef GNRC_UDP_PRIO
  #define GNRC_UDP_PRIO           (THREAD_PRIORITY_MAIN - 2)
  #endif
  
  /**
   * @brief   Default stack size to use for the UDP thread
   */
  #ifndef GNRC_UDP_STACK_SIZE
  #define GNRC_UDP_STACK_SIZE     (THREAD_STACKSIZE_DEFAULT)
  #endif
  
  /**
   * @brief   Calculate the checksum for the given packet
   *
   * @param[in] hdr           Pointer to the UDP header
   * @param[in] pseudo_hdr    Pointer to the network layer header
   *
   * @return  0 on success
   * @return  -EBADMSG if @p hdr is not of type GNRC_NETTYPE_UDP
   * @return  -EFAULT if @p hdr or @p pseudo_hdr is NULL
   * @return  -ENOENT if gnrc_pktsnip_t::type of @p pseudo_hdr is not known
   */
  int gnrc_udp_calc_csum(gnrc_pktsnip_t *hdr, gnrc_pktsnip_t *pseudo_hdr);
  
  /**
   * @brief   Allocate and initialize a fresh UDP header in the packet buffer
   *
   * @param[in] payload       Payload contained in the UDP packet
   * @param[in] src           Source port in host byte order
   * @param[in] dst           Destination port in host byte order
   *
   * @return  pointer to the newly created (and allocated) header
   * @return  NULL on `src == NULL`, `dst == NULL`, `src_len != 2`, `dst_len != 2`
   *          or on allocation error
   */
  gnrc_pktsnip_t *gnrc_udp_hdr_build(gnrc_pktsnip_t *payload, uint16_t src,
                                     uint16_t dst);
  
  /**
   * @brief   Initialize and start UDP
   *
   * @return  PID of the UDP thread
   * @return  negative value on error
   */
  int gnrc_udp_init(void);
  
  #ifdef __cplusplus
  }
  #endif
  
  #endif /* NET_GNRC_UDP_H */
  /** @} */