Public Types | |
| using | Ptr = std::shared_ptr< Message > |
 Public Types inherited from Cogs::Memory::MemoryBuffer | |
| enum class | Anchor { Start , Current , End } |
Public Member Functions | |
| Message () | |
| Constructs a new Message instance. | |
| Message (uint32_t id, const Message &message) | |
| Constructs a Message instance that borrows the MemoryBuffer owned by the message passed to this function. | |
| Message (const Message &src)=delete | |
| uint32_t | getID () const |
| Public Member Functions inherited from Cogs::Memory::MemoryBuffer | |
| MemoryBuffer (MemBlockType type) | |
| MemoryBuffer (size_t size, MemBlockType type) | |
| MemoryBuffer (size_t size, bool onlyReserve=false, MemBlockType type=MemBlockType::Block) | |
| MemoryBuffer (Allocator *allocator, MemBlockType type=MemBlockType::Block) | |
| MemoryBuffer (size_t size, Allocator *allocator, MemBlockType type=MemBlockType::Block) | |
| MemoryBuffer (const void *memory, size_t size) | |
| MemoryBuffer (MemoryBuffer &&other) noexcept | |
| MemoryBuffer & | operator= (MemoryBuffer &&other) noexcept |
| MemoryBuffer (const MemoryBuffer &)=delete | |
| MemoryBuffer & | operator= (const MemoryBuffer &)=delete |
| void | changeType (MemBlockType newType) |
| void | reset (size_t size, Allocator *allocator) |
| bool | resize (size_t size, bool keep=true, bool forceRealloc=false) |
| bool | reserve (size_t size) |
| void | copy (const MemoryBuffer &other) |
| void | clear () |
| void * | data () |
| const void * | data () const |
| void * | dataFromPos () |
| const void * | dataFromPos () const |
| size_t | size () const |
| bool | empty () const |
| void * | grow (size_t bytes) |
| void | swap (MemoryBuffer &other) |
| const Allocator * | getAllocator () const |
| size_t | read (void *buffer, size_t noofbytes) |
| uint8_t | read8 () |
| uint16_t | read16 () |
| uint32_t | read32 () |
| uint64_t | read64 () |
| float | readFloat () |
| double | readDouble () |
| glm::vec2 | readFloat2 () |
| glm::vec3 | readFloat3 () |
| glm::vec4 | readFloat4 () |
| glm::quat | readQuaternion () |
| glm::mat4 | readMatrix () |
| std::string | readString () |
| bool | write (const void *buffer, size_t noofbytes) |
| bool | write8 (uint8_t value) |
| bool | write16 (uint16_t value) |
| bool | write32 (uint32_t value) |
| bool | write64 (uint64_t value) |
| bool | writeFloat (float value) |
| bool | writeDouble (double value) |
| bool | writeFloat2 (const glm::vec2 &value) |
| bool | writeFloat3 (const glm::vec3 &value) |
| bool | writeFloat4 (const glm::vec4 &value) |
| bool | writeQuaternion (const glm::quat &value) |
| bool | writeMatrix (const glm::mat4 &value) |
| bool | writeString (const StringView &str) |
| void | seek (int64_t offset, Anchor from) |
| size_t | pos () const |
| size_t | unreadSize () const |
| bool | areContentsEqual (const MemoryBuffer &rhs) const |
Static Public Member Functions | |
| static Ptr | allocate (uint32_t id) |
| Retrieves an existing message from the pool, or creates a new one if the pool is empty. | |
| static Ptr | duplicate (const Message &src) |
| Duplicates the provided message. | |
| static void | flush () |
| Flushes any messages pooled for reuse. | |
Private Types | |
| using | Pool = std::vector< Message * > |
Private Member Functions | |
| Message (Message &&)=delete | |
| Message & | operator= (const Message &)=delete |
| Message & | operator= (Message &&)=delete |
Static Private Member Functions | |
| static void | deleteMessage (Message *msg) |
| Deleter function called by shared_ptr when the last reference to message is destroyed. | |
Private Attributes | |
| uint32_t | identifier = 0 |
Static Private Attributes | |
| static Pool | messagePool |
| static Mutex | mutex |
Friends | |
| class | MessageHub |
Detailed Description
Member Typedef Documentation
◆ Pool
|
private |
◆ Ptr
| using Cogs::Network::Message::Ptr = std::shared_ptr<Message> |
Constructor & Destructor Documentation
◆ Message() [1/2]
| Cogs::Network::Message::Message | ( | ) |
Constructs a new Message instance.
Called by allocate when no messages are available in the pool. The new message will have 1KB of payload memory reserved automatically. *============================================================================================
Definition at line 51 of file Message.cpp.
Referenced by allocate().
◆ Message() [2/2]
| Cogs::Network::Message::Message | ( | uint32_t | id, |
| const Message & | message | ||
| ) |
Constructs a Message instance that borrows the MemoryBuffer owned by the message passed to this function.
This overload is used when processing messages to provide a hub-independent view into the message payload. *============================================================================================
Definition at line 59 of file Message.cpp.
Member Function Documentation
◆ allocate()
|
static |
Retrieves an existing message from the pool, or creates a new one if the pool is empty.
*============================================================================================
Definition at line 9 of file Message.cpp.
References deleteMessage(), and Message().
Referenced by Cogs::Network::ConnectionHub::processIncoming().
◆ deleteMessage()
|
staticprivate |
Deleter function called by shared_ptr when the last reference to message is destroyed.
This function returns the message object to the pool for reuse. The message destructor will not be called to ensure memory allocated for message payloads is retained and reused. *============================================================================================
Definition at line 68 of file Message.cpp.
Referenced by allocate().
◆ duplicate()
|
static |
Duplicates the provided message.
*============================================================================================
Definition at line 28 of file Message.cpp.
◆ flush()
|
static |
Flushes any messages pooled for reuse.
Typically called during application shutdown. *============================================================================================
Definition at line 38 of file Message.cpp.
◆ getID()
Friends And Related Function Documentation
◆ MessageHub
|
friend |
Member Data Documentation
◆ identifier
◆ messagePool
|
staticprivate |
◆ mutex
The documentation for this class was generated from the following files:
- D:/a/1/s/Cogs/Cogs.Foundation/Source/Network/Message.h
- D:/a/1/s/Cogs/Cogs.Foundation/Source/Network/Message.cpp
