Message.h

#pragma once
 
#include <xrpld/overlay/Compression.h>
 
#include <xrpl/basics/ByteUtilities.h>
#include <xrpl/protocol/PublicKey.h>
#include <xrpl/protocol/messages.h>
 
#include <algorithm>
#include <cstdint>
 
namespace xrpl {
 
constexpr std::size_t maximumMessageSize = megabytes(64);
 
// VFALCO NOTE If we forward declare Message and write out shared_ptr
//             instead of using the in-class type alias, we can remove the
//             entire ripple.pb.h from the main headers.
//
 
// packaging of messages into length/type-prepended buffers
// ready for transmission.
//
// Message implements simple "packing" of protocol buffers Messages into
// a string prepended by a header specifying the message length.
// MessageType should be a Message class generated by the protobuf compiler.
//
 
class Message : public std::enable_shared_from_this<Message>
{
    using Compressed = compression::Compressed;
    using Algorithm = compression::Algorithm;
 
public:
    Message(
        ::google::protobuf::Message const& message,
        protocol::MessageType type,
        std::optional<PublicKey> const& validator = {});
 
    std::size_t
    getBufferSize();
 
    static std::size_t
    messageSize(::google::protobuf::Message const& message);
 
    static std::size_t
    totalSize(::google::protobuf::Message const& message);
 
    std::vector<uint8_t> const&
    getBuffer(Compressed tryCompressed);
 
    std::size_t
    getCategory() const
    {
        return category_;
    }
 
    std::optional<PublicKey> const&
    getValidatorKey() const
    {
        return validatorKey_;
    }
 
private:
    std::vector<uint8_t> buffer_;
    std::vector<uint8_t> bufferCompressed_;
    std::size_t category_;
    std::once_flag once_flag_;
    std::optional<PublicKey> validatorKey_;
 
    void
    setHeader(
        std::uint8_t* in,
        std::uint32_t payloadBytes,
        int type,
        Algorithm compression,
        std::uint32_t uncompressedBytes);
 
    void
    compress();
 
    int
    getType(std::uint8_t const* in) const;
};
 
}  // namespace xrpl