git-subtree-dir: libs/CommService git-subtree-split: 7ccc0fce88bbc5969df060058cf0fb57abe3bcf9
64 lines
1.6 KiB
C++
64 lines
1.6 KiB
C++
#ifndef __LIBBC_BC_PAYLOADS_PING_HPP__
|
|
#define __LIBBC_BC_PAYLOADS_PING_HPP__
|
|
/*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
|
*/
|
|
|
|
|
|
/**
|
|
* @file
|
|
* @brief main header file for the BC::Payloads::Ping payload
|
|
* @author Dominik Meyer <dmeyer@hsu-hh.de>
|
|
* @date 2019-02-06
|
|
* @copyright 2019 no yet defined
|
|
*/
|
|
#include <BC/BC.hpp>
|
|
#include <BC/transmittable.hpp>
|
|
#include <cstdint>
|
|
#include <vector>
|
|
#include <random>
|
|
|
|
namespace BC
|
|
{
|
|
|
|
namespace Payloads
|
|
{
|
|
/**
|
|
* @brief class representing the payload of a Ping message
|
|
*
|
|
* the Ping messages is transmitted can be published to all or individual nodes.
|
|
* these nodes will answer with a Pong message
|
|
*
|
|
*/
|
|
class Ping : public BC::transmittable
|
|
{
|
|
public:
|
|
Ping();
|
|
/**
|
|
* @brief constructor to recreate the HotPlugJoin payload from a a std::vector<unsigned char>
|
|
*/
|
|
explicit Ping(std::vector<unsigned char> v);
|
|
|
|
/// message id uniqly identifying one ping message
|
|
uint64_t messageID;
|
|
|
|
/// the sequence number of the ping
|
|
uint64_t sequenceNr;
|
|
|
|
/// the local clock ticks
|
|
uint64_t pingTime;
|
|
|
|
/**
|
|
* @brief converts the information of the class (the attributes) to a byte vector
|
|
*
|
|
* @param byteVector - returns a std::vector of bytes representing the class
|
|
*/
|
|
std::vector<unsigned char> toByteVector() const override;
|
|
};
|
|
}; //namespace Payloads
|
|
}; //namespace BC
|
|
|
|
#endif
|