netapi.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2015 Freie Universität Berlin
3  *
4  * This file is subject to the terms and conditions of the GNU Lesser
5  * General Public License v2.1. See the file LICENSE in the top level
6  * directory for more details.
7  */
8 
9 #pragma once
10 
61 #include "thread.h"
62 #include "net/netopt.h"
63 #include "net/gnrc/nettype.h"
64 #include "net/gnrc/pkt.h"
65 
66 #ifdef __cplusplus
67 extern "C" {
68 #endif
69 
73 #define GNRC_NETAPI_MSG_TYPE_RCV (0x0201)
74 
78 #define GNRC_NETAPI_MSG_TYPE_SND (0x0202)
79 
83 #define GNRC_NETAPI_MSG_TYPE_SET (0x0203)
84 
88 #define GNRC_NETAPI_MSG_TYPE_GET (0x0204)
89 
93 #define GNRC_NETAPI_MSG_TYPE_ACK (0x0205)
94 
99 typedef struct {
101  uint16_t context;
102  void *data;
103  uint16_t data_len;
105 
119 int _gnrc_netapi_send_recv(kernel_pid_t pid, gnrc_pktsnip_t *pkt, uint16_t type);
120 
140 int _gnrc_netapi_get_set(kernel_pid_t pid, netopt_t opt, uint16_t context,
141  void *data, size_t data_len, uint16_t type);
142 
152 static inline int gnrc_netapi_send(kernel_pid_t pid, gnrc_pktsnip_t *pkt)
153 {
155 }
156 
167 int gnrc_netapi_dispatch(gnrc_nettype_t type, uint32_t demux_ctx, uint16_t cmd,
168  gnrc_pktsnip_t *pkt);
169 
180 static inline int gnrc_netapi_dispatch_send(gnrc_nettype_t type, uint32_t demux_ctx,
181  gnrc_pktsnip_t *pkt)
182 {
183  return gnrc_netapi_dispatch(type, demux_ctx, GNRC_NETAPI_MSG_TYPE_SND, pkt);
184 }
185 
195 static inline int gnrc_netapi_receive(kernel_pid_t pid, gnrc_pktsnip_t *pkt)
196 {
198 }
199 
210 static inline int gnrc_netapi_dispatch_receive(gnrc_nettype_t type, uint32_t demux_ctx,
211  gnrc_pktsnip_t *pkt)
212 {
213  return gnrc_netapi_dispatch(type, demux_ctx, GNRC_NETAPI_MSG_TYPE_RCV, pkt);
214 }
215 
231 static inline int gnrc_netapi_get(kernel_pid_t pid, netopt_t opt,
232  uint16_t context, void *data, size_t max_len)
233 {
234  return _gnrc_netapi_get_set(pid, opt, context, data, max_len,
236 }
237 
253 static inline int gnrc_netapi_set(kernel_pid_t pid, netopt_t opt,
254  uint16_t context, const void *data,
255  size_t data_len)
256 {
257  /* disregard const pointer. This *should* be safe and any modification
258  * to `data` should be considered a bug */
259  return _gnrc_netapi_get_set(pid, opt, context, (void *)data, data_len,
261 }
262 
263 #ifdef __cplusplus
264 }
265 #endif
266 
int16_t kernel_pid_t
Unique process identifier.
Definition: sched.h:138
static int gnrc_netapi_dispatch_receive(gnrc_nettype_t type, uint32_t demux_ctx, gnrc_pktsnip_t *pkt)
Sends a GNRC_NETAPI_MSG_TYPE_RCV command to all subscribers to (type, demux_ctx).
Definition: netapi.h:210
static int gnrc_netapi_dispatch_send(gnrc_nettype_t type, uint32_t demux_ctx, gnrc_pktsnip_t *pkt)
Sends a GNRC_NETAPI_MSG_TYPE_SND command to all subscribers to (type, demux_ctx).
Definition: netapi.h:180
#define GNRC_NETAPI_MSG_TYPE_RCV
Messaging / IPC type for passing a Packet up the network stack
Definition: netapi.h:73
#define GNRC_NETAPI_MSG_TYPE_SET
Messaging / IPC type for setting options of network modules
Definition: netapi.h:83
static int gnrc_netapi_set(kernel_pid_t pid, netopt_t opt, uint16_t context, const void *data, size_t data_len)
Shortcut function for sending GNRC_NETAPI_MSG_TYPE_SET messages and parsing the returned GNRC_NETAPI_...
Definition: netapi.h:253
static int gnrc_netapi_get(kernel_pid_t pid, netopt_t opt, uint16_t context, void *data, size_t max_len)
Shortcut function for sending GNRC_NETAPI_MSG_TYPE_GET messages and parsing the returned GNRC_NETAPI_...
Definition: netapi.h:231
int gnrc_netapi_dispatch(gnrc_nettype_t type, uint32_t demux_ctx, uint16_t cmd, gnrc_pktsnip_t *pkt)
Sends cmd to all subscribers to (type, demux_ctx).
int _gnrc_netapi_get_set(kernel_pid_t pid, netopt_t opt, uint16_t context, void *data, size_t data_len, uint16_t type)
Shortcut function for sending GNRC_NETAPI_MSG_TYPE_GET or GNRC_NETAPI_MSG_TYPE_SET messages and parsi...
#define GNRC_NETAPI_MSG_TYPE_GET
Messaging / IPC type for getting options from network modules
Definition: netapi.h:88
#define GNRC_NETAPI_MSG_TYPE_SND
Messaging / IPC type for passing a Packet down the network stack
Definition: netapi.h:78
int _gnrc_netapi_send_recv(kernel_pid_t pid, gnrc_pktsnip_t *pkt, uint16_t type)
Shortcut function for sending GNRC_NETAPI_MSG_TYPE_SND or GNRC_NETAPI_MSG_TYPE_RCV messages.
static int gnrc_netapi_receive(kernel_pid_t pid, gnrc_pktsnip_t *pkt)
Shortcut function for sending GNRC_NETAPI_MSG_TYPE_RCV messages.
Definition: netapi.h:195
static int gnrc_netapi_send(kernel_pid_t pid, gnrc_pktsnip_t *pkt)
Shortcut function for sending GNRC_NETAPI_MSG_TYPE_SND messages.
Definition: netapi.h:152
gnrc_nettype_t
Definition of protocol types in the network stack.
Definition: nettype.h:51
netopt_t
Global list of configuration options available throughout the network stack, e.g.
Definition: netopt.h:44
General definitions for network packets and their helper functions.
Definition of global configuration options.
Protocol type definitions.
Data structure to be send for setting (GNRC_NETAPI_MSG_TYPE_SET) and getting (GNRC_NETAPI_MSG_TYPE_GE...
Definition: netapi.h:99
uint16_t data_len
size of the data / the buffer
Definition: netapi.h:103
void * data
data to set or buffer to read into
Definition: netapi.h:102
uint16_t context
(optional) context for that option
Definition: netapi.h:101
netopt_t opt
the option to get/set
Definition: netapi.h:100
Type to represent parts (either headers or payload) of a packet, called snips.
Definition: pkt.h:108