remove the footer saying that vim is the best editor -- anyone knows anyway

[pingcheck] / src / icmp / icmpechodata.h

/*
 The software in this package is distributed under the GNU General
 Public License version 2 (with a special exception described below).

 A copy of GNU General Public License (GPL) is included in this distribution,
 in the file COPYING.GPL.

 As a special exception, if other files instantiate templates or use macros
 or inline functions from this file, or you compile this file and link it
 with other works to produce a work based on this file, this file
 does not by itself cause the resulting work to be covered
 by the GNU General Public License.

 However the source code for this file must still be made available
 in accordance with section (3) of the GNU General Public License.

 This exception does not invalidate any other reasons why a work based
 on this file might be covered by the GNU General Public License.

 Christian Herdtweck, Intra2net AG 2015
 Based on an example in Boost Documentation (by Christopher M. Kohlhoff)
 and adaptation by Guilherme M. Ferreira
 */

#ifndef ICMP_ECHO_DATA_H
#define ICMP_ECHO_DATA_H

#include <stdint.h>
#include "icmp/icmpdata.h"

#include <boost/date_time/posix_time/ptime.hpp>
#include <boost/asio/ip/address.hpp>
using boost::asio::ip::address;

/** @brief Data part of ICMP echo request and echo reply packets
 *
 * represents the last 4 bytes of the ICMP header (for v4) and the 8 bytes
 *   of optional data; for v6 this (same amount of?!) data is defined as the
 *   body
 */
class IcmpEchoData : public IcmpData
{
public:
    IcmpEchoData(const uint16_t identifier, const uint16_t sequence_number,
                 const std::string &optional_data);

    IcmpEchoData(const std::size_t size_arg);

    bool match_destination_unreachable(const uint16_t identifier,
                                  const uint16_t sequence_number,
                                  const address &destination_address) const;

    bool match_echo_reply(const uint16_t identifier,
                          const uint16_t sequence_number) const;

    bool match_time_exceeded(const uint16_t identifier,
                             const uint16_t sequence_number) const;

    uint16_t get_identifier() const;

    uint16_t get_sequence_number() const;

    /**
     * @brief Prints the ICMP echo reply messages.
     *
     * @return void
     */
    void print( const size_t &bytes_received,
                const boost::posix_time::ptime &time_packet_sent,
                const std::string &remote_address,
                const uint32_t ttl) const;

    std::string to_string() const;
};

#endif