Blame view

RIOT/sys/include/net/gnrc/pktdump.h 1.45 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
  /*
   * 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_pktdump Dump Network Packets
   * @ingroup     net_gnrc
   * @brief       Dump network packets to STDOUT for debugging
   *
   * @{
   *
   * @file
   * @brief       Interface for a generic network packet dumping module
   *
   * @author      Hauke Petersen <hauke.petersen@fu-berlin.de>
   */
  
  #ifndef NET_GNRC_PKTDUMP_H
  #define NET_GNRC_PKTDUMP_H
  
  #include "kernel_types.h"
  
  #ifdef __cplusplus
  extern "C" {
  #endif
  
  /**
   * @brief   Message queue size for the pktdump thread
   */
  #ifndef GNRC_PKTDUMP_MSG_QUEUE_SIZE
  #define GNRC_PKTDUMP_MSG_QUEUE_SIZE     (8U)
  #endif
  
  /**
   * @brief   Priority of the pktdump thread
   */
  #ifndef GNRC_PKTDUMP_PRIO
  #define GNRC_PKTDUMP_PRIO               (THREAD_PRIORITY_MAIN - 1)
  #endif
  
  /**
   * @brief   Stack size used for the pktdump thread
   */
  #ifndef GNRC_PKTDUMP_STACKSIZE
  #define GNRC_PKTDUMP_STACKSIZE          (THREAD_STACKSIZE_MAIN)
  #endif
  
  /**
   * @brief   The PID of the pktdump thread
   */
  extern kernel_pid_t gnrc_pktdump_pid;
  
  /**
   * @brief   Start the packet dump thread and listening for incoming packets
   *
   * @return  PID of the pktdump thread
   * @return  negative value on error
   */
  kernel_pid_t gnrc_pktdump_init(void);
  
  #ifdef __cplusplus
  }
  #endif
  
  #endif /* NET_GNRC_PKTDUMP_H */
  /** @} */