echo_8h_source.html

/*

 * Copyright (C) 2015 Martine Lenders <mlenders@inf.fu-berlin.de>

 *

 * 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.

 */


#ifndef NET_GNRC_ICMPV6_ECHO_H

#define NET_GNRC_ICMPV6_ECHO_H


#include <inttypes.h>


#include "byteorder.h"

#include "net/gnrc/netif.h"

#include "net/gnrc/netif/hdr.h"

#include "net/ipv6/hdr.h"

#include "net/icmpv6.h"


#ifdef __cplusplus

extern "C" {

#endif


gnrc_pktsnip_t *gnrc_icmpv6_echo_build(uint8_t type, uint16_t id, uint16_t seq,

                                       uint8_t *data, size_t data_len);


void gnrc_icmpv6_echo_req_handle(gnrc_netif_t *netif, ipv6_hdr_t *ipv6_hdr,

                                 icmpv6_echo_t *echo, uint16_t len);


int gnrc_icmpv6_echo_send(const gnrc_netif_t *netif, const ipv6_addr_t *addr,

                          uint16_t id, uint16_t seq, uint8_t ttl, size_t len);


typedef int (*gnrc_icmpv6_echo_rsp_handle_cb_t)(gnrc_pktsnip_t *pkt,

                                                int corrupt, uint32_t rtt_us, void *ctx);

int gnrc_icmpv6_echo_rsp_handle(gnrc_pktsnip_t *pkt, size_t len,

                                gnrc_icmpv6_echo_rsp_handle_cb_t cb, void *ctx);


#ifdef __cplusplus

}

#endif


#endif /* NET_GNRC_ICMPV6_ECHO_H */

byteorder.h
Functions to work with different byte orders.

netif.h
Definition for GNRC's network interfaces.

gnrc_icmpv6_echo_send
int gnrc_icmpv6_echo_send(const gnrc_netif_t *netif, const ipv6_addr_t *addr, uint16_t id, uint16_t seq, uint8_t ttl, size_t len)
Send out ICMPv6 echo request.

gnrc_icmpv6_echo_req_handle
void gnrc_icmpv6_echo_req_handle(gnrc_netif_t *netif, ipv6_hdr_t *ipv6_hdr, icmpv6_echo_t *echo, uint16_t len)
ICMPv6 echo request handler.

gnrc_icmpv6_echo_rsp_handle_cb_t
int(* gnrc_icmpv6_echo_rsp_handle_cb_t)(gnrc_pktsnip_t *pkt, int corrupt, uint32_t rtt_us, void *ctx)
ICMPv6 echo response callback.
Definition echo.h:90

gnrc_icmpv6_echo_rsp_handle
int gnrc_icmpv6_echo_rsp_handle(gnrc_pktsnip_t *pkt, size_t len, gnrc_icmpv6_echo_rsp_handle_cb_t cb, void *ctx)
Parse ICMPv6 echo response.

gnrc_icmpv6_echo_build
gnrc_pktsnip_t * gnrc_icmpv6_echo_build(uint8_t type, uint16_t id, uint16_t seq, uint8_t *data, size_t data_len)
Builds an ICMPv6 echo message of type type for sending.

icmpv6.h
ICMPv6 type and function definitions.

inttypes.h
Adds include for missing inttype definitions.

hdr.h
Generic network interface header.

hdr.h
IPv6 header type and helper function definitions.

gnrc_netif_t
Representation of a network interface.
Definition netif.h:135

gnrc_pktsnip
Type to represent parts (either headers or payload) of a packet, called snips.
Definition pkt.h:108

icmpv6_echo_t
Echo request and response message format.
Definition icmpv6.h:215

ipv6_hdr_t
Data type to represent an IPv6 packet header.
Definition hdr.h:66

ipv6_addr_t
Data type to represent an IPv6 address.
Definition addr.h:72