Compare commits
14 Commits
e16ad84865
...
v1.0.3
| Author | SHA1 | Date | |
|---|---|---|---|
| 4a7eb7a1df | |||
| 61d0ce3a47 | |||
| 5beb5e92a7 | |||
| 59aaf03421 | |||
| 03d799e064 | |||
| 8a5286d0ce | |||
| a194774925 | |||
| 8f32b09b17 | |||
| 60bb4ea06e | |||
| 2acbd76c5a | |||
| 468f5ce8a0 | |||
| f145716cf6 | |||
| 6ee7524e17 | |||
| db0c5f3245 |
31
.github/workflows/ubuntu.yml
vendored
Normal file
31
.github/workflows/ubuntu.yml
vendored
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
name: Linux arm64
|
||||||
|
run-name: Build And Test
|
||||||
|
|
||||||
|
on: [push]
|
||||||
|
|
||||||
|
|
||||||
|
env:
|
||||||
|
XMAKE_ROOT: y
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
Build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Check out repository code
|
||||||
|
uses: actions/checkout@v3
|
||||||
|
|
||||||
|
- name: Prepare XMake
|
||||||
|
uses: xmake-io/github-action-setup-xmake@v1
|
||||||
|
with:
|
||||||
|
xmake-version: latest
|
||||||
|
actions-cache-folder: '.xmake-cache'
|
||||||
|
actions-cache-key: 'ubuntu'
|
||||||
|
|
||||||
|
- name: XMake config
|
||||||
|
run: xmake f -p linux -y
|
||||||
|
|
||||||
|
- name: Build
|
||||||
|
run: xmake
|
||||||
|
|
||||||
|
- name: Test
|
||||||
|
run: xmake test
|
||||||
10
README.md
Normal file
10
README.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
# SimpleProtocolLib
|
||||||
|
|
||||||
|
Network engine used to (mainly) communicate with packets
|
||||||
|
|
||||||
|
# Integrate with xmake
|
||||||
|
|
||||||
|
```lua
|
||||||
|
add_repositories("persson-repo https://git.ale-pri.com/Persson-dev/xmake-repo.git")
|
||||||
|
add_requires("splib", { debug = is_mode("debug") })
|
||||||
|
```
|
||||||
@@ -4,10 +4,17 @@
|
|||||||
#include <sp/protocol/Field.h>
|
#include <sp/protocol/Field.h>
|
||||||
#include <sp/protocol/MessageBase.h>
|
#include <sp/protocol/MessageBase.h>
|
||||||
|
|
||||||
enum DisconnectPacketFields {
|
enum class DisconnectFieldsE {
|
||||||
Reason = 0
|
Reason = 0
|
||||||
};
|
};
|
||||||
|
|
||||||
using DisconnectFields = std::tuple<std::string /*Reason*/>;
|
using DisconnectFields = std::tuple<std::string /*Reason*/>;
|
||||||
|
|
||||||
DeclarePacket(Disconnect);
|
DeclarePacket(Disconnect){
|
||||||
|
public:
|
||||||
|
PacketConstructor(Disconnect)
|
||||||
|
|
||||||
|
const std::string& GetReason() const {
|
||||||
|
return GetField<DisconnectFieldsE, DisconnectFieldsE::Reason>();
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|||||||
@@ -4,10 +4,19 @@
|
|||||||
#include <sp/protocol/Field.h>
|
#include <sp/protocol/Field.h>
|
||||||
#include <sp/protocol/MessageBase.h>
|
#include <sp/protocol/MessageBase.h>
|
||||||
|
|
||||||
enum KeepAlivePacketFields {
|
enum class KeepAliveFieldsE {
|
||||||
KeepAliveId = 0
|
KeepAliveId = 0,
|
||||||
};
|
};
|
||||||
|
|
||||||
using KeepAliveFields = std::tuple<std::uint64_t /*KeepAliveId*/>;
|
using KeepAliveFields = std::tuple<
|
||||||
|
std::uint64_t //<- KeepAliveId
|
||||||
|
>;
|
||||||
|
|
||||||
DeclarePacket(KeepAlive);
|
DeclarePacket(KeepAlive){
|
||||||
|
public:
|
||||||
|
PacketConstructor(KeepAlive)
|
||||||
|
|
||||||
|
std::uint64_t GetKeepAliveId() const {
|
||||||
|
return GetField<KeepAliveFieldsE, KeepAliveFieldsE::KeepAliveId>();
|
||||||
|
}
|
||||||
|
};
|
||||||
@@ -3,13 +3,16 @@
|
|||||||
enum PacketId {
|
enum PacketId {
|
||||||
KeepAlive = 0,
|
KeepAlive = 0,
|
||||||
Disconnect,
|
Disconnect,
|
||||||
|
UpgradeTower,
|
||||||
};
|
};
|
||||||
|
|
||||||
#include <examples/KeepAlivePacket.h>
|
|
||||||
#include <examples/DisconnectPacket.h>
|
#include <examples/DisconnectPacket.h>
|
||||||
|
#include <examples/KeepAlivePacket.h>
|
||||||
|
#include <examples/UpgradeTowerPacket.h>
|
||||||
|
|
||||||
// they must be in the same order !
|
// they must be in the same order as in the enum !
|
||||||
using AllPackets = std::tuple<KeepAlivePacket, DisconnectPacket>;
|
using AllPackets = std::tuple<KeepAlivePacket, DisconnectPacket, UpgradeTowerPacket>;
|
||||||
|
|
||||||
#include <sp/default/DefaultPacketHandler.h>
|
#include <sp/default/DefaultPacketDispatcher.h>
|
||||||
#include <sp/default/DefaultPacketFactory.h>
|
#include <sp/default/DefaultPacketFactory.h>
|
||||||
|
#include <sp/default/DefaultPacketHandler.h>
|
||||||
31
include/examples/UpgradeTowerPacket.h
Normal file
31
include/examples/UpgradeTowerPacket.h
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include <sp/default/DefaultPacket.h>
|
||||||
|
#include <sp/protocol/Field.h>
|
||||||
|
#include <sp/protocol/MessageBase.h>
|
||||||
|
|
||||||
|
|
||||||
|
enum class UpgradeTowerFieldsE {
|
||||||
|
m_Tower = 0,
|
||||||
|
m_Upgrade,
|
||||||
|
};
|
||||||
|
|
||||||
|
using UpgradeTowerFields = std::tuple<
|
||||||
|
sp::BitField<std::uint16_t,
|
||||||
|
sp::Field<std::uint16_t, 12>, //<- m_Tower
|
||||||
|
sp::Field<std::uint8_t, 4> //<- m_Upgrade
|
||||||
|
>
|
||||||
|
>;
|
||||||
|
|
||||||
|
DeclarePacket(UpgradeTower){
|
||||||
|
public:
|
||||||
|
PacketConstructor(UpgradeTower)
|
||||||
|
|
||||||
|
std::uint16_t GetTowerId() const {
|
||||||
|
return GetField<0>().GetField<UpgradeTowerFieldsE, UpgradeTowerFieldsE::m_Tower>();
|
||||||
|
}
|
||||||
|
|
||||||
|
std::uint8_t GetTowerUpgrade() const {
|
||||||
|
return GetField<0>().GetField<UpgradeTowerFieldsE, UpgradeTowerFieldsE::m_Upgrade>();
|
||||||
|
}
|
||||||
|
};
|
||||||
@@ -1,26 +1,10 @@
|
|||||||
#pragma once
|
#pragma once
|
||||||
|
|
||||||
#ifdef _WIN32
|
|
||||||
#include <winsock2.h>
|
|
||||||
#else
|
|
||||||
#include <arpa/inet.h>
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#include <cstdint>
|
#include <cstdint>
|
||||||
|
|
||||||
namespace sp {
|
namespace sp {
|
||||||
|
|
||||||
template <typename T>
|
bool IsSystemBigEndian();
|
||||||
void SwapBytes(T& value) {
|
|
||||||
char* ptr = reinterpret_cast<char*>(&value);
|
|
||||||
std::reverse(ptr, ptr + sizeof(T));
|
|
||||||
}
|
|
||||||
|
|
||||||
bool IsSystemBigEndian() {
|
|
||||||
static constexpr std::uint16_t test = 10;
|
|
||||||
static const bool isBigEndian = reinterpret_cast<const std::uint8_t*>(&test)[1] == 10;
|
|
||||||
return isBigEndian;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \brief Serialize value to (network byte order) big endian
|
* \brief Serialize value to (network byte order) big endian
|
||||||
@@ -29,21 +13,13 @@ template <typename T>
|
|||||||
void ToNetwork(T& value) {}
|
void ToNetwork(T& value) {}
|
||||||
|
|
||||||
template <>
|
template <>
|
||||||
void ToNetwork<std::uint16_t>(std::uint16_t& value) {
|
void ToNetwork<std::uint16_t>(std::uint16_t& value);
|
||||||
value = htons(value);
|
|
||||||
}
|
|
||||||
|
|
||||||
template <>
|
template <>
|
||||||
void ToNetwork<std::uint32_t>(std::uint32_t& value) {
|
void ToNetwork<std::uint32_t>(std::uint32_t& value);
|
||||||
value = htonl(value);
|
|
||||||
}
|
|
||||||
|
|
||||||
template <>
|
template <>
|
||||||
void ToNetwork<std::uint64_t>(std::uint64_t& value) {
|
void ToNetwork<std::uint64_t>(std::uint64_t& value);
|
||||||
if (IsSystemBigEndian())
|
|
||||||
return;
|
|
||||||
SwapBytes(value);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \brief Deserialize value from (network byte order) big endian
|
* \brief Deserialize value from (network byte order) big endian
|
||||||
@@ -52,21 +28,13 @@ template <typename T>
|
|||||||
void FromNetwork(T& value) {}
|
void FromNetwork(T& value) {}
|
||||||
|
|
||||||
template <>
|
template <>
|
||||||
void FromNetwork<std::uint16_t>(std::uint16_t& value) {
|
void FromNetwork<std::uint16_t>(std::uint16_t& value);
|
||||||
value = ntohs(value);
|
|
||||||
}
|
|
||||||
|
|
||||||
template <>
|
template <>
|
||||||
void FromNetwork<std::uint32_t>(std::uint32_t& value) {
|
void FromNetwork<std::uint32_t>(std::uint32_t& value);
|
||||||
value = ntohl(value);
|
|
||||||
}
|
|
||||||
|
|
||||||
template <>
|
template <>
|
||||||
void FromNetwork<std::uint64_t>(std::uint64_t& value) {
|
void FromNetwork<std::uint64_t>(std::uint64_t& value);
|
||||||
if (IsSystemBigEndian())
|
|
||||||
return;
|
|
||||||
SwapBytes(value);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \brief Swap bytes if the value is any kind of integer
|
* \brief Swap bytes if the value is any kind of integer
|
||||||
@@ -75,18 +43,12 @@ template <typename T>
|
|||||||
void TrySwapBytes(T& value) {}
|
void TrySwapBytes(T& value) {}
|
||||||
|
|
||||||
template <>
|
template <>
|
||||||
void TrySwapBytes<std::uint16_t>(std::uint16_t& value) {
|
void TrySwapBytes<std::uint16_t>(std::uint16_t& value);
|
||||||
SwapBytes(value);
|
|
||||||
}
|
|
||||||
|
|
||||||
template <>
|
template <>
|
||||||
void TrySwapBytes<std::uint32_t>(std::uint32_t& value) {
|
void TrySwapBytes<std::uint32_t>(std::uint32_t& value);
|
||||||
SwapBytes(value);
|
|
||||||
}
|
|
||||||
|
|
||||||
template <>
|
template <>
|
||||||
void TrySwapBytes<std::uint64_t>(std::uint64_t& value) {
|
void TrySwapBytes<std::uint64_t>(std::uint64_t& value);
|
||||||
SwapBytes(value);
|
|
||||||
}
|
|
||||||
|
|
||||||
} // namespace sp
|
} // namespace sp
|
||||||
|
|||||||
@@ -13,6 +13,7 @@
|
|||||||
#include <string>
|
#include <string>
|
||||||
#include <sp/common/VarInt.h>
|
#include <sp/common/VarInt.h>
|
||||||
#include <vector>
|
#include <vector>
|
||||||
|
#include <map>
|
||||||
|
|
||||||
namespace sp {
|
namespace sp {
|
||||||
|
|
||||||
@@ -34,6 +35,7 @@ class DataBuffer {
|
|||||||
typedef Data::difference_type difference_type;
|
typedef Data::difference_type difference_type;
|
||||||
|
|
||||||
DataBuffer();
|
DataBuffer();
|
||||||
|
DataBuffer(std::size_t a_InitialSize);
|
||||||
DataBuffer(const DataBuffer& other);
|
DataBuffer(const DataBuffer& other);
|
||||||
DataBuffer(const DataBuffer& other, difference_type offset);
|
DataBuffer(const DataBuffer& other, difference_type offset);
|
||||||
DataBuffer(DataBuffer&& other);
|
DataBuffer(DataBuffer&& other);
|
||||||
@@ -88,6 +90,19 @@ class DataBuffer {
|
|||||||
return *this;
|
return *this;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief Append a map to the buffer by first writing the size
|
||||||
|
* \param data The map to append
|
||||||
|
*/
|
||||||
|
template <typename K, typename V>
|
||||||
|
DataBuffer& operator<<(const std::map<K, V>& data) {
|
||||||
|
*this << VarInt{data.size()};
|
||||||
|
for (const auto& element : data) {
|
||||||
|
*this << element.first << element.second;
|
||||||
|
}
|
||||||
|
return *this;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \brief Append an array to the buffer by first writing the size
|
* \brief Append an array to the buffer by first writing the size
|
||||||
* \param data The buffer to append
|
* \param data The buffer to append
|
||||||
@@ -140,6 +155,23 @@ class DataBuffer {
|
|||||||
return *this;
|
return *this;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief Read a map (size + data) from the buffer
|
||||||
|
* \pre The map is assumed to be empty
|
||||||
|
*/
|
||||||
|
template <typename K, typename V>
|
||||||
|
DataBuffer& operator>>(std::map<K, V>& data) {
|
||||||
|
VarInt mapSize;
|
||||||
|
*this >> mapSize;
|
||||||
|
for (std::size_t i = 0; i < mapSize.GetValue(); i++) {
|
||||||
|
K newKey;
|
||||||
|
V newValue;
|
||||||
|
*this >> newKey >> newValue;
|
||||||
|
data.emplace(newKey, newValue);
|
||||||
|
}
|
||||||
|
return *this;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \brief Read an array from the buffer
|
* \brief Read an array from the buffer
|
||||||
*/
|
*/
|
||||||
@@ -261,13 +293,13 @@ class DataBuffer {
|
|||||||
* \brief Read a file into the buffer
|
* \brief Read a file into the buffer
|
||||||
* \param fileName The name of the file to read
|
* \param fileName The name of the file to read
|
||||||
*/
|
*/
|
||||||
bool ReadFile(const std::string& fileName);
|
void ReadFile(const std::string& fileName);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \brief Write a file into the buffer
|
* \brief Write a file into the buffer
|
||||||
* \param fileName The name of the file to write to
|
* \param fileName The name of the file to write to
|
||||||
*/
|
*/
|
||||||
bool WriteFile(const std::string& fileName) const;
|
void WriteFile(const std::string& fileName) const;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \brief Allocate the buffer on the heap
|
* \brief Allocate the buffer on the heap
|
||||||
|
|||||||
@@ -1,54 +0,0 @@
|
|||||||
/*
|
|
||||||
* Created by William Swanson in 2012.
|
|
||||||
*
|
|
||||||
* I, William Swanson, dedicate this work to the public domain.
|
|
||||||
* I waive all rights to the work worldwide under copyright law,
|
|
||||||
* including all related and neighboring rights,
|
|
||||||
* to the extent allowed by law.
|
|
||||||
*
|
|
||||||
* You can copy, modify, distribute and perform the work,
|
|
||||||
* even for commercial purposes, all without asking permission.
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef MAP_H_INCLUDED
|
|
||||||
#define MAP_H_INCLUDED
|
|
||||||
|
|
||||||
#define EVAL0(...) __VA_ARGS__
|
|
||||||
#define EVAL1(...) EVAL0(EVAL0(EVAL0(__VA_ARGS__)))
|
|
||||||
#define EVAL2(...) EVAL1(EVAL1(EVAL1(__VA_ARGS__)))
|
|
||||||
#define EVAL3(...) EVAL2(EVAL2(EVAL2(__VA_ARGS__)))
|
|
||||||
#define EVAL4(...) EVAL3(EVAL3(EVAL3(__VA_ARGS__)))
|
|
||||||
#define EVAL(...) EVAL4(EVAL4(EVAL4(__VA_ARGS__)))
|
|
||||||
|
|
||||||
#define MAP_END(...)
|
|
||||||
#define MAP_OUT
|
|
||||||
#define MAP_COMMA ,
|
|
||||||
|
|
||||||
#define MAP_GET_END2() 0, MAP_END
|
|
||||||
#define MAP_GET_END1(...) MAP_GET_END2
|
|
||||||
#define MAP_GET_END(...) MAP_GET_END1
|
|
||||||
#define MAP_NEXT0(test, next, ...) next MAP_OUT
|
|
||||||
#define MAP_NEXT1(test, next) MAP_NEXT0(test, next, 0)
|
|
||||||
#define MAP_NEXT(test, next) MAP_NEXT1(MAP_GET_END test, next)
|
|
||||||
|
|
||||||
#define MAP0(f, x, peek, ...) f(x) MAP_NEXT(peek, MAP1)(f, peek, __VA_ARGS__)
|
|
||||||
#define MAP1(f, x, peek, ...) f(x) MAP_NEXT(peek, MAP0)(f, peek, __VA_ARGS__)
|
|
||||||
|
|
||||||
#define MAP_LIST_NEXT1(test, next) MAP_NEXT0(test, MAP_COMMA next, 0)
|
|
||||||
#define MAP_LIST_NEXT(test, next) MAP_LIST_NEXT1(MAP_GET_END test, next)
|
|
||||||
|
|
||||||
#define MAP_LIST0(f, x, peek, ...) f(x) MAP_LIST_NEXT(peek, MAP_LIST1)(f, peek, __VA_ARGS__)
|
|
||||||
#define MAP_LIST1(f, x, peek, ...) f(x) MAP_LIST_NEXT(peek, MAP_LIST0)(f, peek, __VA_ARGS__)
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Applies the function macro `f` to each of the remaining parameters.
|
|
||||||
*/
|
|
||||||
#define MAP(f, ...) EVAL(MAP1(f, __VA_ARGS__, ()()(), ()()(), ()()(), 0))
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Applies the function macro `f` to each of the remaining parameters and
|
|
||||||
* inserts commas between the results.
|
|
||||||
*/
|
|
||||||
#define MAP_LIST(f, ...) EVAL(MAP_LIST1(f, __VA_ARGS__, ()()(), ()()(), ()()(), 0))
|
|
||||||
|
|
||||||
#endif
|
|
||||||
@@ -21,6 +21,8 @@ class VarInt {
|
|||||||
std::uint64_t m_Value;
|
std::uint64_t m_Value;
|
||||||
|
|
||||||
public:
|
public:
|
||||||
|
static const std::uint64_t MAX_VALUE = static_cast<std::uint64_t>(-1) >> 8;
|
||||||
|
|
||||||
VarInt() : m_Value(0) {}
|
VarInt() : m_Value(0) {}
|
||||||
/**
|
/**
|
||||||
* \brief Construct a variable integer from a value
|
* \brief Construct a variable integer from a value
|
||||||
|
|||||||
@@ -6,22 +6,25 @@
|
|||||||
namespace sp {
|
namespace sp {
|
||||||
class PacketHandler;
|
class PacketHandler;
|
||||||
|
|
||||||
using PacketMessage = Message<option::MsgIdType<std::uint8_t>, // add id() operation
|
using PacketMessage = Message<
|
||||||
option::ReadOperations, // add read() operation
|
option::MsgIdType<std::uint8_t>, // add id() operation
|
||||||
option::WriteOperations, // add write() operation
|
option::ReadOperations, // add read() operation
|
||||||
option::WriteId, // write id before data
|
option::WriteOperations, // add write() operation
|
||||||
option::Handler<PacketHandler> // add dispatch() operation
|
option::WriteId, // write id before data
|
||||||
>;
|
option::Handler<PacketHandler> // add dispatch() operation
|
||||||
|
>;
|
||||||
|
|
||||||
|
#define PacketConstructor(packetName) \
|
||||||
|
packetName##Packet() {} \
|
||||||
|
template <typename... Args> \
|
||||||
|
packetName##Packet(Args... args) { \
|
||||||
|
Construct(args...); \
|
||||||
|
}
|
||||||
|
|
||||||
#define DeclarePacket(packetName) \
|
#define DeclarePacket(packetName) \
|
||||||
class packetName##Packet : public sp::MessageBase<sp::PacketMessage, sp::option::StaticNumIdImpl<packetName>, \
|
class packetName##Packet : public sp::MessageBase<sp::PacketMessage, sp::option::StaticNumIdImpl<packetName>, \
|
||||||
sp::option::DispatchImpl<packetName##Packet>, sp::option::FieldsImpl<packetName##Fields>> { \
|
sp::option::DispatchImpl<packetName##Packet>, sp::option::FieldsImpl<packetName##Fields>>
|
||||||
public: \
|
|
||||||
packetName##Packet() {} \
|
|
||||||
template <typename... Args> \
|
|
||||||
packetName##Packet(Args... args) { \
|
|
||||||
Construct(args...); \
|
|
||||||
} \
|
|
||||||
}
|
|
||||||
|
|
||||||
} // namespace sp
|
} // namespace sp
|
||||||
|
|||||||
15
include/sp/default/DefaultPacketDispatcher.h
Normal file
15
include/sp/default/DefaultPacketDispatcher.h
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include <sp/default/DefaultPacket.h>
|
||||||
|
#include <sp/default/DefaultPacketHandler.h>
|
||||||
|
#include <sp/protocol/MessageDispatcher.h>
|
||||||
|
|
||||||
|
namespace sp {
|
||||||
|
|
||||||
|
using PacketDispatcher = MessageDispatcher<
|
||||||
|
PacketMessage::ParsedOptions::MsgIdType,
|
||||||
|
PacketMessage,
|
||||||
|
PacketMessage::ParsedOptions::HandlerType::HandlerT
|
||||||
|
>;
|
||||||
|
|
||||||
|
} // namespace sp
|
||||||
54
include/sp/extensions/Compress.h
Normal file
54
include/sp/extensions/Compress.h
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \file Compression.h
|
||||||
|
* \brief File containing compress utilities
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include <cstdint>
|
||||||
|
#include <sp/common/DataBuffer.h>
|
||||||
|
|
||||||
|
namespace sp {
|
||||||
|
namespace option {
|
||||||
|
|
||||||
|
struct ZlibCompress {
|
||||||
|
bool m_Enabled = true;
|
||||||
|
std::size_t m_CompressionThreshold = 64;
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace option
|
||||||
|
} // namespace sp
|
||||||
|
|
||||||
|
#include <sp/io/IOInterface.h>
|
||||||
|
|
||||||
|
namespace sp {
|
||||||
|
namespace zlib {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief Compress some data
|
||||||
|
* \param buffer the data to compress
|
||||||
|
* \return the compressed data
|
||||||
|
*/
|
||||||
|
DataBuffer Compress(const DataBuffer& buffer, std::size_t a_CompressionThreshold = 64);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief Uncompress some data
|
||||||
|
* \param buffer the data to uncompress
|
||||||
|
* \param packetLength lenght of data
|
||||||
|
* \return the uncompressed data
|
||||||
|
*/
|
||||||
|
DataBuffer Decompress(DataBuffer& buffer, std::uint64_t packetLength);
|
||||||
|
|
||||||
|
} // namespace zlib
|
||||||
|
|
||||||
|
namespace io {
|
||||||
|
|
||||||
|
template <>
|
||||||
|
class MessageEncapsulator<option::ZlibCompress> {
|
||||||
|
public:
|
||||||
|
static DataBuffer Encapsulate(const DataBuffer& a_Data, const option::ZlibCompress& a_Option);
|
||||||
|
static DataBuffer Decapsulate(DataBuffer& a_Data, const option::ZlibCompress& a_Option);
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace io
|
||||||
|
} // namespace sp
|
||||||
9
include/sp/extensions/Extensions.h
Normal file
9
include/sp/extensions/Extensions.h
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
#if __has_include(<sp/extensions/Compress.h>)
|
||||||
|
#include <sp/extensions/Compress.h>
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#if __has_include(<sp/extensions/Tcp.h>)
|
||||||
|
#include <sp/extensions/Tcp.h>
|
||||||
|
#endif
|
||||||
4
include/sp/extensions/Tcp.h
Normal file
4
include/sp/extensions/Tcp.h
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include <sp/extensions/tcp/TcpListener.h>
|
||||||
|
#include <sp/extensions/tcp/TcpSocket.h>
|
||||||
65
include/sp/extensions/tcp/TcpListener.h
Normal file
65
include/sp/extensions/tcp/TcpListener.h
Normal file
@@ -0,0 +1,65 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include <sp/extensions/tcp/TcpSocket.h>
|
||||||
|
|
||||||
|
namespace sp {
|
||||||
|
namespace io {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \class TcpListener
|
||||||
|
*/
|
||||||
|
class TcpListener : private NonCopyable {
|
||||||
|
public:
|
||||||
|
/**
|
||||||
|
* \brief Starts listening for guests to connect
|
||||||
|
* \param port The port to listen to
|
||||||
|
* \param maxConnexions The maximum amount of connexion that can happen at the same time. \n
|
||||||
|
* Every other guests will be kicked if this amount is reached.
|
||||||
|
* \return Whether this action was succesfull
|
||||||
|
*/
|
||||||
|
TcpListener(std::uint16_t a_Port, int a_MaxConnexions);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief Default destructor
|
||||||
|
*/
|
||||||
|
~TcpListener();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief Tries to accept an incoming request to connect
|
||||||
|
* \return the new socket if a new connexion was accepted or nullptr
|
||||||
|
*/
|
||||||
|
std::unique_ptr<TcpSocket> Accept();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief Closes the socket
|
||||||
|
*/
|
||||||
|
void Close();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief Allows to set the socket in non blocking/blocking mode
|
||||||
|
* \param a_Blocking If set to true, every call to Read will wait until the socket receives something
|
||||||
|
* \return true if the operation was successful
|
||||||
|
*/
|
||||||
|
bool SetBlocking(bool a_Blocking);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief Getter of the m_Port member
|
||||||
|
* \return The port which the socket listen to
|
||||||
|
*/
|
||||||
|
std::uint16_t GetListeningPort() const;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief Getter of the m_MaxConnections member
|
||||||
|
* \return The maximum amount of connexions that can happen at the same time.
|
||||||
|
*/
|
||||||
|
int GetMaximumConnections() const;
|
||||||
|
|
||||||
|
private:
|
||||||
|
SocketHandle m_Handle;
|
||||||
|
std::uint16_t m_Port;
|
||||||
|
int m_MaxConnections;
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
} // namespace io
|
||||||
|
} // namespace sp
|
||||||
86
include/sp/extensions/tcp/TcpSocket.h
Normal file
86
include/sp/extensions/tcp/TcpSocket.h
Normal file
@@ -0,0 +1,86 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include <sp/common/NonCopyable.h>
|
||||||
|
#include <sp/io/IOInterface.h>
|
||||||
|
|
||||||
|
namespace sp {
|
||||||
|
namespace io {
|
||||||
|
|
||||||
|
using SocketHandle = int;
|
||||||
|
|
||||||
|
struct TcpTag {};
|
||||||
|
|
||||||
|
class SocketError : public std::exception {
|
||||||
|
private:
|
||||||
|
std::string m_Error;
|
||||||
|
|
||||||
|
public:
|
||||||
|
SocketError(std::string&& a_Msg) : m_Error(std::move(a_Msg)) {}
|
||||||
|
|
||||||
|
virtual const char* what() const noexcept override {
|
||||||
|
return m_Error.c_str();
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
template <>
|
||||||
|
class IOInterface<TcpTag> : private NonCopyable {
|
||||||
|
public:
|
||||||
|
/**
|
||||||
|
* \enum Status
|
||||||
|
* \brief Describes the state of a socket
|
||||||
|
*/
|
||||||
|
enum class Status {
|
||||||
|
/** The socket is connected */
|
||||||
|
Connected,
|
||||||
|
/** The socket is not connected */
|
||||||
|
Disconnected,
|
||||||
|
/** Something bad happened */
|
||||||
|
Error,
|
||||||
|
};
|
||||||
|
|
||||||
|
IOInterface();
|
||||||
|
IOInterface(const std::string& a_Host, std::uint16_t a_Port);
|
||||||
|
IOInterface(IOInterface&& a_Other);
|
||||||
|
IOInterface& operator=(IOInterface&& a_Other);
|
||||||
|
virtual ~IOInterface();
|
||||||
|
|
||||||
|
DataBuffer Read(std::size_t a_Amount);
|
||||||
|
void Write(const sp::DataBuffer& a_Data);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief Allows to set the socket in non blocking/blocking mode
|
||||||
|
* \param a_Block If set to true, every call to Read will wait until the socket receives something
|
||||||
|
* \return true if the operation was successful
|
||||||
|
*/
|
||||||
|
bool SetBlocking(bool a_Block);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief Getter of the m_Status member
|
||||||
|
* \return The TcpSocket::Status of this socket
|
||||||
|
*/
|
||||||
|
Status GetStatus() const;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief Disconnects the socket from the remote
|
||||||
|
* \note Does nothing if the socket is not connected. \n
|
||||||
|
* This function is also called by the destructor.
|
||||||
|
*/
|
||||||
|
void Disconnect();
|
||||||
|
|
||||||
|
|
||||||
|
private:
|
||||||
|
SocketHandle m_Handle;
|
||||||
|
Status m_Status;
|
||||||
|
|
||||||
|
void Connect(const std::string& a_Host, std::uint16_t a_Port);
|
||||||
|
|
||||||
|
friend class TcpListener;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \typedef TcpSocket
|
||||||
|
*/
|
||||||
|
using TcpSocket = IOInterface<TcpTag>;
|
||||||
|
|
||||||
|
} // namespace io
|
||||||
|
} // namespace sp
|
||||||
33
include/sp/io/File.h
Normal file
33
include/sp/io/File.h
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include <fstream>
|
||||||
|
#include <sp/io/IOInterface.h>
|
||||||
|
|
||||||
|
namespace sp {
|
||||||
|
namespace io {
|
||||||
|
|
||||||
|
struct FileTag {
|
||||||
|
enum OpenMode {
|
||||||
|
In = 1,
|
||||||
|
Out = 1 << 1,
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
template <>
|
||||||
|
class IOInterface<FileTag> {
|
||||||
|
private:
|
||||||
|
std::unique_ptr<std::ifstream> m_FileInput;
|
||||||
|
std::unique_ptr<std::ofstream> m_FileOutput;
|
||||||
|
|
||||||
|
public:
|
||||||
|
IOInterface(const std::string& a_FilePath, unsigned int a_OpenMode);
|
||||||
|
IOInterface(IOInterface&& other);
|
||||||
|
|
||||||
|
DataBuffer Read(std::size_t a_Amount);
|
||||||
|
void Write(const sp::DataBuffer& a_Data);
|
||||||
|
};
|
||||||
|
|
||||||
|
using File = IOInterface<FileTag>;
|
||||||
|
|
||||||
|
} // namespace io
|
||||||
|
} // namespace sp
|
||||||
58
include/sp/io/IOInterface.h
Normal file
58
include/sp/io/IOInterface.h
Normal file
@@ -0,0 +1,58 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include <memory>
|
||||||
|
#include <sp/common/DataBuffer.h>
|
||||||
|
|
||||||
|
namespace sp {
|
||||||
|
namespace io {
|
||||||
|
|
||||||
|
template <typename IOTag>
|
||||||
|
class IOInterface {
|
||||||
|
public:
|
||||||
|
DataBuffer Read(std::size_t a_Amount);
|
||||||
|
void Write(const DataBuffer& a_Data);
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename TOption>
|
||||||
|
class MessageEncapsulator {
|
||||||
|
public:
|
||||||
|
static DataBuffer Encapsulate(const DataBuffer& a_Data, const TOption& a_Option);
|
||||||
|
static DataBuffer Decapsulate(DataBuffer& a_Data, const TOption& a_Option);
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename IOTag, typename MessageDispatcher, typename MessageFactory, typename... TOptions>
|
||||||
|
class Stream {
|
||||||
|
protected:
|
||||||
|
MessageDispatcher m_Dispatcher;
|
||||||
|
IOInterface<IOTag> m_Interface;
|
||||||
|
std::tuple<TOptions...> m_Options;
|
||||||
|
|
||||||
|
using MessageBase = typename MessageDispatcher::MessageBaseType;
|
||||||
|
|
||||||
|
public:
|
||||||
|
Stream() {}
|
||||||
|
Stream(IOInterface<IOTag>&& a_Interface, TOptions&&... a_Options);
|
||||||
|
Stream(Stream&& a_Stream);
|
||||||
|
|
||||||
|
void RecieveMessages();
|
||||||
|
void SendMessage(const MessageBase& a_Message);
|
||||||
|
|
||||||
|
|
||||||
|
template <typename TOption>
|
||||||
|
TOption& GetOption() {
|
||||||
|
return std::get<TOption>(m_Options);
|
||||||
|
}
|
||||||
|
|
||||||
|
MessageDispatcher& GetDispatcher() {
|
||||||
|
return m_Dispatcher;
|
||||||
|
}
|
||||||
|
|
||||||
|
private:
|
||||||
|
static DataBuffer Encapsulate(const DataBuffer& a_Data, const TOptions&... a_Options);
|
||||||
|
static DataBuffer Decapsulate(DataBuffer& a_Data, const TOptions&... a_Options);
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace io
|
||||||
|
} // namespace sp
|
||||||
|
|
||||||
|
#include <sp/io/IOInterfaceImpl.inl>
|
||||||
128
include/sp/io/IOInterfaceImpl.inl
Normal file
128
include/sp/io/IOInterfaceImpl.inl
Normal file
@@ -0,0 +1,128 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include <sp/extensions/Compress.h>
|
||||||
|
#include <stdexcept>
|
||||||
|
|
||||||
|
namespace sp {
|
||||||
|
|
||||||
|
namespace details {
|
||||||
|
|
||||||
|
template <typename... TOptions>
|
||||||
|
struct MessageEncapsulatorPack {};
|
||||||
|
|
||||||
|
template <>
|
||||||
|
struct MessageEncapsulatorPack<> {
|
||||||
|
static DataBuffer Encapsulate(const DataBuffer& a_Data) {
|
||||||
|
return a_Data;
|
||||||
|
}
|
||||||
|
static DataBuffer Decapsulate(DataBuffer& a_Data) {
|
||||||
|
return a_Data;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename TOption, typename... TOptions>
|
||||||
|
struct MessageEncapsulatorPack<TOption, TOptions...> {
|
||||||
|
static DataBuffer Encapsulate(const DataBuffer& a_Data, const TOption& a_Option, const TOptions&... a_Options) {
|
||||||
|
DataBuffer data = io::MessageEncapsulator<TOption>::Encapsulate(a_Data, a_Option);
|
||||||
|
return MessageEncapsulatorPack<TOptions...>::Encapsulate(data, a_Options...);
|
||||||
|
}
|
||||||
|
static DataBuffer Decapsulate(DataBuffer& a_Data, const TOption& a_Option, const TOptions&... a_Options) {
|
||||||
|
DataBuffer data = io::MessageEncapsulator<TOption>::Decapsulate(a_Data, a_Option);
|
||||||
|
return MessageEncapsulatorPack<TOptions...>::Decapsulate(data, a_Options...);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace details
|
||||||
|
|
||||||
|
namespace io {
|
||||||
|
|
||||||
|
template <typename IOTag, typename MessageDispatcher, typename MessageFactory, typename... TOptions>
|
||||||
|
Stream<IOTag, MessageDispatcher, MessageFactory, TOptions...>::Stream(IOInterface<IOTag>&& a_Interface, TOptions&&... a_Options) :
|
||||||
|
m_Interface(std::move(a_Interface)), m_Options(std::make_tuple<TOptions...>(std::move(a_Options)...)) {}
|
||||||
|
|
||||||
|
template <typename IOTag, typename MessageDispatcher, typename MessageFactory, typename... TOptions>
|
||||||
|
Stream<IOTag, MessageDispatcher, MessageFactory, TOptions...>::Stream(
|
||||||
|
Stream<IOTag, MessageDispatcher, MessageFactory, TOptions...>&& a_Stream) :
|
||||||
|
m_Dispatcher(std::move(a_Stream.m_Dispatcher)), m_Interface(std::move(a_Stream.m_Interface)) {}
|
||||||
|
|
||||||
|
template <typename IOTag, typename MessageDispatcher, typename MessageFactory, typename... TOptions>
|
||||||
|
void Stream<IOTag, MessageDispatcher, MessageFactory, TOptions...>::SendMessage(const MessageBase& a_Message) {
|
||||||
|
DataBuffer data = a_Message.Write();
|
||||||
|
DataBuffer encapsulated = std::apply([&data](const auto&... a_Options) {
|
||||||
|
return Encapsulate(data, a_Options...);
|
||||||
|
}, m_Options);
|
||||||
|
DataBuffer finalData;
|
||||||
|
finalData << VarInt{encapsulated.GetSize()} << encapsulated;
|
||||||
|
m_Interface.Write(finalData);
|
||||||
|
}
|
||||||
|
|
||||||
|
template <typename IOTag, typename MessageDispatcher, typename MessageFactory, typename... TOptions>
|
||||||
|
void Stream<IOTag, MessageDispatcher, MessageFactory, TOptions...>::RecieveMessages() {
|
||||||
|
while (true) {
|
||||||
|
// reading the first VarInt part byte by byte
|
||||||
|
std::uint64_t lenghtValue = 0;
|
||||||
|
unsigned int readPos = 0;
|
||||||
|
|
||||||
|
while (true) {
|
||||||
|
static constexpr int SEGMENT_BITS = (1 << 7) - 1;
|
||||||
|
static constexpr int CONTINUE_BIT = 1 << 7;
|
||||||
|
|
||||||
|
DataBuffer buffer = m_Interface.Read(sizeof(std::uint8_t));
|
||||||
|
|
||||||
|
// eof
|
||||||
|
if (buffer.GetSize() == 0)
|
||||||
|
return;
|
||||||
|
|
||||||
|
std::uint8_t part;
|
||||||
|
buffer >> part;
|
||||||
|
lenghtValue |= static_cast<std::uint64_t>(part & SEGMENT_BITS) << readPos;
|
||||||
|
|
||||||
|
if ((part & CONTINUE_BIT) == 0)
|
||||||
|
break;
|
||||||
|
|
||||||
|
readPos += 7;
|
||||||
|
|
||||||
|
if (readPos >= 8 * sizeof(lenghtValue))
|
||||||
|
throw std::runtime_error("VarInt is too big");
|
||||||
|
}
|
||||||
|
|
||||||
|
// nothing to read
|
||||||
|
if (lenghtValue == 0)
|
||||||
|
return;
|
||||||
|
|
||||||
|
DataBuffer buffer;
|
||||||
|
buffer = m_Interface.Read(lenghtValue);
|
||||||
|
|
||||||
|
buffer = std::apply([&buffer, lenghtValue](const auto&... a_Options) {
|
||||||
|
return Decapsulate(buffer, a_Options...);
|
||||||
|
}, m_Options);
|
||||||
|
|
||||||
|
VarInt packetType;
|
||||||
|
buffer >> packetType;
|
||||||
|
|
||||||
|
static const MessageFactory messageFactory;
|
||||||
|
|
||||||
|
std::unique_ptr<MessageBase> message = messageFactory.CreateMessage(packetType.GetValue());
|
||||||
|
|
||||||
|
assert(message != nullptr);
|
||||||
|
|
||||||
|
message->Read(buffer);
|
||||||
|
|
||||||
|
GetDispatcher().Dispatch(*message);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
template <typename IOTag, typename MessageDispatcher, typename MessageFactory, typename... TOptions>
|
||||||
|
DataBuffer Stream<IOTag, MessageDispatcher, MessageFactory, TOptions...>::Encapsulate(
|
||||||
|
const DataBuffer& a_Data, const TOptions&... a_Options) {
|
||||||
|
return details::MessageEncapsulatorPack<TOptions...>::Encapsulate(a_Data, a_Options...);
|
||||||
|
}
|
||||||
|
|
||||||
|
template <typename IOTag, typename MessageDispatcher, typename MessageFactory, typename... TOptions>
|
||||||
|
DataBuffer Stream<IOTag, MessageDispatcher, MessageFactory, TOptions...>::Decapsulate(
|
||||||
|
DataBuffer& a_Data, const TOptions&... a_Options) {
|
||||||
|
return details::MessageEncapsulatorPack<TOptions...>::Decapsulate(a_Data, a_Options...);
|
||||||
|
}
|
||||||
|
|
||||||
|
} // namespace io
|
||||||
|
} // namespace sp
|
||||||
23
include/sp/io/Memory.h
Normal file
23
include/sp/io/Memory.h
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include <sp/io/IOInterface.h>
|
||||||
|
|
||||||
|
namespace sp {
|
||||||
|
namespace io {
|
||||||
|
|
||||||
|
struct MemoryTag {};
|
||||||
|
|
||||||
|
template <>
|
||||||
|
class IOInterface<MemoryTag> {
|
||||||
|
private:
|
||||||
|
sp::DataBuffer m_VirtualIO;
|
||||||
|
|
||||||
|
public:
|
||||||
|
sp::DataBuffer Read(std::size_t a_Amount);
|
||||||
|
void Write(const sp::DataBuffer& a_Data);
|
||||||
|
};
|
||||||
|
|
||||||
|
using Memory = IOInterface<MemoryTag>;
|
||||||
|
|
||||||
|
} // namespace io
|
||||||
|
} // namespace sp
|
||||||
@@ -1,38 +0,0 @@
|
|||||||
#pragma once
|
|
||||||
|
|
||||||
/**
|
|
||||||
* \file Format.h
|
|
||||||
* \brief This file contains the definition of the `Format` function.
|
|
||||||
*/
|
|
||||||
|
|
||||||
#include <memory>
|
|
||||||
#include <stdexcept>
|
|
||||||
#include <string>
|
|
||||||
|
|
||||||
namespace sp {
|
|
||||||
namespace utils {
|
|
||||||
|
|
||||||
/**
|
|
||||||
* \brief Formats a string using a format string and variadic arguments.
|
|
||||||
*
|
|
||||||
* This function takes a format string and a variable number of arguments and returns a formatted string.
|
|
||||||
* The format string can contain placeholders that will be replaced by the corresponding arguments.
|
|
||||||
*
|
|
||||||
* \param format The format string.
|
|
||||||
* \param args The variadic arguments to be formatted.
|
|
||||||
* \return The formatted string.
|
|
||||||
* \throws std::runtime_error if an error occurs during formatting.
|
|
||||||
*/
|
|
||||||
template <typename... Args>
|
|
||||||
std::string Format(const std::string& format, Args... args) {
|
|
||||||
int size = snprintf(nullptr, 0, format.c_str(), args...) + 1; // Extra space for '\0'
|
|
||||||
if (size <= 0) {
|
|
||||||
throw std::runtime_error("Error during formatting.");
|
|
||||||
}
|
|
||||||
std::unique_ptr<char[]> buf(new char[size]);
|
|
||||||
snprintf(buf.get(), static_cast<std::size_t>(size), format.c_str(), args...);
|
|
||||||
return std::string(buf.get(), buf.get() + size - 1); // We don't want the '\0' inside
|
|
||||||
}
|
|
||||||
|
|
||||||
} // namespace utils
|
|
||||||
} // namespace sp
|
|
||||||
@@ -1,32 +0,0 @@
|
|||||||
#pragma once
|
|
||||||
|
|
||||||
/**
|
|
||||||
* \file Log.h
|
|
||||||
* \brief File defining log functions
|
|
||||||
*/
|
|
||||||
|
|
||||||
#include <string>
|
|
||||||
|
|
||||||
namespace sp {
|
|
||||||
namespace utils {
|
|
||||||
|
|
||||||
/**
|
|
||||||
* \brief Logs a normal message.
|
|
||||||
* \param msg The message to be logged.
|
|
||||||
*/
|
|
||||||
void LOG(const std::string& msg);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* \brief Logs a normal message in debug mode.
|
|
||||||
* \param msg The message to be logged.
|
|
||||||
*/
|
|
||||||
void LOGD(const std::string& msg);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* \brief Logs an error message.
|
|
||||||
* \param err The error message to be logged.
|
|
||||||
*/
|
|
||||||
void LOGE(const std::string& err);
|
|
||||||
|
|
||||||
} // namespace utils
|
|
||||||
} // namespace sp
|
|
||||||
@@ -1,70 +0,0 @@
|
|||||||
#pragma once
|
|
||||||
|
|
||||||
/**
|
|
||||||
* \file Test.h
|
|
||||||
* \brief File containing unit testing utilities
|
|
||||||
*/
|
|
||||||
|
|
||||||
#include <cstdlib>
|
|
||||||
#include <sp/misc/Log.h>
|
|
||||||
|
|
||||||
namespace sp {
|
|
||||||
namespace test {
|
|
||||||
|
|
||||||
/**
|
|
||||||
* \def SP_TEST_SUCCESSFUL
|
|
||||||
* \brief Used in tests to indicate that a test was successful
|
|
||||||
*/
|
|
||||||
#define SP_TEST_SUCCESSFUL 0
|
|
||||||
|
|
||||||
/**
|
|
||||||
* \def SP_TEST_FAILED
|
|
||||||
* \brief Used in tests to indicate that a test failed
|
|
||||||
*/
|
|
||||||
#define SP_TEST_FAILED 1
|
|
||||||
|
|
||||||
#ifndef __FUNCTION_NAME__
|
|
||||||
#ifdef _WIN32
|
|
||||||
#define __FUNCTION_NAME__ __FUNCTION__
|
|
||||||
#else
|
|
||||||
#define __FUNCTION_NAME__ __PRETTY_FUNCTION__
|
|
||||||
#endif
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/**
|
|
||||||
* \def blitz_test_assert
|
|
||||||
* \param ... The expression to evaluate
|
|
||||||
* \brief Evaluates the expression and exits the program if not valid.
|
|
||||||
* \note It works like a basic assert() but also in release mode
|
|
||||||
*/
|
|
||||||
#define sp_test_assert(...) \
|
|
||||||
if (!static_cast<bool>(__VA_ARGS__)) { \
|
|
||||||
td::test::LogAssert(#__VA_ARGS__, __FILE__, __LINE__, __FUNCTION_NAME__); \
|
|
||||||
std::exit(SP_TEST_FAILED); \
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* \def blitz_debug_assert
|
|
||||||
* \param ... The expression to execute
|
|
||||||
* \brief Assertion without checks in release mode
|
|
||||||
* \note The expression is always executed. However, in release, no checks are made !
|
|
||||||
*/
|
|
||||||
#ifdef NDEBUG
|
|
||||||
#define sp_debug_assert(...) __VA_ARGS__
|
|
||||||
#else
|
|
||||||
#define sp_debug_assert sp_test_assert
|
|
||||||
#endif
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* \brief Prints an error message associated with a failed assertion
|
|
||||||
* \param expression The expression that was tested
|
|
||||||
* \param file The file in which the assertion failed
|
|
||||||
* \param line The line in the file in which the assertion failed
|
|
||||||
* \param function The function in which the assertion failed
|
|
||||||
*/
|
|
||||||
void LogAssert(const char* expression, const char* file, int line, const char* function);
|
|
||||||
|
|
||||||
} // namespace test
|
|
||||||
} // namespace sp
|
|
||||||
@@ -40,6 +40,17 @@ class BitField {
|
|||||||
return std::get<FIndex>(this->GetFields()).GetValue();
|
return std::get<FIndex>(this->GetFields()).GetValue();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
template <std::size_t FIndex>
|
||||||
|
const auto& GetField() const {
|
||||||
|
return std::get<FIndex>(this->GetFields()).GetValue();
|
||||||
|
}
|
||||||
|
|
||||||
|
// allow use of enums
|
||||||
|
template <typename E, E FIndex>
|
||||||
|
const auto& GetField() const {
|
||||||
|
return std::get<static_cast<std::size_t>(FIndex)>(this->GetFields()).GetValue();
|
||||||
|
}
|
||||||
|
|
||||||
private:
|
private:
|
||||||
template <int IOffset, typename... T, std::enable_if_t<IOffset >= sizeof...(T), bool> = true>
|
template <int IOffset, typename... T, std::enable_if_t<IOffset >= sizeof...(T), bool> = true>
|
||||||
void Apply(const std::tuple<T...>& args) {}
|
void Apply(const std::tuple<T...>& args) {}
|
||||||
@@ -103,6 +114,6 @@ template <typename TField, typename... TFields>
|
|||||||
struct FieldsBuilder<TField, TFields...> {
|
struct FieldsBuilder<TField, TFields...> {
|
||||||
using Type = sp::tuple_cat_t<std::tuple<Field<TField, 0>>, typename FieldsBuilder<TFields...>::Type>;
|
using Type = sp::tuple_cat_t<std::tuple<Field<TField, 0>>, typename FieldsBuilder<TFields...>::Type>;
|
||||||
};
|
};
|
||||||
} // namespace details
|
|
||||||
|
|
||||||
|
} // namespace details
|
||||||
} // namespace sp
|
} // namespace sp
|
||||||
|
|||||||
@@ -23,26 +23,26 @@ namespace sp
|
|||||||
using Base = GenericHandler<TCommon, std::tuple<TRest...> >;
|
using Base = GenericHandler<TCommon, std::tuple<TRest...> >;
|
||||||
public:
|
public:
|
||||||
using Base::Handle; // Don't hide all Handle() functions from base classes
|
using Base::Handle; // Don't hide all Handle() functions from base classes
|
||||||
virtual void Handle(T1& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T1& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T2& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T2& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T3& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T3& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T4& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T4& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T5& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T5& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T6& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T6& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T7& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T7& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T8& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T8& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T9& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T9& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T10& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T10& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T11& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T11& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T12& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T12& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T13& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T13& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T14& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T14& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T15& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T15& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T16& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T16& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T17& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T17& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T18& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T18& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T19& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T19& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T20& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T20& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
};
|
};
|
||||||
|
|
||||||
// 10 by 10
|
// 10 by 10
|
||||||
@@ -55,16 +55,16 @@ namespace sp
|
|||||||
using Base = GenericHandler<TCommon, std::tuple<TRest...> >;
|
using Base = GenericHandler<TCommon, std::tuple<TRest...> >;
|
||||||
public:
|
public:
|
||||||
using Base::Handle; // Don't hide all Handle() functions from base classes
|
using Base::Handle; // Don't hide all Handle() functions from base classes
|
||||||
virtual void Handle(T1& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T1& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T2& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T2& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T3& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T3& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T4& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T4& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T5& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T5& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T6& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T6& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T7& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T7& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T8& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T8& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T9& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T9& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T10& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T10& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
};
|
};
|
||||||
|
|
||||||
// 5 by 5
|
// 5 by 5
|
||||||
@@ -76,11 +76,11 @@ namespace sp
|
|||||||
using Base = GenericHandler<TCommon, std::tuple<TRest...> >;
|
using Base = GenericHandler<TCommon, std::tuple<TRest...> >;
|
||||||
public:
|
public:
|
||||||
using Base::Handle; // Don't hide all Handle() functions from base classes
|
using Base::Handle; // Don't hide all Handle() functions from base classes
|
||||||
virtual void Handle(T1& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T1& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T2& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T2& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T3& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T3& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T4& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T4& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T5& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T5& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
};
|
};
|
||||||
|
|
||||||
// Deal with rest with 4 types
|
// Deal with rest with 4 types
|
||||||
@@ -89,11 +89,11 @@ namespace sp
|
|||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
virtual ~GenericHandler() {}
|
virtual ~GenericHandler() {}
|
||||||
virtual void Handle(T1& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T1& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T2& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T2& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T3& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T3& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T4& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T4& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(TCommon&) { } //Nothing to do
|
virtual void Handle(const TCommon&) { } //Nothing to do
|
||||||
};
|
};
|
||||||
|
|
||||||
// Deal with rest with 3 types
|
// Deal with rest with 3 types
|
||||||
@@ -102,10 +102,10 @@ namespace sp
|
|||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
virtual ~GenericHandler() {}
|
virtual ~GenericHandler() {}
|
||||||
virtual void Handle(T1& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T1& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T2& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T2& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T3& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T3& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(TCommon&) { } //Nothing to do
|
virtual void Handle(const TCommon&) { } //Nothing to do
|
||||||
};
|
};
|
||||||
|
|
||||||
// Deal with rest with 2 types
|
// Deal with rest with 2 types
|
||||||
@@ -114,9 +114,9 @@ namespace sp
|
|||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
virtual ~GenericHandler() {}
|
virtual ~GenericHandler() {}
|
||||||
virtual void Handle(T1& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T1& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(T2& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T2& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(TCommon&) { } //Nothing to do
|
virtual void Handle(const TCommon&) { } //Nothing to do
|
||||||
};
|
};
|
||||||
|
|
||||||
// Deal with rest with 1 type
|
// Deal with rest with 1 type
|
||||||
@@ -125,8 +125,8 @@ namespace sp
|
|||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
virtual ~GenericHandler() {}
|
virtual ~GenericHandler() {}
|
||||||
virtual void Handle(T1& msg) { this->Handle(static_cast<TCommon&>(msg)); }
|
virtual void Handle(const T1& msg) { this->Handle(static_cast<const TCommon&>(msg)); }
|
||||||
virtual void Handle(TCommon&) { } //Nothing to do
|
virtual void Handle(const TCommon&) { } //Nothing to do
|
||||||
};
|
};
|
||||||
|
|
||||||
// Deal with rest with 0 type
|
// Deal with rest with 0 type
|
||||||
@@ -135,7 +135,7 @@ namespace sp
|
|||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
virtual ~GenericHandler() {}
|
virtual ~GenericHandler() {}
|
||||||
virtual void Handle(TCommon&) { } //Nothing to do
|
virtual void Handle(const TCommon&) { } //Nothing to do
|
||||||
};
|
};
|
||||||
|
|
||||||
} // sp
|
} // sp
|
||||||
@@ -3,7 +3,7 @@
|
|||||||
// Inspired by
|
// Inspired by
|
||||||
// https://alex-robenko.gitbook.io/comms-protocols-cpp
|
// https://alex-robenko.gitbook.io/comms-protocols-cpp
|
||||||
|
|
||||||
#include <sp/protocol/MessageInterfaceBuilder.h>
|
#include <sp/protocol/message/MessageInterfaceBuilder.h>
|
||||||
|
|
||||||
namespace sp {
|
namespace sp {
|
||||||
|
|
||||||
|
|||||||
@@ -2,339 +2,15 @@
|
|||||||
|
|
||||||
#include <sp/protocol/Message.h>
|
#include <sp/protocol/Message.h>
|
||||||
|
|
||||||
|
#include <sp/protocol/message/MessageImplOptions.h>
|
||||||
|
|
||||||
|
#include <sp/protocol/message/MessagesImpl.h>
|
||||||
|
#include <sp/protocol/message/MessageImplProcess.h>
|
||||||
|
#include <sp/protocol/message/MessageImplBuilder.h>
|
||||||
|
|
||||||
namespace sp {
|
namespace sp {
|
||||||
namespace option {
|
|
||||||
|
|
||||||
// Provide static numeric ID, to facilitate implementation of GetIdImpl()
|
|
||||||
template <std::intmax_t TId>
|
|
||||||
struct StaticNumIdImpl {};
|
|
||||||
|
|
||||||
// Facilitate implementation of DispatchImpl()
|
|
||||||
template <typename TActual>
|
|
||||||
struct DispatchImpl {};
|
|
||||||
|
|
||||||
// Provide fields of the message, facilitate implementation of
|
|
||||||
// ReadImpl(), WriteImpl(), ValidImpl(), etc...
|
|
||||||
template <typename TFields>
|
|
||||||
struct FieldsImpl {};
|
|
||||||
|
|
||||||
} // namespace option
|
|
||||||
|
|
||||||
|
|
||||||
namespace details {
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
template <typename... TOptions>
|
|
||||||
class MessageImplParsedOptions;
|
|
||||||
|
|
||||||
template <>
|
|
||||||
struct MessageImplParsedOptions<> {
|
|
||||||
static const bool HasStaticNumIdImpl = false;
|
|
||||||
static const bool HasDispatchImpl = false;
|
|
||||||
static const bool HasFieldsImpl = false;
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
template <std::intmax_t TId, typename... TOptions>
|
|
||||||
struct MessageImplParsedOptions<option::StaticNumIdImpl<TId>, TOptions...> : public MessageImplParsedOptions<TOptions...> {
|
|
||||||
static const bool HasStaticNumIdImpl = true;
|
|
||||||
static const std::intmax_t MsgId = TId;
|
|
||||||
};
|
|
||||||
|
|
||||||
template <typename TActual, typename... TOptions>
|
|
||||||
struct MessageImplParsedOptions<option::DispatchImpl<TActual>, TOptions...> : public MessageImplParsedOptions<TOptions...> {
|
|
||||||
static const bool HasDispatchImpl = true;
|
|
||||||
using ActualMessage = TActual;
|
|
||||||
};
|
|
||||||
|
|
||||||
template <typename TFields, typename... TOptions>
|
|
||||||
struct MessageImplParsedOptions<option::FieldsImpl<TFields>, TOptions...> : public MessageImplParsedOptions<TOptions...> {
|
|
||||||
static const bool HasFieldsImpl = true;
|
|
||||||
using Fields = TFields;
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
// ID information chunk
|
|
||||||
template <typename TBase, std::intmax_t TId>
|
|
||||||
class MessageImplStaticNumIdBase : public TBase {
|
|
||||||
public:
|
|
||||||
// Reuse the message ID type defined in the interface
|
|
||||||
using MsgIdType = typename TBase::MsgIdType;
|
|
||||||
|
|
||||||
protected:
|
|
||||||
virtual MsgIdType GetIdImpl() const override {
|
|
||||||
return static_cast<MsgIdType>(TId);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
// Dispatch implementation chunk
|
|
||||||
template <typename TBase, typename TActual>
|
|
||||||
class MessageImplDispatchBase : public TBase {
|
|
||||||
public:
|
|
||||||
// Reuse the Handler type defined in the interface class
|
|
||||||
using Handler = typename TBase::HandlerType;
|
|
||||||
|
|
||||||
protected:
|
|
||||||
virtual void DispatchImpl(Handler& handler) override {
|
|
||||||
handler.Handle(static_cast<TActual&>(*this));
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
template <typename TBase, typename TFields>
|
|
||||||
class MessageImplFieldsBase : public TBase {
|
|
||||||
public:
|
|
||||||
using AllFields = typename details::FieldsBuilder<TFields>::Type;
|
|
||||||
|
|
||||||
template <typename... Args>
|
|
||||||
void Construct(Args... args) {
|
|
||||||
m_Fields = std::make_tuple(args...);
|
|
||||||
}
|
|
||||||
|
|
||||||
AllFields& GetFields() {
|
|
||||||
return m_Fields;
|
|
||||||
}
|
|
||||||
|
|
||||||
const AllFields& GetFields() const {
|
|
||||||
return m_Fields;
|
|
||||||
}
|
|
||||||
|
|
||||||
template <std::size_t FIndex>
|
|
||||||
auto& GetField() {
|
|
||||||
return std::get<FIndex>(GetFields()).GetValue();
|
|
||||||
}
|
|
||||||
|
|
||||||
private:
|
|
||||||
AllFields m_Fields;
|
|
||||||
};
|
|
||||||
|
|
||||||
template <typename TBase>
|
|
||||||
class MessageImplFieldsReadBase : public TBase {
|
|
||||||
private:
|
|
||||||
// normal reading
|
|
||||||
template <typename TField>
|
|
||||||
void ReadField(Field<TField, 0>& field, DataBuffer& buffer) {
|
|
||||||
this->ReadData(field.GetValue(), buffer);
|
|
||||||
}
|
|
||||||
|
|
||||||
// reading field in bitfield
|
|
||||||
template <typename TFieldType, typename TField, int IAlignment>
|
|
||||||
void ReadField(Field<TField, IAlignment>& field, TFieldType data, std::size_t offset) {
|
|
||||||
static constexpr std::size_t TotalBitCount = sizeof(TFieldType) * 8;
|
|
||||||
// we suppose that the first element is at the highest bits
|
|
||||||
field.GetValue() = (data >> TotalBitCount - IAlignment - offset) & ((1 << IAlignment) - 1);
|
|
||||||
}
|
|
||||||
|
|
||||||
// reading bitfield
|
|
||||||
template <typename TContainer, typename TFirst, typename... TFields>
|
|
||||||
void ReadField(Field<BitField<TContainer, TFirst, TFields...>, 0>& field, DataBuffer& buffer) {
|
|
||||||
TContainer data;
|
|
||||||
this->ReadData(data, buffer);
|
|
||||||
std::size_t offset = 0;
|
|
||||||
TupleForEach(
|
|
||||||
[data, this, &offset](auto& field) {
|
|
||||||
this->ReadField(field, data, offset);
|
|
||||||
offset += field.GetAlignment();
|
|
||||||
},
|
|
||||||
field.GetValue().GetFields());
|
|
||||||
}
|
|
||||||
|
|
||||||
void ReadImpl(DataBuffer& buffer) override {
|
|
||||||
auto& allFields = this->GetFields();
|
|
||||||
TupleForEach([&buffer, this](auto& field) { this->ReadField(field, buffer); }, allFields);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
template <typename TBase>
|
|
||||||
class MessageImplFieldsWriteBase : public TBase {
|
|
||||||
private:
|
|
||||||
// normal writing
|
|
||||||
template <typename TField>
|
|
||||||
void WriteField(Field<TField, 0>& field, DataBuffer& buffer) {
|
|
||||||
this->WriteData(field.GetValue(), buffer);
|
|
||||||
}
|
|
||||||
|
|
||||||
// writing field in bitfield
|
|
||||||
template <typename TFieldType, typename TField, int IAlignment>
|
|
||||||
void WriteField(Field<TField, IAlignment>& field, TFieldType& data, std::size_t offset) {
|
|
||||||
static constexpr std::size_t TotalBitCount = sizeof(TFieldType) * 8;
|
|
||||||
// we suppose that the first element is at the highest bits
|
|
||||||
data |= (field.GetValue() & ((1 << IAlignment) - 1)) << TotalBitCount - IAlignment - offset;
|
|
||||||
}
|
|
||||||
|
|
||||||
// writing bitfield
|
|
||||||
template <typename TContainer, typename TFirst, typename... TFields>
|
|
||||||
void WriteField(Field<BitField<TContainer, TFirst, TFields...>, 0>& field, DataBuffer& buffer) {
|
|
||||||
TContainer data = 0;
|
|
||||||
std::size_t offset = 0;
|
|
||||||
TupleForEach(
|
|
||||||
[&data, this, &offset](auto& field) {
|
|
||||||
this->WriteField(field, data, offset);
|
|
||||||
offset += field.GetAlignment();
|
|
||||||
},
|
|
||||||
field.GetValue().GetFields());
|
|
||||||
this->WriteData(data, buffer);
|
|
||||||
}
|
|
||||||
|
|
||||||
void WriteImpl(DataBuffer& buffer) override {
|
|
||||||
auto& allFields = this->GetFields();
|
|
||||||
TupleForEach([&buffer, this](auto& field) { this->WriteField(field, buffer); }, allFields);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
template <typename TBase>
|
|
||||||
class MessageImplFieldsValidBase : public TBase {
|
|
||||||
protected:
|
|
||||||
bool ValidImpl() const override {
|
|
||||||
// Access fields via interface provided in previous chunk
|
|
||||||
// auto& allFields = TBase::GetFields();
|
|
||||||
//... // validate all the fields
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
// id impl
|
|
||||||
template <typename TBase, typename ParsedImplOptions, bool TImplement>
|
|
||||||
struct MessageImplProcessStaticNumId;
|
|
||||||
|
|
||||||
template <typename TBase, typename ParsedImplOptions>
|
|
||||||
struct MessageImplProcessStaticNumId<TBase, ParsedImplOptions, true> {
|
|
||||||
using Type = MessageImplStaticNumIdBase<TBase, ParsedImplOptions::MsgId>;
|
|
||||||
};
|
|
||||||
|
|
||||||
template <typename TBase, typename ParsedImplOptions>
|
|
||||||
struct MessageImplProcessStaticNumId<TBase, ParsedImplOptions, false> {
|
|
||||||
using Type = TBase;
|
|
||||||
};
|
|
||||||
|
|
||||||
// dispatch impl
|
|
||||||
template <typename TBase, typename ParsedImplOptions, bool TImplement>
|
|
||||||
struct MessageImplProcessDispatch;
|
|
||||||
|
|
||||||
template <typename TBase, typename ParsedImplOptions>
|
|
||||||
struct MessageImplProcessDispatch<TBase, ParsedImplOptions, true> {
|
|
||||||
using Type = MessageImplDispatchBase<TBase, typename ParsedImplOptions::ActualMessage>;
|
|
||||||
};
|
|
||||||
|
|
||||||
template <typename TBase, typename ParsedImplOptions>
|
|
||||||
struct MessageImplProcessDispatch<TBase, ParsedImplOptions, false> {
|
|
||||||
using Type = TBase;
|
|
||||||
};
|
|
||||||
|
|
||||||
// fields impl
|
|
||||||
template <typename TBase, typename ParsedImplOptions, bool TImplement>
|
|
||||||
struct MessageImplProcessFields;
|
|
||||||
|
|
||||||
template <typename TBase, typename ParsedImplOptions>
|
|
||||||
struct MessageImplProcessFields<TBase, ParsedImplOptions, true> {
|
|
||||||
using Type = MessageImplFieldsBase<TBase, typename ParsedImplOptions::Fields>;
|
|
||||||
};
|
|
||||||
|
|
||||||
template <typename TBase, typename ParsedImplOptions>
|
|
||||||
struct MessageImplProcessFields<TBase, ParsedImplOptions, false> {
|
|
||||||
using Type = TBase;
|
|
||||||
};
|
|
||||||
|
|
||||||
// read impl
|
|
||||||
template <typename TBase, bool TImplement>
|
|
||||||
struct MessageImplProcessReadFields;
|
|
||||||
|
|
||||||
template <typename TBase>
|
|
||||||
struct MessageImplProcessReadFields<TBase, true> {
|
|
||||||
using Type = MessageImplFieldsReadBase<TBase>;
|
|
||||||
};
|
|
||||||
|
|
||||||
template <typename TBase>
|
|
||||||
struct MessageImplProcessReadFields<TBase, false> {
|
|
||||||
using Type = TBase;
|
|
||||||
};
|
|
||||||
|
|
||||||
// write impl
|
|
||||||
template <typename TBase, bool TImplement>
|
|
||||||
struct MessageImplProcessWriteFields;
|
|
||||||
|
|
||||||
template <typename TBase>
|
|
||||||
struct MessageImplProcessWriteFields<TBase, true> {
|
|
||||||
using Type = MessageImplFieldsWriteBase<TBase>;
|
|
||||||
};
|
|
||||||
|
|
||||||
template <typename TBase>
|
|
||||||
struct MessageImplProcessWriteFields<TBase, false> {
|
|
||||||
using Type = TBase;
|
|
||||||
};
|
|
||||||
|
|
||||||
// valid impl
|
|
||||||
template <typename TBase, bool TImplement>
|
|
||||||
struct MessageImplProcessValidFields;
|
|
||||||
|
|
||||||
template <typename TBase>
|
|
||||||
struct MessageImplProcessValidFields<TBase, true> {
|
|
||||||
using Type = MessageImplFieldsValidBase<TBase>;
|
|
||||||
};
|
|
||||||
|
|
||||||
template <typename TBase>
|
|
||||||
struct MessageImplProcessValidFields<TBase, false> {
|
|
||||||
using Type = TBase;
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
// TBase is interface class
|
|
||||||
// TOptions... are the implementation options
|
|
||||||
template <typename TBase, typename... TOptions>
|
|
||||||
struct MessageImplBuilder {
|
|
||||||
// ParsedOptions class is supposed to be defined in comms::Message class
|
|
||||||
using InterfaceOptions = typename TBase::ParsedOptions;
|
|
||||||
|
|
||||||
// Parse implementation options
|
|
||||||
using ImplOptions = MessageImplParsedOptions<TOptions...>;
|
|
||||||
|
|
||||||
// Provide GetIdImpl() if possible
|
|
||||||
static const bool HasStaticNumIdImpl = InterfaceOptions::HasMsgIdType && ImplOptions::HasStaticNumIdImpl;
|
|
||||||
using Base1 = typename MessageImplProcessStaticNumId<TBase, ImplOptions, HasStaticNumIdImpl>::Type;
|
|
||||||
|
|
||||||
// Provide DispatchImpl() if possible
|
|
||||||
static const bool HasDispatchImpl = InterfaceOptions::HasHandler && ImplOptions::HasDispatchImpl;
|
|
||||||
using Base2 = typename MessageImplProcessDispatch<Base1, ImplOptions, HasDispatchImpl>::Type;
|
|
||||||
|
|
||||||
// Provide access to fields if possible
|
|
||||||
using Base3 = typename MessageImplProcessFields<Base2, ImplOptions, ImplOptions::HasFieldsImpl>::Type;
|
|
||||||
|
|
||||||
// Provide ReadImpl() if possible
|
|
||||||
static const bool HasReadImpl = InterfaceOptions::HasReadOperations && ImplOptions::HasFieldsImpl;
|
|
||||||
using Base4 = typename MessageImplProcessReadFields<Base3, HasReadImpl>::Type;
|
|
||||||
|
|
||||||
// Provide WriteImpl() if possible
|
|
||||||
static const bool HasWriteImpl = InterfaceOptions::HasWriteOperations && ImplOptions::HasFieldsImpl;
|
|
||||||
using Base5 = typename MessageImplProcessWriteFields<Base4, HasWriteImpl>::Type;
|
|
||||||
|
|
||||||
// Provide ValidImpl() if possible
|
|
||||||
static const bool HasValidImpl = InterfaceOptions::HasValid && ImplOptions::HasFieldsImpl;
|
|
||||||
using Base6 = typename MessageImplProcessValidFields<Base5, HasValidImpl>::Type;
|
|
||||||
|
|
||||||
// The last BaseN must be taken as final type.
|
|
||||||
using Type = Base6;
|
|
||||||
};
|
|
||||||
|
|
||||||
} // namespace details
|
|
||||||
|
|
||||||
template <typename TBase, typename... TOptions>
|
template <typename TBase, typename... TOptions>
|
||||||
class MessageBase : public details::MessageImplBuilder<TBase, TOptions...>::Type {};
|
class MessageBase : public details::MessageImplBuilder<TBase, TOptions...>::Type {};
|
||||||
|
|
||||||
|
|
||||||
} // namespace sp
|
} // namespace sp
|
||||||
59
include/sp/protocol/MessageDispatcher.h
Normal file
59
include/sp/protocol/MessageDispatcher.h
Normal file
@@ -0,0 +1,59 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \file MessageDispatcher.h
|
||||||
|
* \brief File containing the sp::MessageDispatcher class
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include <map>
|
||||||
|
#include <memory>
|
||||||
|
|
||||||
|
namespace sp {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \class MessageDispatcher
|
||||||
|
* \brief Class used to dispatch messages
|
||||||
|
*/
|
||||||
|
template <typename MessageIdType, typename MessageBase, typename MessageHandler>
|
||||||
|
class MessageDispatcher {
|
||||||
|
private:
|
||||||
|
std::map<MessageIdType, std::vector<MessageHandler*>> m_Handlers;
|
||||||
|
|
||||||
|
public:
|
||||||
|
using MessageBaseType = MessageBase;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief Constructor
|
||||||
|
*/
|
||||||
|
MessageDispatcher() {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief Dispatch a packet
|
||||||
|
* \param packet The packet to dispatch
|
||||||
|
*/
|
||||||
|
void Dispatch(const MessageBase& a_Message);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief Register a packet handler
|
||||||
|
* \param type The packet type
|
||||||
|
* \param handler The packet handler
|
||||||
|
*/
|
||||||
|
void RegisterHandler(MessageIdType a_MessageType, MessageHandler* a_Handler);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief Unregister a packet handler
|
||||||
|
* \param type The packet type
|
||||||
|
* \param handler The packet handler
|
||||||
|
*/
|
||||||
|
void UnregisterHandler(MessageIdType a_MessageType, MessageHandler* a_Handler);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* \brief Unregister a packet handler
|
||||||
|
* \param handler The packet handler
|
||||||
|
*/
|
||||||
|
void UnregisterHandler(MessageHandler* a_Handler);
|
||||||
|
};
|
||||||
|
|
||||||
|
#include <sp/protocol/message/MessageDispatcherImpl.inl>
|
||||||
|
|
||||||
|
} // namespace sp
|
||||||
@@ -5,45 +5,10 @@
|
|||||||
#include <iostream>
|
#include <iostream>
|
||||||
#include <memory>
|
#include <memory>
|
||||||
|
|
||||||
|
#include <sp/protocol/message/ArrayFillerImpl.h>
|
||||||
|
|
||||||
namespace sp {
|
namespace sp {
|
||||||
|
|
||||||
namespace details {
|
|
||||||
|
|
||||||
template <typename TBase>
|
|
||||||
using ArrayType = std::vector<std::function<std::unique_ptr<TBase>(void)>>;
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
template <typename TBase, typename... TMessages>
|
|
||||||
struct ArrayFiller {};
|
|
||||||
|
|
||||||
template <typename TBase, typename... TMessages>
|
|
||||||
struct ArrayFiller<TBase, std::tuple<TMessages...>> {
|
|
||||||
static ArrayType<TBase> ArrayCreate() {
|
|
||||||
ArrayType<TBase> array;
|
|
||||||
array.reserve(sizeof...(TMessages));
|
|
||||||
ArrayFiller<TBase, TMessages...>::ArrayAppend(array);
|
|
||||||
return array;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
template <typename TBase, typename TMessage, typename... TMessages>
|
|
||||||
struct ArrayFiller<TBase, TMessage, TMessages...> {
|
|
||||||
static void ArrayAppend(details::ArrayType<TBase>& array) {
|
|
||||||
ArrayFiller<TBase, TMessage>::ArrayAppend(array);
|
|
||||||
ArrayFiller<TBase, TMessages...>::ArrayAppend(array);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
template <typename TBase, typename TMessage>
|
|
||||||
struct ArrayFiller<TBase, TMessage> {
|
|
||||||
static void ArrayAppend(details::ArrayType<TBase>& array) {
|
|
||||||
array.push_back([]() -> std::unique_ptr<TBase> { return std::make_unique<TMessage>(); });
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
} // namespace details
|
|
||||||
|
|
||||||
template <typename TBase, typename TTMessages>
|
template <typename TBase, typename TTMessages>
|
||||||
class MessageFactory {
|
class MessageFactory {
|
||||||
public:
|
public:
|
||||||
@@ -51,7 +16,7 @@ class MessageFactory {
|
|||||||
|
|
||||||
MessageFactory() : m_Factory(details::ArrayFiller<TBase, TTMessages>::ArrayCreate()) {}
|
MessageFactory() : m_Factory(details::ArrayFiller<TBase, TTMessages>::ArrayCreate()) {}
|
||||||
|
|
||||||
std::unique_ptr<TBase> CreateMessage(IdType id) {
|
std::unique_ptr<TBase> CreateMessage(IdType id) const {
|
||||||
if (id >= m_Factory.size())
|
if (id >= m_Factory.size())
|
||||||
return nullptr;
|
return nullptr;
|
||||||
return m_Factory.at(id)();
|
return m_Factory.at(id)();
|
||||||
|
|||||||
@@ -1,278 +0,0 @@
|
|||||||
#pragma once
|
|
||||||
|
|
||||||
#include <sp/protocol/Options.h>
|
|
||||||
#include <sp/common/ByteSwapping.h>
|
|
||||||
|
|
||||||
namespace sp {
|
|
||||||
namespace details {
|
|
||||||
|
|
||||||
template <typename... TOptions>
|
|
||||||
struct MessageInterfaceParsedOptions {};
|
|
||||||
|
|
||||||
template <>
|
|
||||||
struct MessageInterfaceParsedOptions<> {
|
|
||||||
static const bool HasMsgIdType = false;
|
|
||||||
static const bool HasLittleEndian = false;
|
|
||||||
static const bool HasReadOperations = false;
|
|
||||||
static const bool HasWriteOperations = false;
|
|
||||||
static const bool HasWriteId = false;
|
|
||||||
static const bool HasHandler = false;
|
|
||||||
static const bool HasValid = false;
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
template <typename T, typename... TOptions>
|
|
||||||
struct MessageInterfaceParsedOptions<option::MsgIdType<T>, TOptions...> : public MessageInterfaceParsedOptions<TOptions...> {
|
|
||||||
static const bool HasMsgIdType = true;
|
|
||||||
using MsgIdType = T;
|
|
||||||
};
|
|
||||||
|
|
||||||
template <typename... TOptions>
|
|
||||||
struct MessageInterfaceParsedOptions<option::LittleEndian, TOptions...> : public MessageInterfaceParsedOptions<TOptions...> {
|
|
||||||
static const bool HasLittleEndian = true;
|
|
||||||
};
|
|
||||||
|
|
||||||
template <typename... TOptions>
|
|
||||||
struct MessageInterfaceParsedOptions<option::ReadOperations, TOptions...> : public MessageInterfaceParsedOptions<TOptions...> {
|
|
||||||
static const bool HasReadOperations = true;
|
|
||||||
};
|
|
||||||
|
|
||||||
template <typename... TOptions>
|
|
||||||
struct MessageInterfaceParsedOptions<option::WriteOperations, TOptions...> : public MessageInterfaceParsedOptions<TOptions...> {
|
|
||||||
static const bool HasWriteOperations = true;
|
|
||||||
};
|
|
||||||
|
|
||||||
template <typename... TOptions>
|
|
||||||
struct MessageInterfaceParsedOptions<option::WriteId, TOptions...> : public MessageInterfaceParsedOptions<TOptions...> {
|
|
||||||
static const bool HasWriteId = true;
|
|
||||||
};
|
|
||||||
|
|
||||||
template <typename T, typename... TOptions>
|
|
||||||
struct MessageInterfaceParsedOptions<option::Handler<T>, TOptions...> : public MessageInterfaceParsedOptions<TOptions...> {
|
|
||||||
static const bool HasHandler = true;
|
|
||||||
using HandlerType = option::Handler<T>;
|
|
||||||
};
|
|
||||||
|
|
||||||
template <typename... TOptions>
|
|
||||||
struct MessageInterfaceParsedOptions<option::ValidCheckInterface, TOptions...> : public MessageInterfaceParsedOptions<TOptions...> {
|
|
||||||
static const bool HasValid = true;
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
// ID retrieval chunk
|
|
||||||
template <typename TBase, typename TId>
|
|
||||||
class MessageInterfaceIdTypeBase : public TBase {
|
|
||||||
public:
|
|
||||||
using MsgIdType = TId;
|
|
||||||
MsgIdType GetId() const {
|
|
||||||
return GetIdImpl();
|
|
||||||
}
|
|
||||||
|
|
||||||
protected:
|
|
||||||
virtual MsgIdType GetIdImpl() const = 0;
|
|
||||||
};
|
|
||||||
|
|
||||||
// Big endian serialisation chunk
|
|
||||||
template <typename TBase>
|
|
||||||
class MessageInterfaceBigEndian : public TBase {
|
|
||||||
protected:
|
|
||||||
template <typename T>
|
|
||||||
void ReadData(T& value, DataBuffer& buffer) {
|
|
||||||
buffer >> value;
|
|
||||||
FromNetwork(value);
|
|
||||||
}
|
|
||||||
|
|
||||||
template <typename T>
|
|
||||||
void WriteData(T value, DataBuffer& buffer) {
|
|
||||||
ToNetwork(value);
|
|
||||||
buffer << value;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
// Little endian serialisation chunk
|
|
||||||
template <typename TBase>
|
|
||||||
class MessageInterfaceLittleEndian : public TBase {
|
|
||||||
protected:
|
|
||||||
template <typename T>
|
|
||||||
void ReadData(T& value, DataBuffer& buffer) {
|
|
||||||
buffer >> value;
|
|
||||||
TrySwapBytes(value);
|
|
||||||
FromNetwork(value);
|
|
||||||
}
|
|
||||||
|
|
||||||
template <typename T>
|
|
||||||
void WriteData(const T& value, DataBuffer& buffer) {
|
|
||||||
ToNetwork(value);
|
|
||||||
TrySwapBytes(value);
|
|
||||||
buffer << value;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
// Read functionality chunk
|
|
||||||
template <typename TBase>
|
|
||||||
class MessageInterfaceReadBase : public TBase {
|
|
||||||
public:
|
|
||||||
void Read(DataBuffer& buffer) {
|
|
||||||
return ReadImpl(buffer);
|
|
||||||
}
|
|
||||||
|
|
||||||
protected:
|
|
||||||
virtual void ReadImpl(DataBuffer& buffer) = 0;
|
|
||||||
};
|
|
||||||
|
|
||||||
// Write functionality chunk
|
|
||||||
template <typename TBase>
|
|
||||||
class MessageInterfaceWriteBase : public TBase {
|
|
||||||
public:
|
|
||||||
void Write(DataBuffer& buffer) {
|
|
||||||
WriteImpl(buffer);
|
|
||||||
}
|
|
||||||
|
|
||||||
protected:
|
|
||||||
virtual void WriteImpl(DataBuffer& buffer) = 0;
|
|
||||||
};
|
|
||||||
|
|
||||||
// Handler functionality chunk
|
|
||||||
template <typename TBase, typename THandler>
|
|
||||||
class MessageInterfaceHandlerBase : public TBase {
|
|
||||||
public:
|
|
||||||
using HandlerType = typename THandler::HandlerT;
|
|
||||||
|
|
||||||
void Dispatch(HandlerType& handler) {
|
|
||||||
DispatchImpl(handler);
|
|
||||||
}
|
|
||||||
|
|
||||||
protected:
|
|
||||||
virtual void DispatchImpl(HandlerType& handler) = 0;
|
|
||||||
};
|
|
||||||
|
|
||||||
// Validity functionality chunk
|
|
||||||
template <typename TBase>
|
|
||||||
class MessageInterfaceValidityBase : public TBase {
|
|
||||||
public:
|
|
||||||
bool Valid() const {
|
|
||||||
return ValidImpl();
|
|
||||||
}
|
|
||||||
|
|
||||||
protected:
|
|
||||||
virtual bool ValidImpl() const = 0;
|
|
||||||
};
|
|
||||||
|
|
||||||
// Writing id functionality chunk
|
|
||||||
template <typename TBase>
|
|
||||||
class MessageInterfaceWriteIdBase : public TBase {
|
|
||||||
public:
|
|
||||||
void Write(DataBuffer& buffer) {
|
|
||||||
this->WriteData(this->GetId(), buffer);
|
|
||||||
this->WriteImpl(buffer);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
// Build message Id
|
|
||||||
template <typename TBase, typename TParsedOptions, bool THasMsgIdType>
|
|
||||||
struct MessageInterfaceProcessMsgId;
|
|
||||||
|
|
||||||
template <typename TBase, typename TParsedOptions>
|
|
||||||
struct MessageInterfaceProcessMsgId<TBase, TParsedOptions, true> {
|
|
||||||
using Type = MessageInterfaceIdTypeBase<TBase, typename TParsedOptions::MsgIdType>;
|
|
||||||
};
|
|
||||||
|
|
||||||
template <typename TBase, typename TParsedOptions>
|
|
||||||
struct MessageInterfaceProcessMsgId<TBase, TParsedOptions, false> {
|
|
||||||
using Type = TBase;
|
|
||||||
};
|
|
||||||
|
|
||||||
// Build endianess
|
|
||||||
template <typename TBase, bool THasLittleEndian>
|
|
||||||
struct MessageInterfaceProcessEndian;
|
|
||||||
|
|
||||||
template <typename TBase>
|
|
||||||
struct MessageInterfaceProcessEndian<TBase, true> {
|
|
||||||
using Type = MessageInterfaceLittleEndian<TBase>;
|
|
||||||
};
|
|
||||||
|
|
||||||
template <typename TBase>
|
|
||||||
struct MessageInterfaceProcessEndian<TBase, false> {
|
|
||||||
using Type = MessageInterfaceBigEndian<TBase>;
|
|
||||||
};
|
|
||||||
|
|
||||||
// Build read
|
|
||||||
template <typename TBase, bool THasRead>
|
|
||||||
struct MessageInterfaceProcessRead;
|
|
||||||
|
|
||||||
template <typename TBase>
|
|
||||||
struct MessageInterfaceProcessRead<TBase, true> {
|
|
||||||
using Type = MessageInterfaceReadBase<TBase>;
|
|
||||||
};
|
|
||||||
|
|
||||||
template <typename TBase>
|
|
||||||
struct MessageInterfaceProcessRead<TBase, false> {
|
|
||||||
using Type = TBase;
|
|
||||||
};
|
|
||||||
|
|
||||||
// Build write
|
|
||||||
template <typename TBase, bool THasWrite>
|
|
||||||
struct MessageInterfaceProcessWrite;
|
|
||||||
|
|
||||||
template <typename TBase>
|
|
||||||
struct MessageInterfaceProcessWrite<TBase, true> {
|
|
||||||
using Type = MessageInterfaceWriteBase<TBase>;
|
|
||||||
};
|
|
||||||
|
|
||||||
template <typename TBase>
|
|
||||||
struct MessageInterfaceProcessWrite<TBase, false> {
|
|
||||||
using Type = TBase;
|
|
||||||
};
|
|
||||||
|
|
||||||
// Build handler
|
|
||||||
template <typename TBase, typename TParsedOptions, bool THasHandler>
|
|
||||||
struct MessageInterfaceProcessHandler;
|
|
||||||
|
|
||||||
template <typename TBase, typename TParsedOptions>
|
|
||||||
struct MessageInterfaceProcessHandler<TBase, TParsedOptions, true> {
|
|
||||||
using Type = MessageInterfaceHandlerBase<TBase, typename TParsedOptions::HandlerType>;
|
|
||||||
};
|
|
||||||
|
|
||||||
template <typename TBase, typename TParsedOptions>
|
|
||||||
struct MessageInterfaceProcessHandler<TBase, TParsedOptions, false> {
|
|
||||||
using Type = TBase;
|
|
||||||
};
|
|
||||||
|
|
||||||
// Build valid
|
|
||||||
template <typename TBase, bool THasValid>
|
|
||||||
struct MessageInterfaceProcessValid;
|
|
||||||
|
|
||||||
template <typename TBase>
|
|
||||||
struct MessageInterfaceProcessValid<TBase, true> {
|
|
||||||
using Type = MessageInterfaceValidityBase<TBase>;
|
|
||||||
};
|
|
||||||
|
|
||||||
template <typename TBase>
|
|
||||||
struct MessageInterfaceProcessValid<TBase, false> {
|
|
||||||
using Type = TBase;
|
|
||||||
};
|
|
||||||
|
|
||||||
// Build id writing
|
|
||||||
template <typename TBase, bool THasValid>
|
|
||||||
struct MessageInterfaceProcessWriteId;
|
|
||||||
|
|
||||||
template <typename TBase>
|
|
||||||
struct MessageInterfaceProcessWriteId<TBase, true> {
|
|
||||||
using Type = MessageInterfaceWriteIdBase<TBase>;
|
|
||||||
};
|
|
||||||
|
|
||||||
template <typename TBase>
|
|
||||||
struct MessageInterfaceProcessWriteId<TBase, false> {
|
|
||||||
using Type = TBase;
|
|
||||||
};
|
|
||||||
} // namespace details
|
|
||||||
} // namespace sp
|
|
||||||
39
include/sp/protocol/message/ArrayFillerImpl.h
Normal file
39
include/sp/protocol/message/ArrayFillerImpl.h
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
namespace sp {
|
||||||
|
namespace details {
|
||||||
|
|
||||||
|
template <typename TBase>
|
||||||
|
using ArrayType = std::vector<std::function<std::unique_ptr<TBase>(void)>>;
|
||||||
|
|
||||||
|
|
||||||
|
template <typename TBase, typename... TMessages>
|
||||||
|
struct ArrayFiller {};
|
||||||
|
|
||||||
|
template <typename TBase, typename... TMessages>
|
||||||
|
struct ArrayFiller<TBase, std::tuple<TMessages...>> {
|
||||||
|
static ArrayType<TBase> ArrayCreate() {
|
||||||
|
ArrayType<TBase> array;
|
||||||
|
array.reserve(sizeof...(TMessages));
|
||||||
|
ArrayFiller<TBase, TMessages...>::ArrayAppend(array);
|
||||||
|
return array;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename TBase, typename TMessage, typename... TMessages>
|
||||||
|
struct ArrayFiller<TBase, TMessage, TMessages...> {
|
||||||
|
static void ArrayAppend(details::ArrayType<TBase>& array) {
|
||||||
|
ArrayFiller<TBase, TMessage>::ArrayAppend(array);
|
||||||
|
ArrayFiller<TBase, TMessages...>::ArrayAppend(array);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename TBase, typename TMessage>
|
||||||
|
struct ArrayFiller<TBase, TMessage> {
|
||||||
|
static void ArrayAppend(details::ArrayType<TBase>& array) {
|
||||||
|
array.push_back([]() -> std::unique_ptr<TBase> { return std::make_unique<TMessage>(); });
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace details
|
||||||
|
} // namespace sp
|
||||||
36
include/sp/protocol/message/MessageDispatcherImpl.inl
Normal file
36
include/sp/protocol/message/MessageDispatcherImpl.inl
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
template <typename MessageIdType, typename MessageBase, typename MessageHandler>
|
||||||
|
void MessageDispatcher<MessageIdType, MessageBase, MessageHandler>::RegisterHandler(MessageIdType a_MessageType, MessageHandler* a_Handler) {
|
||||||
|
assert(a_Handler);
|
||||||
|
auto found = std::find(m_Handlers[a_MessageType].begin(), m_Handlers[a_MessageType].end(), a_Handler);
|
||||||
|
if (found == m_Handlers[a_MessageType].end())
|
||||||
|
m_Handlers[a_MessageType].push_back(a_Handler);
|
||||||
|
}
|
||||||
|
|
||||||
|
template <typename MessageIdType, typename MessageBase, typename MessageHandler>
|
||||||
|
void MessageDispatcher<MessageIdType, MessageBase, MessageHandler>::UnregisterHandler(MessageIdType a_MessageType, MessageHandler* a_Handler) {
|
||||||
|
auto found = std::find(m_Handlers[a_MessageType].begin(), m_Handlers[a_MessageType].end(), a_Handler);
|
||||||
|
if (found != m_Handlers[a_MessageType].end())
|
||||||
|
m_Handlers[a_MessageType].erase(found);
|
||||||
|
}
|
||||||
|
|
||||||
|
template <typename MessageIdType, typename MessageBase, typename MessageHandler>
|
||||||
|
void MessageDispatcher<MessageIdType, MessageBase, MessageHandler>::UnregisterHandler(MessageHandler* a_Handler) {
|
||||||
|
for (auto& pair : m_Handlers) {
|
||||||
|
if (pair.second.empty())
|
||||||
|
continue;
|
||||||
|
|
||||||
|
MessageIdType type = pair.first;
|
||||||
|
|
||||||
|
pair.second.erase(std::remove(pair.second.begin(), pair.second.end(), a_Handler), pair.second.end());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
template <typename MessageIdType, typename MessageBase, typename MessageHandler>
|
||||||
|
void MessageDispatcher<MessageIdType, MessageBase, MessageHandler>::Dispatch(const MessageBase& a_Message) {
|
||||||
|
MessageIdType type = a_Message.GetId();
|
||||||
|
for (auto& handler : m_Handlers[type]) {
|
||||||
|
a_Message.Dispatch(*handler);
|
||||||
|
}
|
||||||
|
}
|
||||||
45
include/sp/protocol/message/MessageImplBuilder.h
Normal file
45
include/sp/protocol/message/MessageImplBuilder.h
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
namespace sp {
|
||||||
|
namespace details {
|
||||||
|
|
||||||
|
|
||||||
|
// TBase is interface class
|
||||||
|
// TOptions... are the implementation options
|
||||||
|
template <typename TBase, typename... TOptions>
|
||||||
|
struct MessageImplBuilder {
|
||||||
|
// ParsedOptions class is supposed to be defined in comms::Message class
|
||||||
|
using InterfaceOptions = typename TBase::ParsedOptions;
|
||||||
|
|
||||||
|
// Parse implementation options
|
||||||
|
using ImplOptions = MessageImplParsedOptions<TOptions...>;
|
||||||
|
|
||||||
|
// Provide GetIdImpl() if possible
|
||||||
|
static const bool HasStaticNumIdImpl = InterfaceOptions::HasMsgIdType && ImplOptions::HasStaticNumIdImpl;
|
||||||
|
using Base1 = typename MessageImplProcessStaticNumId<TBase, ImplOptions, HasStaticNumIdImpl>::Type;
|
||||||
|
|
||||||
|
// Provide DispatchImpl() if possible
|
||||||
|
static const bool HasDispatchImpl = InterfaceOptions::HasHandler && ImplOptions::HasDispatchImpl;
|
||||||
|
using Base2 = typename MessageImplProcessDispatch<Base1, ImplOptions, HasDispatchImpl>::Type;
|
||||||
|
|
||||||
|
// Provide access to fields if possible
|
||||||
|
using Base3 = typename MessageImplProcessFields<Base2, ImplOptions, ImplOptions::HasFieldsImpl>::Type;
|
||||||
|
|
||||||
|
// Provide ReadImpl() if possible
|
||||||
|
static const bool HasReadImpl = InterfaceOptions::HasReadOperations && ImplOptions::HasFieldsImpl;
|
||||||
|
using Base4 = typename MessageImplProcessReadFields<Base3, HasReadImpl>::Type;
|
||||||
|
|
||||||
|
// Provide WriteImpl() if possible
|
||||||
|
static const bool HasWriteImpl = InterfaceOptions::HasWriteOperations && ImplOptions::HasFieldsImpl;
|
||||||
|
using Base5 = typename MessageImplProcessWriteFields<Base4, HasWriteImpl>::Type;
|
||||||
|
|
||||||
|
// Provide ValidImpl() if possible
|
||||||
|
static const bool HasValidImpl = InterfaceOptions::HasValid && ImplOptions::HasFieldsImpl;
|
||||||
|
using Base6 = typename MessageImplProcessValidFields<Base5, HasValidImpl>::Type;
|
||||||
|
|
||||||
|
// The last BaseN must be taken as final type.
|
||||||
|
using Type = Base6;
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace details
|
||||||
|
} // namespace sp
|
||||||
61
include/sp/protocol/message/MessageImplOptions.h
Normal file
61
include/sp/protocol/message/MessageImplOptions.h
Normal file
@@ -0,0 +1,61 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
namespace sp {
|
||||||
|
namespace option {
|
||||||
|
|
||||||
|
// Provide static numeric ID, to facilitate implementation of GetIdImpl()
|
||||||
|
template <std::intmax_t TId>
|
||||||
|
struct StaticNumIdImpl {};
|
||||||
|
|
||||||
|
// Facilitate implementation of DispatchImpl()
|
||||||
|
template <typename TActual>
|
||||||
|
struct DispatchImpl {};
|
||||||
|
|
||||||
|
// Provide fields of the message, facilitate implementation of
|
||||||
|
// ReadImpl(), WriteImpl(), ValidImpl(), etc...
|
||||||
|
template <typename TFields>
|
||||||
|
struct FieldsImpl {};
|
||||||
|
|
||||||
|
} // namespace option
|
||||||
|
|
||||||
|
|
||||||
|
namespace details {
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
template <typename... TOptions>
|
||||||
|
class MessageImplParsedOptions;
|
||||||
|
|
||||||
|
template <>
|
||||||
|
struct MessageImplParsedOptions<> {
|
||||||
|
static const bool HasStaticNumIdImpl = false;
|
||||||
|
static const bool HasDispatchImpl = false;
|
||||||
|
static const bool HasFieldsImpl = false;
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
template <std::intmax_t TId, typename... TOptions>
|
||||||
|
struct MessageImplParsedOptions<option::StaticNumIdImpl<TId>, TOptions...> : public MessageImplParsedOptions<TOptions...> {
|
||||||
|
static const bool HasStaticNumIdImpl = true;
|
||||||
|
static const std::intmax_t MsgId = TId;
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename TActual, typename... TOptions>
|
||||||
|
struct MessageImplParsedOptions<option::DispatchImpl<TActual>, TOptions...> : public MessageImplParsedOptions<TOptions...> {
|
||||||
|
static const bool HasDispatchImpl = true;
|
||||||
|
using ActualMessage = TActual;
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename TFields, typename... TOptions>
|
||||||
|
struct MessageImplParsedOptions<option::FieldsImpl<TFields>, TOptions...> : public MessageImplParsedOptions<TOptions...> {
|
||||||
|
static const bool HasFieldsImpl = true;
|
||||||
|
using Fields = TFields;
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace details
|
||||||
|
} // namespace sp
|
||||||
93
include/sp/protocol/message/MessageImplProcess.h
Normal file
93
include/sp/protocol/message/MessageImplProcess.h
Normal file
@@ -0,0 +1,93 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
namespace sp {
|
||||||
|
namespace details {
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
// id impl
|
||||||
|
template <typename TBase, typename ParsedImplOptions, bool TImplement>
|
||||||
|
struct MessageImplProcessStaticNumId;
|
||||||
|
|
||||||
|
template <typename TBase, typename ParsedImplOptions>
|
||||||
|
struct MessageImplProcessStaticNumId<TBase, ParsedImplOptions, true> {
|
||||||
|
using Type = MessageImplStaticNumIdBase<TBase, ParsedImplOptions::MsgId>;
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename TBase, typename ParsedImplOptions>
|
||||||
|
struct MessageImplProcessStaticNumId<TBase, ParsedImplOptions, false> {
|
||||||
|
using Type = TBase;
|
||||||
|
};
|
||||||
|
|
||||||
|
// dispatch impl
|
||||||
|
template <typename TBase, typename ParsedImplOptions, bool TImplement>
|
||||||
|
struct MessageImplProcessDispatch;
|
||||||
|
|
||||||
|
template <typename TBase, typename ParsedImplOptions>
|
||||||
|
struct MessageImplProcessDispatch<TBase, ParsedImplOptions, true> {
|
||||||
|
using Type = MessageImplDispatchBase<TBase, typename ParsedImplOptions::ActualMessage>;
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename TBase, typename ParsedImplOptions>
|
||||||
|
struct MessageImplProcessDispatch<TBase, ParsedImplOptions, false> {
|
||||||
|
using Type = TBase;
|
||||||
|
};
|
||||||
|
|
||||||
|
// fields impl
|
||||||
|
template <typename TBase, typename ParsedImplOptions, bool TImplement>
|
||||||
|
struct MessageImplProcessFields;
|
||||||
|
|
||||||
|
template <typename TBase, typename ParsedImplOptions>
|
||||||
|
struct MessageImplProcessFields<TBase, ParsedImplOptions, true> {
|
||||||
|
using Type = MessageImplFieldsBase<TBase, typename ParsedImplOptions::Fields>;
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename TBase, typename ParsedImplOptions>
|
||||||
|
struct MessageImplProcessFields<TBase, ParsedImplOptions, false> {
|
||||||
|
using Type = TBase;
|
||||||
|
};
|
||||||
|
|
||||||
|
// read impl
|
||||||
|
template <typename TBase, bool TImplement>
|
||||||
|
struct MessageImplProcessReadFields;
|
||||||
|
|
||||||
|
template <typename TBase>
|
||||||
|
struct MessageImplProcessReadFields<TBase, true> {
|
||||||
|
using Type = MessageImplFieldsReadBase<TBase>;
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename TBase>
|
||||||
|
struct MessageImplProcessReadFields<TBase, false> {
|
||||||
|
using Type = TBase;
|
||||||
|
};
|
||||||
|
|
||||||
|
// write impl
|
||||||
|
template <typename TBase, bool TImplement>
|
||||||
|
struct MessageImplProcessWriteFields;
|
||||||
|
|
||||||
|
template <typename TBase>
|
||||||
|
struct MessageImplProcessWriteFields<TBase, true> {
|
||||||
|
using Type = MessageImplFieldsWriteBase<TBase>;
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename TBase>
|
||||||
|
struct MessageImplProcessWriteFields<TBase, false> {
|
||||||
|
using Type = TBase;
|
||||||
|
};
|
||||||
|
|
||||||
|
// valid impl
|
||||||
|
template <typename TBase, bool TImplement>
|
||||||
|
struct MessageImplProcessValidFields;
|
||||||
|
|
||||||
|
template <typename TBase>
|
||||||
|
struct MessageImplProcessValidFields<TBase, true> {
|
||||||
|
using Type = MessageImplFieldsValidBase<TBase>;
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename TBase>
|
||||||
|
struct MessageImplProcessValidFields<TBase, false> {
|
||||||
|
using Type = TBase;
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace details
|
||||||
|
} // namespace sp
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
#pragma once
|
#pragma once
|
||||||
|
|
||||||
#include <sp/protocol/MessageInterfaces.h>
|
#include <sp/protocol/message/MessageInterfaces.h>
|
||||||
|
|
||||||
namespace sp {
|
namespace sp {
|
||||||
namespace details {
|
namespace details {
|
||||||
@@ -33,7 +33,7 @@ struct MessageInterfaceBuilder {
|
|||||||
// add write id functionality if write id and write was provided
|
// add write id functionality if write id and write was provided
|
||||||
using Base7 = typename MessageInterfaceProcessWriteId<Base6, ParsedOptions::HasWriteId && ParsedOptions::HasWriteOperations>::Type;
|
using Base7 = typename MessageInterfaceProcessWriteId<Base6, ParsedOptions::HasWriteId && ParsedOptions::HasWriteOperations>::Type;
|
||||||
|
|
||||||
// The last Base6 must be taken as final type.
|
// The last Base7 must be taken as final type.
|
||||||
using Type = Base7;
|
using Type = Base7;
|
||||||
};
|
};
|
||||||
|
|
||||||
105
include/sp/protocol/message/MessageInterfaceProcess.h
Normal file
105
include/sp/protocol/message/MessageInterfaceProcess.h
Normal file
@@ -0,0 +1,105 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
namespace sp {
|
||||||
|
namespace details {
|
||||||
|
|
||||||
|
// Build message Id
|
||||||
|
template <typename TBase, typename TParsedOptions, bool THasMsgIdType>
|
||||||
|
struct MessageInterfaceProcessMsgId;
|
||||||
|
|
||||||
|
template <typename TBase, typename TParsedOptions>
|
||||||
|
struct MessageInterfaceProcessMsgId<TBase, TParsedOptions, true> {
|
||||||
|
using Type = MessageInterfaceIdTypeBase<TBase, typename TParsedOptions::MsgIdType>;
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename TBase, typename TParsedOptions>
|
||||||
|
struct MessageInterfaceProcessMsgId<TBase, TParsedOptions, false> {
|
||||||
|
using Type = TBase;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Build endianess
|
||||||
|
template <typename TBase, bool THasLittleEndian>
|
||||||
|
struct MessageInterfaceProcessEndian;
|
||||||
|
|
||||||
|
template <typename TBase>
|
||||||
|
struct MessageInterfaceProcessEndian<TBase, true> {
|
||||||
|
using Type = MessageInterfaceLittleEndian<TBase>;
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename TBase>
|
||||||
|
struct MessageInterfaceProcessEndian<TBase, false> {
|
||||||
|
using Type = MessageInterfaceBigEndian<TBase>;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Build read
|
||||||
|
template <typename TBase, bool THasRead>
|
||||||
|
struct MessageInterfaceProcessRead;
|
||||||
|
|
||||||
|
template <typename TBase>
|
||||||
|
struct MessageInterfaceProcessRead<TBase, true> {
|
||||||
|
using Type = MessageInterfaceReadBase<TBase>;
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename TBase>
|
||||||
|
struct MessageInterfaceProcessRead<TBase, false> {
|
||||||
|
using Type = TBase;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Build write
|
||||||
|
template <typename TBase, bool THasWrite>
|
||||||
|
struct MessageInterfaceProcessWrite;
|
||||||
|
|
||||||
|
template <typename TBase>
|
||||||
|
struct MessageInterfaceProcessWrite<TBase, true> {
|
||||||
|
using Type = MessageInterfaceWriteBase<TBase>;
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename TBase>
|
||||||
|
struct MessageInterfaceProcessWrite<TBase, false> {
|
||||||
|
using Type = TBase;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Build handler
|
||||||
|
template <typename TBase, typename TParsedOptions, bool THasHandler>
|
||||||
|
struct MessageInterfaceProcessHandler;
|
||||||
|
|
||||||
|
template <typename TBase, typename TParsedOptions>
|
||||||
|
struct MessageInterfaceProcessHandler<TBase, TParsedOptions, true> {
|
||||||
|
using Type = MessageInterfaceHandlerBase<TBase, typename TParsedOptions::HandlerType>;
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename TBase, typename TParsedOptions>
|
||||||
|
struct MessageInterfaceProcessHandler<TBase, TParsedOptions, false> {
|
||||||
|
using Type = TBase;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Build valid
|
||||||
|
template <typename TBase, bool THasValid>
|
||||||
|
struct MessageInterfaceProcessValid;
|
||||||
|
|
||||||
|
template <typename TBase>
|
||||||
|
struct MessageInterfaceProcessValid<TBase, true> {
|
||||||
|
using Type = MessageInterfaceValidityBase<TBase>;
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename TBase>
|
||||||
|
struct MessageInterfaceProcessValid<TBase, false> {
|
||||||
|
using Type = TBase;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Build id writing
|
||||||
|
template <typename TBase, bool THasValid>
|
||||||
|
struct MessageInterfaceProcessWriteId;
|
||||||
|
|
||||||
|
template <typename TBase>
|
||||||
|
struct MessageInterfaceProcessWriteId<TBase, true> {
|
||||||
|
using Type = MessageInterfaceWriteIdBase<TBase>;
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename TBase>
|
||||||
|
struct MessageInterfaceProcessWriteId<TBase, false> {
|
||||||
|
using Type = TBase;
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace details
|
||||||
|
} // namespace sp
|
||||||
7
include/sp/protocol/message/MessageInterfaces.h
Normal file
7
include/sp/protocol/message/MessageInterfaces.h
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include <sp/protocol/message/MessageOptions.h>
|
||||||
|
|
||||||
|
#include <sp/protocol/message/MessageInterfacesOptions.h>
|
||||||
|
#include <sp/protocol/message/MessageInterfacesImpl.h>
|
||||||
|
#include <sp/protocol/message/MessageInterfaceProcess.h>
|
||||||
133
include/sp/protocol/message/MessageInterfacesImpl.h
Normal file
133
include/sp/protocol/message/MessageInterfacesImpl.h
Normal file
@@ -0,0 +1,133 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include <sp/common/ByteSwapping.h>
|
||||||
|
|
||||||
|
namespace sp {
|
||||||
|
namespace details {
|
||||||
|
|
||||||
|
|
||||||
|
// ID retrieval chunk
|
||||||
|
template <typename TBase, typename TId>
|
||||||
|
class MessageInterfaceIdTypeBase : public TBase {
|
||||||
|
public:
|
||||||
|
using MsgIdType = TId;
|
||||||
|
MsgIdType GetId() const {
|
||||||
|
return GetIdImpl();
|
||||||
|
}
|
||||||
|
|
||||||
|
protected:
|
||||||
|
virtual MsgIdType GetIdImpl() const = 0;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Big endian serialisation chunk
|
||||||
|
template <typename TBase>
|
||||||
|
class MessageInterfaceBigEndian : public TBase {
|
||||||
|
protected:
|
||||||
|
template <typename T>
|
||||||
|
void ReadData(T& value, DataBuffer& buffer) {
|
||||||
|
buffer >> value;
|
||||||
|
FromNetwork(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
template <typename T>
|
||||||
|
void WriteData(T value, DataBuffer& buffer) const {
|
||||||
|
ToNetwork(value);
|
||||||
|
buffer << value;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
// Little endian serialisation chunk
|
||||||
|
template <typename TBase>
|
||||||
|
class MessageInterfaceLittleEndian : public TBase {
|
||||||
|
protected:
|
||||||
|
template <typename T>
|
||||||
|
void ReadData(T& value, DataBuffer& buffer) {
|
||||||
|
buffer >> value;
|
||||||
|
TrySwapBytes(value);
|
||||||
|
FromNetwork(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
template <typename T>
|
||||||
|
void WriteData(const T& value, DataBuffer& buffer) {
|
||||||
|
ToNetwork(value);
|
||||||
|
TrySwapBytes(value);
|
||||||
|
buffer << value;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
// Read functionality chunk
|
||||||
|
template <typename TBase>
|
||||||
|
class MessageInterfaceReadBase : public TBase {
|
||||||
|
public:
|
||||||
|
void Read(DataBuffer& buffer) {
|
||||||
|
return ReadImpl(buffer);
|
||||||
|
}
|
||||||
|
|
||||||
|
protected:
|
||||||
|
virtual void ReadImpl(DataBuffer& buffer) = 0;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Write functionality chunk
|
||||||
|
template <typename TBase>
|
||||||
|
class MessageInterfaceWriteBase : public TBase {
|
||||||
|
public:
|
||||||
|
void Write(DataBuffer& buffer) const {
|
||||||
|
WriteImpl(buffer);
|
||||||
|
}
|
||||||
|
|
||||||
|
// helper
|
||||||
|
DataBuffer Write() const {
|
||||||
|
DataBuffer buffer;
|
||||||
|
this->Write(buffer);
|
||||||
|
return buffer;
|
||||||
|
}
|
||||||
|
|
||||||
|
protected:
|
||||||
|
virtual void WriteImpl(DataBuffer& buffer) const = 0;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Handler functionality chunk
|
||||||
|
template <typename TBase, typename THandler>
|
||||||
|
class MessageInterfaceHandlerBase : public TBase {
|
||||||
|
public:
|
||||||
|
using HandlerType = typename THandler::HandlerT;
|
||||||
|
|
||||||
|
void Dispatch(HandlerType& handler) const {
|
||||||
|
DispatchImpl(handler);
|
||||||
|
}
|
||||||
|
|
||||||
|
protected:
|
||||||
|
virtual void DispatchImpl(HandlerType& handler) const = 0;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Validity functionality chunk
|
||||||
|
template <typename TBase>
|
||||||
|
class MessageInterfaceValidityBase : public TBase {
|
||||||
|
public:
|
||||||
|
bool Valid() const {
|
||||||
|
return ValidImpl();
|
||||||
|
}
|
||||||
|
|
||||||
|
protected:
|
||||||
|
virtual bool ValidImpl() const = 0;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Writing id functionality chunk
|
||||||
|
template <typename TBase>
|
||||||
|
class MessageInterfaceWriteIdBase : public TBase {
|
||||||
|
public:
|
||||||
|
void Write(DataBuffer& buffer) const {
|
||||||
|
buffer << VarInt{this->GetId()};
|
||||||
|
this->WriteImpl(buffer);
|
||||||
|
}
|
||||||
|
|
||||||
|
// helper
|
||||||
|
DataBuffer Write() const {
|
||||||
|
DataBuffer buffer;
|
||||||
|
this->Write(buffer);
|
||||||
|
return buffer;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace details
|
||||||
|
} // namespace sp
|
||||||
63
include/sp/protocol/message/MessageInterfacesOptions.h
Normal file
63
include/sp/protocol/message/MessageInterfacesOptions.h
Normal file
@@ -0,0 +1,63 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
namespace sp {
|
||||||
|
namespace details {
|
||||||
|
|
||||||
|
|
||||||
|
template <typename... TOptions>
|
||||||
|
struct MessageInterfaceParsedOptions {};
|
||||||
|
|
||||||
|
template <>
|
||||||
|
struct MessageInterfaceParsedOptions<> {
|
||||||
|
static const bool HasMsgIdType = false;
|
||||||
|
static const bool HasLittleEndian = false;
|
||||||
|
static const bool HasReadOperations = false;
|
||||||
|
static const bool HasWriteOperations = false;
|
||||||
|
static const bool HasWriteId = false;
|
||||||
|
static const bool HasHandler = false;
|
||||||
|
static const bool HasValid = false;
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
template <typename T, typename... TOptions>
|
||||||
|
struct MessageInterfaceParsedOptions<option::MsgIdType<T>, TOptions...> : public MessageInterfaceParsedOptions<TOptions...> {
|
||||||
|
static const bool HasMsgIdType = true;
|
||||||
|
using MsgIdType = T;
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename... TOptions>
|
||||||
|
struct MessageInterfaceParsedOptions<option::LittleEndian, TOptions...> : public MessageInterfaceParsedOptions<TOptions...> {
|
||||||
|
static const bool HasLittleEndian = true;
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename... TOptions>
|
||||||
|
struct MessageInterfaceParsedOptions<option::ReadOperations, TOptions...> : public MessageInterfaceParsedOptions<TOptions...> {
|
||||||
|
static const bool HasReadOperations = true;
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename... TOptions>
|
||||||
|
struct MessageInterfaceParsedOptions<option::WriteOperations, TOptions...> : public MessageInterfaceParsedOptions<TOptions...> {
|
||||||
|
static const bool HasWriteOperations = true;
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename... TOptions>
|
||||||
|
struct MessageInterfaceParsedOptions<option::WriteId, TOptions...> : public MessageInterfaceParsedOptions<TOptions...> {
|
||||||
|
static const bool HasWriteId = true;
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename T, typename... TOptions>
|
||||||
|
struct MessageInterfaceParsedOptions<option::Handler<T>, TOptions...> : public MessageInterfaceParsedOptions<TOptions...> {
|
||||||
|
static const bool HasHandler = true;
|
||||||
|
using HandlerType = option::Handler<T>;
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename... TOptions>
|
||||||
|
struct MessageInterfaceParsedOptions<option::ValidCheckInterface, TOptions...> : public MessageInterfaceParsedOptions<TOptions...> {
|
||||||
|
static const bool HasValid = true;
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace details
|
||||||
|
} // namespace sp
|
||||||
160
include/sp/protocol/message/MessagesImpl.h
Normal file
160
include/sp/protocol/message/MessagesImpl.h
Normal file
@@ -0,0 +1,160 @@
|
|||||||
|
#pragma once
|
||||||
|
|
||||||
|
namespace sp {
|
||||||
|
namespace details {
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
// ID information chunk
|
||||||
|
template <typename TBase, std::intmax_t TId>
|
||||||
|
class MessageImplStaticNumIdBase : public TBase {
|
||||||
|
public:
|
||||||
|
// Reuse the message ID type defined in the interface
|
||||||
|
using MsgIdType = typename TBase::MsgIdType;
|
||||||
|
|
||||||
|
protected:
|
||||||
|
virtual MsgIdType GetIdImpl() const override {
|
||||||
|
return static_cast<MsgIdType>(TId);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
// Dispatch implementation chunk
|
||||||
|
template <typename TBase, typename TActual>
|
||||||
|
class MessageImplDispatchBase : public TBase {
|
||||||
|
public:
|
||||||
|
// Reuse the Handler type defined in the interface class
|
||||||
|
using Handler = typename TBase::HandlerType;
|
||||||
|
|
||||||
|
protected:
|
||||||
|
virtual void DispatchImpl(Handler& handler) const override {
|
||||||
|
handler.Handle(static_cast<const TActual&>(*this));
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
template <typename TBase, typename TFields>
|
||||||
|
class MessageImplFieldsBase : public TBase {
|
||||||
|
public:
|
||||||
|
using AllFields = typename details::FieldsBuilder<TFields>::Type;
|
||||||
|
|
||||||
|
template <typename... Args>
|
||||||
|
void Construct(Args... args) {
|
||||||
|
m_Fields = std::make_tuple(args...);
|
||||||
|
}
|
||||||
|
|
||||||
|
AllFields& GetFields() {
|
||||||
|
return m_Fields;
|
||||||
|
}
|
||||||
|
|
||||||
|
const AllFields& GetFields() const {
|
||||||
|
return m_Fields;
|
||||||
|
}
|
||||||
|
|
||||||
|
template <std::size_t FIndex>
|
||||||
|
auto& GetField() {
|
||||||
|
return std::get<FIndex>(GetFields()).GetValue();
|
||||||
|
}
|
||||||
|
|
||||||
|
template <std::size_t FIndex>
|
||||||
|
const auto& GetField() const {
|
||||||
|
return std::get<FIndex>(GetFields()).GetValue();
|
||||||
|
}
|
||||||
|
|
||||||
|
// allow use of enums
|
||||||
|
template <typename E, E FIndex>
|
||||||
|
const auto& GetField() const {
|
||||||
|
return std::get<static_cast<std::size_t>(FIndex)>(this->GetFields()).GetValue();
|
||||||
|
}
|
||||||
|
|
||||||
|
private:
|
||||||
|
AllFields m_Fields;
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename TBase>
|
||||||
|
class MessageImplFieldsReadBase : public TBase {
|
||||||
|
private:
|
||||||
|
// normal reading
|
||||||
|
template <typename TField>
|
||||||
|
void ReadField(Field<TField, 0>& field, DataBuffer& buffer) {
|
||||||
|
this->ReadData(field.GetValue(), buffer);
|
||||||
|
}
|
||||||
|
|
||||||
|
// reading field in bitfield
|
||||||
|
template <typename TFieldType, typename TField, int IAlignment>
|
||||||
|
void ReadField(Field<TField, IAlignment>& field, TFieldType data, std::size_t offset) {
|
||||||
|
static constexpr std::size_t TotalBitCount = sizeof(TFieldType) * 8;
|
||||||
|
// we suppose that the first element is at the highest bits
|
||||||
|
field.GetValue() = (data >> TotalBitCount - IAlignment - offset) & ((1 << IAlignment) - 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
// reading bitfield
|
||||||
|
template <typename TContainer, typename TFirst, typename... TFields>
|
||||||
|
void ReadField(Field<BitField<TContainer, TFirst, TFields...>, 0>& field, DataBuffer& buffer) {
|
||||||
|
TContainer data;
|
||||||
|
this->ReadData(data, buffer);
|
||||||
|
std::size_t offset = 0;
|
||||||
|
TupleForEach(
|
||||||
|
[data, this, &offset](auto& field) {
|
||||||
|
this->ReadField(field, data, offset);
|
||||||
|
offset += field.GetAlignment();
|
||||||
|
},
|
||||||
|
field.GetValue().GetFields());
|
||||||
|
}
|
||||||
|
|
||||||
|
void ReadImpl(DataBuffer& buffer) override {
|
||||||
|
auto& allFields = this->GetFields();
|
||||||
|
TupleForEach([&buffer, this](auto& field) { this->ReadField(field, buffer); }, allFields);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename TBase>
|
||||||
|
class MessageImplFieldsWriteBase : public TBase {
|
||||||
|
private:
|
||||||
|
// normal writing
|
||||||
|
template <typename TField>
|
||||||
|
void WriteField(const Field<TField, 0>& field, DataBuffer& buffer) const {
|
||||||
|
this->WriteData(field.GetValue(), buffer);
|
||||||
|
}
|
||||||
|
|
||||||
|
// writing field in bitfield
|
||||||
|
template <typename TFieldType, typename TField, int IAlignment>
|
||||||
|
void WriteField(const Field<TField, IAlignment>& field, TFieldType& data, std::size_t offset) const {
|
||||||
|
static constexpr std::size_t TotalBitCount = sizeof(TFieldType) * 8;
|
||||||
|
// we suppose that the first element is at the highest bits
|
||||||
|
data |= (field.GetValue() & ((1 << IAlignment) - 1)) << TotalBitCount - IAlignment - offset;
|
||||||
|
}
|
||||||
|
|
||||||
|
// writing bitfield
|
||||||
|
template <typename TContainer, typename TFirst, typename... TFields>
|
||||||
|
void WriteField(const Field<BitField<TContainer, TFirst, TFields...>, 0>& field, DataBuffer& buffer) const {
|
||||||
|
TContainer data = 0;
|
||||||
|
std::size_t offset = 0;
|
||||||
|
TupleForEach(
|
||||||
|
[&data, this, &offset](auto& field) {
|
||||||
|
this->WriteField(field, data, offset);
|
||||||
|
offset += field.GetAlignment();
|
||||||
|
},
|
||||||
|
field.GetValue().GetFields());
|
||||||
|
this->WriteData(data, buffer);
|
||||||
|
}
|
||||||
|
|
||||||
|
void WriteImpl(DataBuffer& buffer) const override {
|
||||||
|
auto& allFields = this->GetFields();
|
||||||
|
TupleForEach([&buffer, this](const auto& field) { this->WriteField(field, buffer); }, allFields);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename TBase>
|
||||||
|
class MessageImplFieldsValidBase : public TBase {
|
||||||
|
protected:
|
||||||
|
bool ValidImpl() const override {
|
||||||
|
// Access fields via interface provided in previous chunk
|
||||||
|
// auto& allFields = TBase::GetFields();
|
||||||
|
//... // validate all the fields
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace details
|
||||||
|
} // namespace sp
|
||||||
44
src/main.cpp
44
src/main.cpp
@@ -1,44 +0,0 @@
|
|||||||
#include <iostream>
|
|
||||||
|
|
||||||
#include <examples/PacketExample.h>
|
|
||||||
#include <memory>
|
|
||||||
|
|
||||||
class KeepAliveHandler : public sp::PacketHandler {
|
|
||||||
void Handle(KeepAlivePacket& packet) {
|
|
||||||
std::cout << "KeepAlive handled !\n";
|
|
||||||
}
|
|
||||||
|
|
||||||
void Handle(DisconnectPacket& packet) {
|
|
||||||
std::cout << "Disconnect handled !\n";
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
int main() {
|
|
||||||
auto keepAlive = std::make_unique<KeepAlivePacket>(69);
|
|
||||||
sp::PacketMessage* msg = keepAlive.get();
|
|
||||||
|
|
||||||
KeepAliveHandler handler;
|
|
||||||
msg->Dispatch(handler);
|
|
||||||
|
|
||||||
sp::DataBuffer buffer;
|
|
||||||
msg->Write(buffer);
|
|
||||||
|
|
||||||
std::uint8_t msgId;
|
|
||||||
buffer >> msgId;
|
|
||||||
|
|
||||||
auto keepAlive2 = std::make_unique<KeepAlivePacket>();
|
|
||||||
keepAlive2->Read(buffer);
|
|
||||||
|
|
||||||
std::cout << "KeepAlive2 : " << keepAlive2->GetField<KeepAliveId>() << "\n";
|
|
||||||
|
|
||||||
sp::PacketFactory factory;
|
|
||||||
auto packet = factory.CreateMessage(msgId);
|
|
||||||
if (packet == nullptr) {
|
|
||||||
std::cout << "Mauvais ID !\n";
|
|
||||||
return 1;
|
|
||||||
}
|
|
||||||
std::cout << (unsigned)packet->GetId() << std::endl;
|
|
||||||
packet->Dispatch(handler);
|
|
||||||
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
74
src/sp/common/ByteSwapping.cpp
Normal file
74
src/sp/common/ByteSwapping.cpp
Normal file
@@ -0,0 +1,74 @@
|
|||||||
|
#include <sp/common/ByteSwapping.h>
|
||||||
|
|
||||||
|
#ifdef _WIN32
|
||||||
|
#include <winsock2.h>
|
||||||
|
#else
|
||||||
|
#include <arpa/inet.h>
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#include <algorithm>
|
||||||
|
|
||||||
|
namespace sp {
|
||||||
|
|
||||||
|
template <typename T>
|
||||||
|
void SwapBytes(T& value) {
|
||||||
|
char* ptr = reinterpret_cast<char*>(&value);
|
||||||
|
std::reverse(ptr, ptr + sizeof(T));
|
||||||
|
}
|
||||||
|
|
||||||
|
bool IsSystemBigEndian() {
|
||||||
|
static constexpr std::uint16_t test = 10;
|
||||||
|
static const bool isBigEndian = reinterpret_cast<const std::uint8_t*>(&test)[1] == 10;
|
||||||
|
return isBigEndian;
|
||||||
|
}
|
||||||
|
|
||||||
|
template <>
|
||||||
|
void ToNetwork<std::uint16_t>(std::uint16_t& value) {
|
||||||
|
value = htons(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
template <>
|
||||||
|
void ToNetwork<std::uint32_t>(std::uint32_t& value) {
|
||||||
|
value = htonl(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
template <>
|
||||||
|
void ToNetwork<std::uint64_t>(std::uint64_t& value) {
|
||||||
|
if (IsSystemBigEndian())
|
||||||
|
return;
|
||||||
|
SwapBytes(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
template <>
|
||||||
|
void FromNetwork<std::uint16_t>(std::uint16_t& value) {
|
||||||
|
value = ntohs(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
template <>
|
||||||
|
void FromNetwork<std::uint32_t>(std::uint32_t& value) {
|
||||||
|
value = ntohl(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
template <>
|
||||||
|
void FromNetwork<std::uint64_t>(std::uint64_t& value) {
|
||||||
|
if (IsSystemBigEndian())
|
||||||
|
return;
|
||||||
|
SwapBytes(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
template <>
|
||||||
|
void TrySwapBytes<std::uint16_t>(std::uint16_t& value) {
|
||||||
|
SwapBytes(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
template <>
|
||||||
|
void TrySwapBytes<std::uint32_t>(std::uint32_t& value) {
|
||||||
|
SwapBytes(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
template <>
|
||||||
|
void TrySwapBytes<std::uint64_t>(std::uint64_t& value) {
|
||||||
|
SwapBytes(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
} // namespace sp
|
||||||
@@ -4,13 +4,12 @@
|
|||||||
#include <iomanip>
|
#include <iomanip>
|
||||||
#include <sstream>
|
#include <sstream>
|
||||||
|
|
||||||
#include <sp/misc/Format.h>
|
|
||||||
#include <sp/misc/Log.h>
|
|
||||||
|
|
||||||
namespace sp {
|
namespace sp {
|
||||||
|
|
||||||
DataBuffer::DataBuffer() : m_ReadOffset(0) {}
|
DataBuffer::DataBuffer() : m_ReadOffset(0) {}
|
||||||
|
|
||||||
|
DataBuffer::DataBuffer(std::size_t a_InitialSize) : m_Buffer(a_InitialSize), m_ReadOffset(0) {}
|
||||||
|
|
||||||
DataBuffer::DataBuffer(const DataBuffer& other) : m_Buffer(other.m_Buffer), m_ReadOffset(other.m_ReadOffset) {}
|
DataBuffer::DataBuffer(const DataBuffer& other) : m_Buffer(other.m_Buffer), m_ReadOffset(other.m_ReadOffset) {}
|
||||||
|
|
||||||
DataBuffer::DataBuffer(DataBuffer&& other) : m_Buffer(std::move(other.m_Buffer)), m_ReadOffset(std::move(other.m_ReadOffset)) {}
|
DataBuffer::DataBuffer(DataBuffer&& other) : m_Buffer(std::move(other.m_Buffer)), m_ReadOffset(std::move(other.m_ReadOffset)) {}
|
||||||
@@ -133,31 +132,19 @@ std::ostream& operator<<(std::ostream& os, const DataBuffer& buffer) {
|
|||||||
return os;
|
return os;
|
||||||
}
|
}
|
||||||
|
|
||||||
bool DataBuffer::ReadFile(const std::string& fileName) {
|
void DataBuffer::ReadFile(const std::string& fileName) {
|
||||||
try {
|
std::ifstream file(fileName, std::istream::binary);
|
||||||
std::ifstream file(fileName, std::istream::binary);
|
std::ostringstream ss;
|
||||||
std::ostringstream ss;
|
ss << file.rdbuf();
|
||||||
ss << file.rdbuf();
|
const std::string& s = ss.str();
|
||||||
const std::string& s = ss.str();
|
m_Buffer = DataBuffer::Data(s.begin(), s.end());
|
||||||
m_Buffer = DataBuffer::Data(s.begin(), s.end());
|
m_ReadOffset = 0;
|
||||||
m_ReadOffset = 0;
|
|
||||||
} catch (std::exception& e) {
|
|
||||||
utils::LOGE(utils::Format("[IO] Failed to read file %s ! reason : %s", fileName.c_str(), e.what()));
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
return m_Buffer.size() > 0;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
bool DataBuffer::WriteFile(const std::string& fileName) const {
|
void DataBuffer::WriteFile(const std::string& fileName) const {
|
||||||
try {
|
std::ofstream file(fileName, std::ostream::binary);
|
||||||
std::ofstream file(fileName, std::ostream::binary);
|
file.write(reinterpret_cast<const char*>(m_Buffer.data()), static_cast<std::streamsize>(m_Buffer.size()));
|
||||||
file.write(reinterpret_cast<const char*>(m_Buffer.data()), static_cast<std::streamsize>(m_Buffer.size()));
|
file.flush();
|
||||||
file.flush();
|
|
||||||
} catch (std::exception& e) {
|
|
||||||
utils::LOGE(utils::Format("[IO] Failed to read file %s ! reason : %s", fileName.c_str(), e.what()));
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
return true;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
} // namespace sp
|
} // namespace sp
|
||||||
|
|||||||
89
src/sp/extensions/Compress.cpp
Normal file
89
src/sp/extensions/Compress.cpp
Normal file
@@ -0,0 +1,89 @@
|
|||||||
|
#include <sp/extensions/Compress.h>
|
||||||
|
|
||||||
|
#include <cassert>
|
||||||
|
#include <sp/common/VarInt.h>
|
||||||
|
#include <zlib.h>
|
||||||
|
|
||||||
|
namespace sp {
|
||||||
|
namespace zlib {
|
||||||
|
|
||||||
|
static DataBuffer Inflate(const std::uint8_t* source, std::size_t size, std::size_t uncompressedSize) {
|
||||||
|
DataBuffer result;
|
||||||
|
result.Resize(uncompressedSize);
|
||||||
|
|
||||||
|
uncompress(static_cast<Bytef*>(result.data()), reinterpret_cast<uLongf*>(&uncompressedSize), static_cast<const Bytef*>(source),
|
||||||
|
static_cast<uLong>(size));
|
||||||
|
|
||||||
|
assert(result.GetSize() == uncompressedSize);
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
static DataBuffer Deflate(const std::uint8_t* source, std::size_t size) {
|
||||||
|
DataBuffer result;
|
||||||
|
uLongf compressedSize = size;
|
||||||
|
|
||||||
|
result.Resize(size); // Resize for the compressed data to fit into
|
||||||
|
compress(static_cast<Bytef*>(result.data()), &compressedSize, static_cast<const Bytef*>(source), static_cast<uLong>(size));
|
||||||
|
result.Resize(compressedSize); // Resize to cut useless data
|
||||||
|
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
DataBuffer Compress(const DataBuffer& buffer, std::size_t a_CompressionThreshold) {
|
||||||
|
DataBuffer packet;
|
||||||
|
|
||||||
|
if (buffer.GetSize() < a_CompressionThreshold) {
|
||||||
|
// Don't compress since it's a small packet
|
||||||
|
packet << VarInt{0};
|
||||||
|
packet << buffer;
|
||||||
|
return packet;
|
||||||
|
}
|
||||||
|
|
||||||
|
DataBuffer compressedData = Deflate(buffer.data(), buffer.GetSize());
|
||||||
|
VarInt uncompressedDataLength = buffer.GetSize();
|
||||||
|
|
||||||
|
if (compressedData.GetSize() >= buffer.GetSize()) {
|
||||||
|
// the compression is overkill so we don't send the compressed buffer
|
||||||
|
packet << VarInt{0};
|
||||||
|
packet << buffer;
|
||||||
|
} else {
|
||||||
|
packet << uncompressedDataLength;
|
||||||
|
packet << compressedData;
|
||||||
|
}
|
||||||
|
|
||||||
|
return packet;
|
||||||
|
}
|
||||||
|
|
||||||
|
DataBuffer Decompress(DataBuffer& buffer, std::uint64_t packetLength) {
|
||||||
|
VarInt uncompressedLength;
|
||||||
|
buffer >> uncompressedLength;
|
||||||
|
|
||||||
|
std::uint64_t compressedLength = packetLength - uncompressedLength.GetSerializedLength();
|
||||||
|
|
||||||
|
if (uncompressedLength.GetValue() == 0) {
|
||||||
|
// Data already uncompressed. Nothing to do
|
||||||
|
DataBuffer ret;
|
||||||
|
buffer.ReadSome(ret, compressedLength);
|
||||||
|
return ret;
|
||||||
|
}
|
||||||
|
|
||||||
|
assert(buffer.GetReadOffset() + compressedLength <= buffer.GetSize());
|
||||||
|
|
||||||
|
return Inflate(buffer.data() + buffer.GetReadOffset(), compressedLength, uncompressedLength.GetValue());
|
||||||
|
}
|
||||||
|
|
||||||
|
} // namespace zlib
|
||||||
|
|
||||||
|
namespace io {
|
||||||
|
|
||||||
|
DataBuffer MessageEncapsulator<option::ZlibCompress>::Encapsulate(const DataBuffer& a_Data, const option::ZlibCompress& a_Option) {
|
||||||
|
static constexpr std::size_t MAX_COMPRESS_THRESHOLD = VarInt::MAX_VALUE;
|
||||||
|
return zlib::Compress(a_Data, a_Option.m_Enabled ? a_Option.m_CompressionThreshold : MAX_COMPRESS_THRESHOLD);
|
||||||
|
}
|
||||||
|
|
||||||
|
DataBuffer MessageEncapsulator<option::ZlibCompress>::Decapsulate(DataBuffer& a_Data, const option::ZlibCompress& a_Option) {
|
||||||
|
return zlib::Decompress(a_Data, a_Data.GetSize());
|
||||||
|
}
|
||||||
|
|
||||||
|
} // namespace io
|
||||||
|
} // namespace sp
|
||||||
114
src/sp/extensions/TcpListener.cpp
Normal file
114
src/sp/extensions/TcpListener.cpp
Normal file
@@ -0,0 +1,114 @@
|
|||||||
|
#include <sp/extensions/tcp/TcpListener.h>
|
||||||
|
|
||||||
|
|
||||||
|
#ifdef _WIN32
|
||||||
|
|
||||||
|
// Windows
|
||||||
|
|
||||||
|
#include <winsock2.h>
|
||||||
|
#include <ws2tcpip.h>
|
||||||
|
|
||||||
|
#define ioctl ioctlsocket
|
||||||
|
#define WOULDBLOCK WSAEWOULDBLOCK
|
||||||
|
#define MSG_DONTWAIT 0
|
||||||
|
|
||||||
|
#else
|
||||||
|
|
||||||
|
// Linux/Unix
|
||||||
|
|
||||||
|
#include <arpa/inet.h>
|
||||||
|
#include <netdb.h>
|
||||||
|
#include <netinet/in.h>
|
||||||
|
#include <sys/ioctl.h>
|
||||||
|
#include <sys/socket.h>
|
||||||
|
#include <sys/types.h>
|
||||||
|
#include <unistd.h>
|
||||||
|
|
||||||
|
#define closesocket close
|
||||||
|
#define WOULDBLOCK EWOULDBLOCK
|
||||||
|
#define SD_BOTH SHUT_RDWR
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
#ifndef INVALID_SOCKET
|
||||||
|
#define INVALID_SOCKET -1
|
||||||
|
#endif
|
||||||
|
|
||||||
|
|
||||||
|
namespace sp {
|
||||||
|
namespace io {
|
||||||
|
|
||||||
|
TcpListener::TcpListener(std::uint16_t a_Port, int a_MaxConnexions) {
|
||||||
|
if ((m_Handle = static_cast<SocketHandle>(socket(AF_INET, SOCK_STREAM, IPPROTO_TCP))) < 0) {
|
||||||
|
throw SocketError("Failed to create server socket");
|
||||||
|
}
|
||||||
|
|
||||||
|
struct sockaddr_in address;
|
||||||
|
address.sin_family = AF_INET;
|
||||||
|
address.sin_addr.s_addr = INADDR_ANY;
|
||||||
|
address.sin_port = htons(a_Port);
|
||||||
|
|
||||||
|
if (bind(m_Handle, reinterpret_cast<sockaddr*>(&address), sizeof(address)) < 0)
|
||||||
|
throw SocketError("Failed to create server socket");
|
||||||
|
|
||||||
|
if (listen(m_Handle, a_MaxConnexions) < 0)
|
||||||
|
throw SocketError("Failed to create server socket");
|
||||||
|
|
||||||
|
socklen_t len = sizeof(address);
|
||||||
|
if (getsockname(m_Handle, reinterpret_cast<sockaddr*>(&address), &len) < 0)
|
||||||
|
throw SocketError("Failed to create server socket");
|
||||||
|
|
||||||
|
m_Port = ntohs(address.sin_port);
|
||||||
|
m_MaxConnections = a_MaxConnexions;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
TcpListener::~TcpListener() {
|
||||||
|
Close();
|
||||||
|
}
|
||||||
|
|
||||||
|
std::unique_ptr<TcpSocket> TcpListener::Accept() {
|
||||||
|
sockaddr remoteAddress;
|
||||||
|
int addrlen = sizeof(remoteAddress);
|
||||||
|
|
||||||
|
auto newSocket = std::make_unique<TcpSocket>();
|
||||||
|
|
||||||
|
newSocket->m_Handle = static_cast<SocketHandle>(
|
||||||
|
accept(m_Handle, reinterpret_cast<sockaddr*>(&remoteAddress), reinterpret_cast<socklen_t*>(&addrlen)));
|
||||||
|
|
||||||
|
if (newSocket->m_Handle < 0)
|
||||||
|
return nullptr;
|
||||||
|
|
||||||
|
newSocket->m_Status = TcpSocket::Status::Connected;
|
||||||
|
return newSocket;
|
||||||
|
}
|
||||||
|
|
||||||
|
void TcpListener::Close() {
|
||||||
|
if (m_Handle > 0) {
|
||||||
|
closesocket(m_Handle);
|
||||||
|
shutdown(m_Handle, SD_BOTH);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
bool TcpListener::SetBlocking(bool a_Blocking) {
|
||||||
|
unsigned long mode = !a_Blocking;
|
||||||
|
|
||||||
|
if (ioctl(m_Handle, FIONBIO, &mode) < 0) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
std::uint16_t TcpListener::GetListeningPort() const {
|
||||||
|
return m_Port;
|
||||||
|
}
|
||||||
|
|
||||||
|
int TcpListener::GetMaximumConnections() const {
|
||||||
|
return m_MaxConnections;
|
||||||
|
}
|
||||||
|
|
||||||
|
} // namespace io
|
||||||
|
} // namespace sp
|
||||||
164
src/sp/extensions/TcpSocket.cpp
Normal file
164
src/sp/extensions/TcpSocket.cpp
Normal file
@@ -0,0 +1,164 @@
|
|||||||
|
#include <sp/extensions/tcp/TcpSocket.h>
|
||||||
|
|
||||||
|
#ifdef _WIN32
|
||||||
|
|
||||||
|
// Windows
|
||||||
|
|
||||||
|
#include <winsock2.h>
|
||||||
|
#include <ws2tcpip.h>
|
||||||
|
|
||||||
|
#define ioctl ioctlsocket
|
||||||
|
#define WOULDBLOCK WSAEWOULDBLOCK
|
||||||
|
#define MSG_DONTWAIT 0
|
||||||
|
|
||||||
|
#else
|
||||||
|
|
||||||
|
// Linux/Unix
|
||||||
|
|
||||||
|
#include <arpa/inet.h>
|
||||||
|
#include <netdb.h>
|
||||||
|
#include <netinet/in.h>
|
||||||
|
#include <sys/ioctl.h>
|
||||||
|
#include <sys/socket.h>
|
||||||
|
#include <sys/types.h>
|
||||||
|
#include <unistd.h>
|
||||||
|
|
||||||
|
#define closesocket close
|
||||||
|
#define WOULDBLOCK EWOULDBLOCK
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
#ifndef INVALID_SOCKET
|
||||||
|
#define INVALID_SOCKET -1
|
||||||
|
#endif
|
||||||
|
|
||||||
|
|
||||||
|
namespace sp {
|
||||||
|
namespace io {
|
||||||
|
|
||||||
|
TcpSocket::IOInterface() : m_Handle(static_cast<SocketHandle>(INVALID_SOCKET)), m_Status(Status::Disconnected) {}
|
||||||
|
|
||||||
|
TcpSocket::IOInterface(const std::string& a_Host, std::uint16_t a_Port) : IOInterface() {
|
||||||
|
Connect(a_Host, a_Port);
|
||||||
|
}
|
||||||
|
|
||||||
|
TcpSocket::IOInterface(IOInterface&& a_Other) {
|
||||||
|
std::swap(m_Handle, a_Other.m_Handle);
|
||||||
|
std::swap(m_Status, a_Other.m_Status);
|
||||||
|
}
|
||||||
|
|
||||||
|
TcpSocket::~IOInterface() {}
|
||||||
|
|
||||||
|
void TcpSocket::Connect(const std::string& a_Host, std::uint16_t a_Port) {
|
||||||
|
struct addrinfo hints {};
|
||||||
|
|
||||||
|
struct addrinfo* result = nullptr;
|
||||||
|
|
||||||
|
hints.ai_family = AF_INET;
|
||||||
|
hints.ai_socktype = SOCK_STREAM;
|
||||||
|
hints.ai_protocol = IPPROTO_TCP;
|
||||||
|
|
||||||
|
m_Status = Status::Error;
|
||||||
|
|
||||||
|
if (getaddrinfo(a_Host.c_str(), std::to_string(static_cast<int>(a_Port)).c_str(), &hints, &result) != 0) {
|
||||||
|
throw SocketError("Failed to get address info");
|
||||||
|
}
|
||||||
|
|
||||||
|
m_Handle = static_cast<SocketHandle>(socket(AF_INET, SOCK_STREAM, IPPROTO_TCP));
|
||||||
|
if (m_Handle < 0) {
|
||||||
|
throw SocketError("Failed to create socket");
|
||||||
|
}
|
||||||
|
|
||||||
|
struct addrinfo* ptr = nullptr;
|
||||||
|
for (ptr = result; ptr != nullptr; ptr = ptr->ai_next) {
|
||||||
|
struct sockaddr* sockaddr = ptr->ai_addr;
|
||||||
|
if (connect(m_Handle, sockaddr, sizeof(sockaddr_in)) == 0) {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
freeaddrinfo(result);
|
||||||
|
|
||||||
|
if (!ptr) {
|
||||||
|
throw SocketError("Could not find a suitable interface for connecting");
|
||||||
|
}
|
||||||
|
|
||||||
|
m_Status = Status::Connected;
|
||||||
|
}
|
||||||
|
|
||||||
|
DataBuffer TcpSocket::Read(std::size_t a_Amount) {
|
||||||
|
DataBuffer buffer(a_Amount);
|
||||||
|
|
||||||
|
std::size_t totalRecieved = 0;
|
||||||
|
|
||||||
|
while (totalRecieved < a_Amount) {
|
||||||
|
int recvAmount =
|
||||||
|
recv(m_Handle, reinterpret_cast<char*>(buffer.data() + totalRecieved), static_cast<int>(a_Amount - totalRecieved), 0);
|
||||||
|
if (recvAmount <= 0) {
|
||||||
|
#if defined(_WIN32) || defined(WIN32)
|
||||||
|
int err = WSAGetLastError();
|
||||||
|
#else
|
||||||
|
int err = errno;
|
||||||
|
#endif
|
||||||
|
if (err == WOULDBLOCK) {
|
||||||
|
// we are in non blocking mode and nothing is available
|
||||||
|
return {};
|
||||||
|
}
|
||||||
|
|
||||||
|
Disconnect();
|
||||||
|
m_Status = Status::Error;
|
||||||
|
throw SocketError("Error while reading");
|
||||||
|
}
|
||||||
|
totalRecieved += recvAmount;
|
||||||
|
}
|
||||||
|
return buffer;
|
||||||
|
}
|
||||||
|
|
||||||
|
void TcpSocket::Write(const sp::DataBuffer& a_Data) {
|
||||||
|
if (GetStatus() != Status::Connected)
|
||||||
|
return;
|
||||||
|
|
||||||
|
std::size_t sent = 0;
|
||||||
|
|
||||||
|
while (sent < a_Data.GetSize()) {
|
||||||
|
int cur = send(m_Handle, reinterpret_cast<const char*>(a_Data.data() + sent), static_cast<int>(a_Data.GetSize() - sent), 0);
|
||||||
|
|
||||||
|
if (cur <= 0) {
|
||||||
|
Disconnect();
|
||||||
|
m_Status = Status::Error;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
sent += static_cast<std::size_t>(cur);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
bool TcpSocket::SetBlocking(bool a_Block) {
|
||||||
|
unsigned long mode = !a_Block;
|
||||||
|
|
||||||
|
if (ioctl(m_Handle, FIONBIO, &mode) < 0) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
TcpSocket::Status TcpSocket::GetStatus() const {
|
||||||
|
return m_Status;
|
||||||
|
}
|
||||||
|
|
||||||
|
void TcpSocket::Disconnect() {
|
||||||
|
if (m_Handle > 0)
|
||||||
|
closesocket(m_Handle);
|
||||||
|
m_Status = Status::Disconnected;
|
||||||
|
}
|
||||||
|
|
||||||
|
TcpSocket& TcpSocket::operator=(IOInterface&& a_Other) {
|
||||||
|
std::swap(m_Handle, a_Other.m_Handle);
|
||||||
|
std::swap(m_Status, a_Other.m_Status);
|
||||||
|
return *this;
|
||||||
|
}
|
||||||
|
|
||||||
|
} // namespace io
|
||||||
|
} // namespace sp
|
||||||
31
src/sp/io/File.cpp
Normal file
31
src/sp/io/File.cpp
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
#include <sp/io/File.h>
|
||||||
|
|
||||||
|
namespace sp {
|
||||||
|
namespace io {
|
||||||
|
|
||||||
|
File::IOInterface(const std::string& a_FilePath, unsigned int a_OpenMode) {
|
||||||
|
if (a_OpenMode & FileTag::OpenMode::In)
|
||||||
|
m_FileInput = std::make_unique<std::ifstream>(a_FilePath, std::ios::binary);
|
||||||
|
if (a_OpenMode & FileTag::OpenMode::Out)
|
||||||
|
m_FileOutput = std::make_unique<std::ofstream>(a_FilePath, std::ios::binary);
|
||||||
|
}
|
||||||
|
|
||||||
|
File::IOInterface(File&& other) :
|
||||||
|
m_FileOutput(std::move(other.m_FileOutput)), m_FileInput(std::move(other.m_FileInput)) {}
|
||||||
|
|
||||||
|
DataBuffer File::Read(std::size_t a_Amount) {
|
||||||
|
DataBuffer buffer;
|
||||||
|
buffer.Resize(a_Amount);
|
||||||
|
assert(m_FileInput != nullptr);
|
||||||
|
m_FileInput->read(reinterpret_cast<char*>(buffer.data()), a_Amount);
|
||||||
|
return buffer;
|
||||||
|
}
|
||||||
|
|
||||||
|
void File::Write(const sp::DataBuffer& a_Data) {
|
||||||
|
assert(m_FileOutput != nullptr);
|
||||||
|
m_FileOutput->write(reinterpret_cast<const char*>(a_Data.data()), a_Data.GetSize());
|
||||||
|
m_FileOutput->flush();
|
||||||
|
}
|
||||||
|
|
||||||
|
} // namespace io
|
||||||
|
} // namespace sp
|
||||||
16
src/sp/io/Memory.cpp
Normal file
16
src/sp/io/Memory.cpp
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
#include <sp/io/Memory.h>
|
||||||
|
|
||||||
|
namespace sp {
|
||||||
|
namespace io {
|
||||||
|
|
||||||
|
sp::DataBuffer Memory::Read(std::size_t a_Amount) {
|
||||||
|
DataBuffer data;
|
||||||
|
m_VirtualIO.ReadSome(data, a_Amount > m_VirtualIO.GetRemaining() ? m_VirtualIO.GetRemaining() : a_Amount);
|
||||||
|
return data;
|
||||||
|
}
|
||||||
|
void Memory::Write(const sp::DataBuffer& a_Data) {
|
||||||
|
m_VirtualIO << a_Data;
|
||||||
|
}
|
||||||
|
|
||||||
|
} // namespace io
|
||||||
|
} // namespace sp
|
||||||
@@ -1,37 +0,0 @@
|
|||||||
#include <sp/misc/Log.h>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#ifdef SP_ANDROID_LOGGING
|
|
||||||
#include <android/log.h>
|
|
||||||
#else
|
|
||||||
#include <iostream>
|
|
||||||
#endif
|
|
||||||
|
|
||||||
namespace sp {
|
|
||||||
namespace utils {
|
|
||||||
|
|
||||||
void LOG(const std::string& msg) {
|
|
||||||
#ifdef SP_ANDROID_LOGGING
|
|
||||||
__android_log_print(ANDROID_LOG_INFO, "TRACKERS", "%s", msg.c_str());
|
|
||||||
#else
|
|
||||||
std::cout << msg << "\n";
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
void LOGD(const std::string& msg) {
|
|
||||||
#if !defined(NDEBUG)
|
|
||||||
LOG(msg);
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
void LOGE(const std::string& err) {
|
|
||||||
#ifdef SP_ANDROID_LOGGING
|
|
||||||
__android_log_print(ANDROID_LOG_ERROR, "TRACKERS", "%s", err.c_str());
|
|
||||||
#else
|
|
||||||
std::cerr << err << "\n";
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
} // namespace utils
|
|
||||||
} // namespace sp
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
#include <sp/misc/Format.h>
|
|
||||||
#include <sp/misc/Log.h>
|
|
||||||
#include <sp/misc/Test.h>
|
|
||||||
|
|
||||||
namespace sp {
|
|
||||||
namespace test {
|
|
||||||
|
|
||||||
void LogAssert(const char* expression, const char* file, int line, const char* function) {
|
|
||||||
utils::LOGE(utils::Format("%s:%i: %s: Assertion failed !", file, line, function));
|
|
||||||
utils::LOGE(utils::Format(" %i |\t%s;", line, expression));
|
|
||||||
}
|
|
||||||
|
|
||||||
} // namespace test
|
|
||||||
} // namespace sp
|
|
||||||
42
test/test_file.cpp
Normal file
42
test/test_file.cpp
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
#include <iostream>
|
||||||
|
|
||||||
|
#include <examples/PacketExample.h>
|
||||||
|
#include <sp/io/File.h>
|
||||||
|
|
||||||
|
class CustomPacketHandler : public sp::PacketHandler {
|
||||||
|
void Handle(const KeepAlivePacket& packet) {
|
||||||
|
std::cout << "KeepAlive handled ! " << packet.GetKeepAliveId() << "\n";
|
||||||
|
}
|
||||||
|
|
||||||
|
void Handle(const DisconnectPacket& packet) {
|
||||||
|
std::cout << "Disconnect handled ! " << packet.GetReason() << "\n";
|
||||||
|
}
|
||||||
|
|
||||||
|
void Handle(const UpgradeTowerPacket& packet) {
|
||||||
|
std::cout << "UpgradeTower handled !\n";
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
using FileStream = sp::io::Stream<sp::io::FileTag, sp::PacketDispatcher, sp::PacketFactory, sp::option::ZlibCompress>;
|
||||||
|
|
||||||
|
int main() {
|
||||||
|
auto handler = std::make_shared<CustomPacketHandler>();
|
||||||
|
|
||||||
|
FileStream stream(sp::io::File{"test.txt", sp::io::FileTag::In | sp::io::FileTag::Out}, {});
|
||||||
|
stream.GetDispatcher().RegisterHandler(PacketId::Disconnect, handler.get());
|
||||||
|
stream.GetDispatcher().RegisterHandler(PacketId::KeepAlive, handler.get());
|
||||||
|
|
||||||
|
stream.SendMessage(KeepAlivePacket{96});
|
||||||
|
stream.SendMessage(KeepAlivePacket{69});
|
||||||
|
stream.SendMessage(DisconnectPacket{
|
||||||
|
"This is in the "
|
||||||
|
"fiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiile !"});
|
||||||
|
stream.GetOption<sp::option::ZlibCompress>().m_Enabled = false;
|
||||||
|
stream.SendMessage(DisconnectPacket{
|
||||||
|
"This is in the "
|
||||||
|
"fiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiile !"});
|
||||||
|
|
||||||
|
stream.RecieveMessages();
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
40
test/test_io.cpp
Normal file
40
test/test_io.cpp
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
#include <iostream>
|
||||||
|
|
||||||
|
#include <examples/PacketExample.h>
|
||||||
|
#include <sp/io/Memory.h>
|
||||||
|
|
||||||
|
using DataBufferStream = sp::io::Stream<sp::io::MemoryTag, sp::PacketDispatcher, sp::PacketFactory>;
|
||||||
|
|
||||||
|
class CustomPacketHandler : public sp::PacketHandler {
|
||||||
|
void Handle(const KeepAlivePacket& packet) {
|
||||||
|
std::cout << "KeepAlive handled ! " << packet.GetKeepAliveId() << "\n";
|
||||||
|
}
|
||||||
|
|
||||||
|
void Handle(const DisconnectPacket& packet) {
|
||||||
|
std::cout << "Disconnect handled ! " << packet.GetReason() << "\n";
|
||||||
|
}
|
||||||
|
|
||||||
|
void Handle(const UpgradeTowerPacket& packet) {
|
||||||
|
std::cout << "UpgradeTower handled !\n";
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
int main() {
|
||||||
|
auto handler = std::make_shared<CustomPacketHandler>();
|
||||||
|
|
||||||
|
DataBufferStream stream;
|
||||||
|
stream.GetDispatcher().RegisterHandler(PacketId::Disconnect, handler.get());
|
||||||
|
|
||||||
|
// this should not be dispatched
|
||||||
|
stream.SendMessage(KeepAlivePacket{96});
|
||||||
|
stream.RecieveMessages();
|
||||||
|
|
||||||
|
stream.GetDispatcher().RegisterHandler(PacketId::KeepAlive, handler.get());
|
||||||
|
|
||||||
|
stream.SendMessage(KeepAlivePacket{69});
|
||||||
|
stream.RecieveMessages();
|
||||||
|
stream.SendMessage(DisconnectPacket{"A valid reason"});
|
||||||
|
stream.RecieveMessages();
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
57
test/test_packets.cpp
Normal file
57
test/test_packets.cpp
Normal file
@@ -0,0 +1,57 @@
|
|||||||
|
#include <iostream>
|
||||||
|
|
||||||
|
#include <examples/PacketExample.h>
|
||||||
|
#include <memory>
|
||||||
|
|
||||||
|
#include <sp/default/DefaultPacketDispatcher.h>
|
||||||
|
#include <sp/extensions/Extensions.h>
|
||||||
|
|
||||||
|
class KeepAliveHandler : public sp::PacketHandler {
|
||||||
|
void Handle(const KeepAlivePacket& packet) {
|
||||||
|
std::cout << "KeepAlive handled !\n";
|
||||||
|
}
|
||||||
|
|
||||||
|
void Handle(const DisconnectPacket& packet) {
|
||||||
|
std::cout << "Disconnect handled !\n";
|
||||||
|
}
|
||||||
|
|
||||||
|
void Handle(const UpgradeTowerPacket& packet) {
|
||||||
|
std::cout << "UpgradeTower handled !\n";
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
int main() {
|
||||||
|
auto upgradeTower = std::make_unique<UpgradeTowerPacket>(std::make_tuple(666, 9));
|
||||||
|
|
||||||
|
sp::PacketMessage* msg = upgradeTower.get();
|
||||||
|
|
||||||
|
auto handler = std::make_shared<KeepAliveHandler>();
|
||||||
|
msg->Dispatch(*handler);
|
||||||
|
|
||||||
|
sp::DataBuffer buffer = msg->Write();
|
||||||
|
|
||||||
|
std::uint8_t msgId;
|
||||||
|
buffer >> msgId;
|
||||||
|
|
||||||
|
auto upgradeTower2 = std::make_unique<UpgradeTowerPacket>();
|
||||||
|
upgradeTower2->Read(buffer);
|
||||||
|
|
||||||
|
std::cout << "Test : " << (unsigned)upgradeTower2->GetTowerId() << "\n";
|
||||||
|
|
||||||
|
sp::PacketFactory factory;
|
||||||
|
auto packet = factory.CreateMessage(msgId);
|
||||||
|
if (packet == nullptr) {
|
||||||
|
std::cout << "Bad ID !\n";
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
std::cout << (unsigned)packet->GetId() << std::endl;
|
||||||
|
packet->Dispatch(*handler);
|
||||||
|
|
||||||
|
sp::PacketDispatcher dispatcher;
|
||||||
|
dispatcher.RegisterHandler(PacketId::KeepAlive, handler.get());
|
||||||
|
dispatcher.Dispatch(*packet);
|
||||||
|
dispatcher.UnregisterHandler(PacketId::KeepAlive, handler.get());
|
||||||
|
dispatcher.UnregisterHandler(handler.get());
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
166
xmake.lua
166
xmake.lua
@@ -2,13 +2,93 @@ add_rules("mode.debug", "mode.release")
|
|||||||
|
|
||||||
set_languages("c++17")
|
set_languages("c++17")
|
||||||
|
|
||||||
add_requires("enet6")
|
local modules = {
|
||||||
|
Compression = {
|
||||||
|
Option = "zlib",
|
||||||
|
Deps = {"zlib"},
|
||||||
|
Includes = {"include/(sp/extensions/Compress.h)"},
|
||||||
|
Sources = {"src/sp/extensions/Compress.cpp"}
|
||||||
|
},
|
||||||
|
TcpSocket = {
|
||||||
|
Option = "tcp",
|
||||||
|
Deps = {},
|
||||||
|
Includes = {"include/(sp/extensions/Tcp.h)", "include/(sp/extensions/tcp/*.h)"},
|
||||||
|
Sources = {"src/sp/extensions/Tcp*.cpp"}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
target("SimpleProtocolLib")
|
|
||||||
add_includedirs("include", {public = true})
|
|
||||||
set_kind("binary")
|
|
||||||
add_files("src/**.cpp")
|
|
||||||
add_packages("enet6", {public = true})
|
-- Map modules to options
|
||||||
|
for name, module in table.orderpairs(modules) do
|
||||||
|
if module.Option then
|
||||||
|
option(module.Option, { description = "Enables the " .. name .. " module", default = true, category = "Modules" })
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
-- Add modules requirements
|
||||||
|
for name, module in table.orderpairs(modules) do
|
||||||
|
if module.Deps then
|
||||||
|
add_requires(module.Deps)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
-- Add modules targets
|
||||||
|
for name, module in table.orderpairs(modules) do
|
||||||
|
if module.Deps and has_config(module.Option) then
|
||||||
|
target("SimpleProtocol-" .. name)
|
||||||
|
add_includedirs("include")
|
||||||
|
for _, include in table.orderpairs(module.Includes) do
|
||||||
|
add_headerfiles(include)
|
||||||
|
end
|
||||||
|
for _, source in table.orderpairs(module.Sources) do
|
||||||
|
add_files(source)
|
||||||
|
end
|
||||||
|
for _, package in table.orderpairs(module.Deps) do
|
||||||
|
add_packages(package)
|
||||||
|
end
|
||||||
|
set_group("Library")
|
||||||
|
set_kind("$(kind)")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
target("SimpleProtocol")
|
||||||
|
add_includedirs("include")
|
||||||
|
add_files("src/sp/**.cpp")
|
||||||
|
set_group("Library")
|
||||||
|
set_kind("$(kind)")
|
||||||
|
|
||||||
|
add_headerfiles("include/(sp/**.h)", "include/(sp/**.inl)")
|
||||||
|
|
||||||
|
-- adding extensions
|
||||||
|
for name, module in table.orderpairs(modules) do
|
||||||
|
if module.Deps and has_config(module.Option) then
|
||||||
|
add_deps("SimpleProtocol-" .. name)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
-- we don't want extensions
|
||||||
|
remove_files("src/sp/extensions/**.cpp")
|
||||||
|
remove_headerfiles("include/(sp/extension/**.h)")
|
||||||
|
|
||||||
|
-- we need this for endian functions
|
||||||
|
if is_os("windows") then
|
||||||
|
add_links("ws2_32")
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -19,79 +99,9 @@ for _, file in ipairs(os.files("test/**.cpp")) do
|
|||||||
set_kind("binary")
|
set_kind("binary")
|
||||||
|
|
||||||
add_files(file)
|
add_files(file)
|
||||||
|
add_includedirs("include")
|
||||||
|
|
||||||
set_default(false)
|
add_deps("SimpleProtocol")
|
||||||
|
|
||||||
add_deps("SimpleProtocolLib")
|
|
||||||
|
|
||||||
add_tests("compile_and_run")
|
add_tests("compile_and_run")
|
||||||
end
|
end
|
||||||
--
|
|
||||||
-- If you want to known more usage about xmake, please see https://xmake.io
|
|
||||||
--
|
|
||||||
-- ## FAQ
|
|
||||||
--
|
|
||||||
-- You can enter the project directory firstly before building project.
|
|
||||||
--
|
|
||||||
-- $ cd projectdir
|
|
||||||
--
|
|
||||||
-- 1. How to build project?
|
|
||||||
--
|
|
||||||
-- $ xmake
|
|
||||||
--
|
|
||||||
-- 2. How to configure project?
|
|
||||||
--
|
|
||||||
-- $ xmake f -p [macosx|linux|iphoneos ..] -a [x86_64|i386|arm64 ..] -m [debug|release]
|
|
||||||
--
|
|
||||||
-- 3. Where is the build output directory?
|
|
||||||
--
|
|
||||||
-- The default output directory is `./build` and you can configure the output directory.
|
|
||||||
--
|
|
||||||
-- $ xmake f -o outputdir
|
|
||||||
-- $ xmake
|
|
||||||
--
|
|
||||||
-- 4. How to run and debug target after building project?
|
|
||||||
--
|
|
||||||
-- $ xmake run [targetname]
|
|
||||||
-- $ xmake run -d [targetname]
|
|
||||||
--
|
|
||||||
-- 5. How to install target to the system directory or other output directory?
|
|
||||||
--
|
|
||||||
-- $ xmake install
|
|
||||||
-- $ xmake install -o installdir
|
|
||||||
--
|
|
||||||
-- 6. Add some frequently-used compilation flags in xmake.lua
|
|
||||||
--
|
|
||||||
-- @code
|
|
||||||
-- -- add debug and release modes
|
|
||||||
-- add_rules("mode.debug", "mode.release")
|
|
||||||
--
|
|
||||||
-- -- add macro definition
|
|
||||||
-- add_defines("NDEBUG", "_GNU_SOURCE=1")
|
|
||||||
--
|
|
||||||
-- -- set warning all as error
|
|
||||||
-- set_warnings("all", "error")
|
|
||||||
--
|
|
||||||
-- -- set language: c99, c++11
|
|
||||||
-- set_languages("c99", "c++11")
|
|
||||||
--
|
|
||||||
-- -- set optimization: none, faster, fastest, smallest
|
|
||||||
-- set_optimize("fastest")
|
|
||||||
--
|
|
||||||
-- -- add include search directories
|
|
||||||
-- add_includedirs("/usr/include", "/usr/local/include")
|
|
||||||
--
|
|
||||||
-- -- add link libraries and search directories
|
|
||||||
-- add_links("tbox")
|
|
||||||
-- add_linkdirs("/usr/local/lib", "/usr/lib")
|
|
||||||
--
|
|
||||||
-- -- add system link libraries
|
|
||||||
-- add_syslinks("z", "pthread")
|
|
||||||
--
|
|
||||||
-- -- add compilation and link flags
|
|
||||||
-- add_cxflags("-stdnolib", "-fno-strict-aliasing")
|
|
||||||
-- add_ldflags("-L/usr/local/lib", "-lpthread", {force = true})
|
|
||||||
--
|
|
||||||
-- @endcode
|
|
||||||
--
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user