mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 04:50:03 +01:00
110 lines
3.3 KiB
C
110 lines
3.3 KiB
C
/*
|
|
* 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.
|
|
*/
|
|
|
|
/**
|
|
* @defgroup net_gnrc_icmpv6_echo ICMPv6 echo messages
|
|
* @ingroup net_gnrc_icmpv6
|
|
* @brief ICMPv6 echo request and reply
|
|
* @{
|
|
*
|
|
* @file
|
|
* @brief ICMPv6 echo message definitions
|
|
*
|
|
* @author Martine Lenders <mlenders@inf.fu-berlin.de>
|
|
*/
|
|
#ifndef GNRC_ICMPV6_ECHO_H_
|
|
#define GNRC_ICMPV6_ECHO_H_
|
|
|
|
#include <inttypes.h>
|
|
|
|
#include "byteorder.h"
|
|
#include "kernel_types.h"
|
|
#include "net/ipv6/hdr.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief Builds an ICMPv6 echo message of type @p type for sending.
|
|
*
|
|
* @param[in] type Type of the echo message. Expected to be either
|
|
* ICMPV6_ECHO_REQ or ICMPV6_ECHO_REP.
|
|
* @param[in] id ID for the echo message in host byte-order
|
|
* @param[in] seq Sequence number for the echo message in host byte-order
|
|
* @param[in] data Payload for the echo message
|
|
* @param[in] data_len Length of @p data
|
|
*
|
|
* @return The echo message on success
|
|
* @return NULL, on failure
|
|
*/
|
|
gnrc_pktsnip_t *gnrc_icmpv6_echo_build(uint8_t type, uint16_t id, uint16_t seq,
|
|
uint8_t *data, size_t data_len);
|
|
|
|
/**
|
|
* @brief Builds an ICMPv6 echo request for sending.
|
|
*
|
|
* @see <a href="https://tools.ietf.org/html/rfc4443#section-4.1">
|
|
* RFC 4443, section 4.1
|
|
* </a>
|
|
*
|
|
* @param[in] id ID for the echo request in host byte-order
|
|
* @param[in] seq Sequence number for the echo request in host byte-order
|
|
* @param[in] data Payload for the echo request
|
|
* @param[in] data_len Length of @p data
|
|
*
|
|
* @return The echo request message on success
|
|
* @return NULL, on failure
|
|
*/
|
|
static inline gnrc_pktsnip_t *gnrc_icmpv6_echo_req_build(uint16_t id, uint16_t seq,
|
|
uint8_t *data, size_t data_len)
|
|
{
|
|
return gnrc_icmpv6_echo_build(ICMPV6_ECHO_REQ, id, seq, data, data_len);
|
|
}
|
|
|
|
/**
|
|
* @brief Builds an ICMPv6 echo reply for sending.
|
|
*
|
|
* @see <a href="https://tools.ietf.org/html/rfc4443#section-4.2">
|
|
* RFC 4443, section 4.2
|
|
* </a>
|
|
*
|
|
* @param[in] id ID for the echo reply in host byte-order
|
|
* @param[in] seq Sequence number for the echo reply in host byte-order
|
|
* @param[in] data Payload for the echo reply
|
|
* @param[in] data_len Length of @p data
|
|
*
|
|
* @return The echo reply message on success
|
|
* @return NULL, on failure
|
|
*/
|
|
static inline gnrc_pktsnip_t *gnrc_icmpv6_echo_rep_build(uint16_t id, uint16_t seq,
|
|
uint8_t *data, size_t data_len)
|
|
{
|
|
return gnrc_icmpv6_echo_build(ICMPV6_ECHO_REP, id, seq, data, data_len);
|
|
}
|
|
|
|
|
|
/**
|
|
* @brief ICMPv6 echo request handler
|
|
*
|
|
* @param[in] iface The interface the echo requuest was received on.
|
|
* @param[in] ipv6_hdr The IPv6 header of the echo request.
|
|
* @param[in] echo The Echo Request message.
|
|
* @param[in] len Length of the echo request message (ipv6_hdr_t::len
|
|
* of @p ipv6_hdr minus length of extension headers).
|
|
*/
|
|
void gnrc_icmpv6_echo_req_handle(kernel_pid_t iface, ipv6_hdr_t *ipv6_hdr,
|
|
icmpv6_echo_t *echo, uint16_t len);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* GNRC_ICMPV6_ECHO_H_ */
|
|
/** @} */
|