Loading...
Searching...
No Matches
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
60
61#include "thread.h"
62#include "net/netopt.h"
64#include "net/gnrc/nettype.h"
65#include "net/gnrc/pkt.h"
66
67#ifdef __cplusplus
68extern "C" {
69#endif
70
74#define GNRC_NETAPI_MSG_TYPE_RCV (0x0201)
75
79#define GNRC_NETAPI_MSG_TYPE_SND (0x0202)
80
84#define GNRC_NETAPI_MSG_TYPE_SET (0x0203)
85
89#define GNRC_NETAPI_MSG_TYPE_GET (0x0204)
90
94#define GNRC_NETAPI_MSG_TYPE_ACK (0x0205)
95
101#define GNRC_NETAPI_MSG_TYPE_NOTIFY (0x0207)
102
107typedef struct {
109 uint16_t context;
110 void *data;
111 uint16_t data_len;
113
128
148int _gnrc_netapi_get_set(kernel_pid_t pid, netopt_t opt, uint16_t context,
149 void *data, size_t data_len, uint16_t type);
150
160static inline int gnrc_netapi_send(kernel_pid_t pid, gnrc_pktsnip_t *pkt)
161{
163}
164
175int gnrc_netapi_dispatch(gnrc_nettype_t type, uint32_t demux_ctx, uint16_t cmd,
176 gnrc_pktsnip_t *pkt);
177
188static inline int gnrc_netapi_dispatch_send(gnrc_nettype_t type, uint32_t demux_ctx,
189 gnrc_pktsnip_t *pkt)
190{
191 return gnrc_netapi_dispatch(type, demux_ctx, GNRC_NETAPI_MSG_TYPE_SND, pkt);
192}
193
210 void *data, size_t data_len);
211
222{
224}
225
236static inline int gnrc_netapi_dispatch_receive(gnrc_nettype_t type, uint32_t demux_ctx,
237 gnrc_pktsnip_t *pkt)
238{
239 return gnrc_netapi_dispatch(type, demux_ctx, GNRC_NETAPI_MSG_TYPE_RCV, pkt);
240}
241
257static inline int gnrc_netapi_get(kernel_pid_t pid, netopt_t opt,
258 uint16_t context, void *data, size_t max_len)
259{
260 return _gnrc_netapi_get_set(pid, opt, context, data, max_len,
262}
263
279static inline int gnrc_netapi_set(kernel_pid_t pid, netopt_t opt,
280 uint16_t context, const void *data,
281 size_t data_len)
282{
283 /* disregard const pointer. This *should* be safe and any modification
284 * to `data` should be considered a bug */
285 return _gnrc_netapi_get_set(pid, opt, context, (void *)data, data_len,
287}
288
289#ifdef __cplusplus
290}
291#endif
292
int16_t kernel_pid_t
Unique process identifier.
Definition sched.h:135
netapi_notify_t
Definition of notification event types in the network stack.
Definition notify.h:48
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:236
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:188
#define GNRC_NETAPI_MSG_TYPE_RCV
Messaging / IPC type for passing a Packet up the network stack
Definition netapi.h:74
#define GNRC_NETAPI_MSG_TYPE_SET
Messaging / IPC type for setting options of network modules
Definition netapi.h:84
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:279
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:257
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_notify(gnrc_nettype_t type, uint32_t demux_ctx, netapi_notify_t event, void *data, size_t data_len)
Sends a GNRC_NETAPI_MSG_TYPE_NOTIFY command 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:89
#define GNRC_NETAPI_MSG_TYPE_SND
Messaging / IPC type for passing a Packet down the network stack
Definition netapi.h:79
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:221
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:160
gnrc_nettype_t
Definition of protocol types in the network stack.
Definition nettype.h:51
struct gnrc_pktsnip gnrc_pktsnip_t
Type to represent parts (either headers or payload) of a packet, called snips.
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.
Network event notification type definitions.
event structure
Definition event.h:145
Data structure to be send for setting (GNRC_NETAPI_MSG_TYPE_SET) and getting (GNRC_NETAPI_MSG_TYPE_GE...
Definition netapi.h:107
uint16_t data_len
size of the data / the buffer
Definition netapi.h:111
void * data
data to set or buffer to read into
Definition netapi.h:110
uint16_t context
(optional) context for that option
Definition netapi.h:109
netopt_t opt
the option to get/set
Definition netapi.h:108