packet header class.
More...
#include <TcpPacketHeader.h>
Inherits AzNetworking::IPacketHeader.
◆ TcpPacketHeader()
AzNetworking::TcpPacketHeader::TcpPacketHeader |
( |
PacketType |
packetType, |
|
|
uint16_t |
packetSize |
|
) |
| |
|
inline |
Construct with a packet type and size.
- Parameters
-
packetType | type of packet |
packetSize | size of the packet in bytes, not including header size |
◆ GetPacketId()
PacketId AzNetworking::TcpPacketHeader::GetPacketId |
( |
| ) |
const |
|
inlineoverridevirtual |
◆ GetPacketSize()
uint16_t AzNetworking::TcpPacketHeader::GetPacketSize |
( |
| ) |
const |
|
inline |
Gets the size of the packet being received.
- Returns
- size of the packet in bytes, not including header size
◆ GetPacketType()
PacketType AzNetworking::TcpPacketHeader::GetPacketType |
( |
| ) |
const |
|
inlineoverridevirtual |
◆ IsPacketFlagSet()
bool AzNetworking::TcpPacketHeader::IsPacketFlagSet |
( |
PacketFlag |
flag | ) |
const |
|
inlineoverridevirtual |
Returns if the specified packet flag is set for this packet.
- Returns
- true if the flag is set for this packet
Implements AzNetworking::IPacketHeader.
◆ Serialize()
bool AzNetworking::TcpPacketHeader::Serialize |
( |
ISerializer & |
serializer | ) |
|
Base serialize method for all serializable structures or classes to implement.
- Parameters
-
serializer | ISerializer instance to use for serialization |
- Returns
- boolean true for success, false for serialization failure
◆ SetPacketFlag()
void AzNetworking::TcpPacketHeader::SetPacketFlag |
( |
PacketFlag |
flag, |
|
|
bool |
value |
|
) |
| |
|
inlineoverridevirtual |
The documentation for this class was generated from the following files:
- Code/Framework/AzNetworking/AzNetworking/TcpTransport/TcpPacketHeader.h
- Code/Framework/AzNetworking/AzNetworking/TcpTransport/TcpPacketHeader.inl