12 #ifndef NETWORK_CORE_PACKET_H
13 #define NETWORK_CORE_PACKET_H
18 #include "../../string_type.h"
43 static constexpr
size_t EncodedLengthOfPacketSize() {
return sizeof(
PacketSize); }
44 static constexpr
size_t EncodedLengthOfPacketType() {
return sizeof(
PacketType); }
71 std::span<const uint8_t>
Send_bytes(
const std::span<const uint8_t> span);
112 if (amount == 0)
return 0;
114 assert(this->pos < this->
buffer.size());
115 assert(this->pos + amount <= this->
buffer.size());
117 const char *output_buffer =
reinterpret_cast<const char*
>(this->buffer.data() + this->
pos);
118 ssize_t bytes = transfer_function(destination, output_buffer,
static_cast<A
>(amount), std::forward<Args>(args)...);
119 if (bytes > 0) this->pos += bytes;
138 template <
typename A = size_t,
typename F,
typename D,
typename ... Args>
139 ssize_t
TransferOut(F transfer_function, D destination, Args&& ... args)
141 return TransferOutWithLimit<A>(transfer_function, std::numeric_limits<size_t>::max(), destination, std::forward<Args>(args)...);
173 template <
typename A = size_t,
typename F,
typename S,
typename ... Args>
174 ssize_t
TransferIn(F transfer_function, S source, Args&& ... args)
177 if (amount == 0)
return 0;
179 assert(this->pos < this->
buffer.size());
180 assert(this->pos + amount <= this->
buffer.size());
182 char *input_buffer =
reinterpret_cast<char*
>(this->buffer.data() + this->
pos);
183 ssize_t bytes = transfer_function(source, input_buffer,
static_cast<A
>(amount), std::forward<Args>(args)...);
184 if (bytes > 0) this->pos += bytes;
SocketHandler for all network sockets in OpenTTD.
Configuration options of the network stuff.
static const size_t COMPAT_MTU
Number of bytes we can pack in a single packet for backward compatibility.
Base for all network types (UDP and TCP)
fluid_settings_t * settings
FluidSynth settings handle.
Network stuff has many things that needs to be included and/or implemented by default.
uint8_t PacketType
Identifier for the packet.
uint16_t PacketSize
Size of the whole packet.
StringValidationSettings
Settings for the string validation.
@ SVS_REPLACE_WITH_QUESTION_MARK
Replace the unknown/bad bits with question marks.
Internal entity of a packet.
size_t Size() const
Get the number of bytes in the packet.
uint16_t Recv_uint16()
Read a 16 bits integer from the packet.
ssize_t TransferOutWithLimit(F transfer_function, size_t limit, D destination, Args &&... args)
Transfer data from the packet to the given function.
size_t Recv_bytes(std::span< uint8_t > span)
Extract at most the length of the span bytes from the packet into the span.
uint64_t Recv_uint64()
Read a 64 bits integer from the packet.
bool Recv_bool()
Read a boolean from the packet.
uint32_t Recv_uint32()
Read a 32 bits integer from the packet.
NetworkSocketHandler * cs
Socket we're associated with.
void Send_bool(bool data)
Package a boolean in the packet.
bool PrepareToRead()
Prepares the packet so it can be read.
PacketType GetPacketType() const
Get the PacketType from this packet.
PacketSize pos
The current read/write position in the packet.
std::span< const uint8_t > Send_bytes(const std::span< const uint8_t > span)
Send as many of the bytes as possible in the packet.
size_t limit
The limit for the packet size.
bool HasPacketSizeData() const
Check whether the packet, given the position of the "write" pointer, has read enough of the packet to...
uint8_t Recv_uint8()
Read a 8 bits integer from the packet.
bool ParsePacketSize()
Reads the packet size from the raw packet and stores it in the packet->size.
std::vector< uint8_t > buffer
The buffer of this packet.
ssize_t TransferIn(F transfer_function, S source, Args &&... args)
Transfer data from the given function into the packet.
void PrepareToSend()
Writes the packet size from the raw packet from packet->size.
void Send_uint8(uint8_t data)
Package a 8 bits integer in the packet.
size_t RemainingBytesToTransfer() const
Get the amount of bytes that are still available for the Transfer functions.
void Send_uint32(uint32_t data)
Package a 32 bits integer in the packet.
ssize_t TransferOut(F transfer_function, D destination, Args &&... args)
Transfer data from the packet to the given function.
void Send_buffer(const std::vector< uint8_t > &data)
Copy a sized byte buffer into the packet.
std::vector< uint8_t > Recv_buffer()
Extract a sized byte buffer from the packet.
Packet(NetworkSocketHandler *cs, size_t limit, size_t initial_read_size=EncodedLengthOfPacketSize())
Create a packet that is used to read from a network socket.
void Send_uint16(uint16_t data)
Package a 16 bits integer in the packet.
bool CanReadFromPacket(size_t bytes_to_read, bool close_connection=false)
Is it safe to read from the packet, i.e.
bool CanWriteToPacket(size_t bytes_to_write)
Is it safe to write to the packet, i.e.
std::string Recv_string(size_t length, StringValidationSettings settings=SVS_REPLACE_WITH_QUESTION_MARK)
Reads characters (bytes) from the packet until it finds a '\0', or reaches a maximum of length charac...
void Send_string(const std::string_view data)
Sends a string over the network.
void Send_uint64(uint64_t data)
Package a 64 bits integer in the packet.