helper class to move ring buffer implementation details out of template header code.
More...
#include <TcpRingBufferImpl.h>
helper class to move ring buffer implementation details out of template header code.
◆ TcpRingBufferImpl()
AzNetworking::TcpRingBufferImpl::TcpRingBufferImpl |
( |
uint8_t * |
buffer, |
|
|
uint32_t |
bufferSize |
|
) |
| |
Construct with a buffer and size.
- Parameters
-
buffer | input buffer to use as ring-buffer storage |
bufferSize | size of the input buffer in bytes |
◆ AdvanceReadBuffer()
bool AzNetworking::TcpRingBufferImpl::AdvanceReadBuffer |
( |
uint32_t |
numBytes | ) |
|
Advances the ringbuffer read offset by the requested number of bytes.
- Parameters
-
numBytes | number of bytes to advance the ringbuffer read pointer by |
- Returns
- boolean true on success
◆ AdvanceWriteBuffer()
bool AzNetworking::TcpRingBufferImpl::AdvanceWriteBuffer |
( |
uint32_t |
numBytes | ) |
|
Advances the ringbuffer write offset by the requested number of bytes.
- Parameters
-
numBytes | number of bytes to advance the ringbuffer write pointer by |
- Returns
- boolean true on success
◆ GetReadBufferData()
uint8_t * AzNetworking::TcpRingBufferImpl::GetReadBufferData |
( |
| ) |
const |
|
inline |
Returns the start of ringbuffer read memory.
- Returns
- pointer to the start of ringbuffer read memory
◆ GetReadBufferSize()
uint32_t AzNetworking::TcpRingBufferImpl::GetReadBufferSize |
( |
| ) |
const |
|
inline |
Returns the size of ringbuffer read memory in bytes.
- Returns
- the size of ringbuffer read memory in bytes
◆ ReserveBlockForWrite()
uint8_t * AzNetworking::TcpRingBufferImpl::ReserveBlockForWrite |
( |
uint32_t |
numBytes | ) |
|
Returns a pointer into writable memory guaranteed to be of at least numBytes in length.
- Parameters
-
numBytes | maximum number of bytes to be written to the ring-buffer |
- Returns
- pointer to the requested memory, nullptr if the requested size is too large for the ringbuffer to store contiguously
The documentation for this class was generated from the following files:
- Code/Framework/AzNetworking/AzNetworking/TcpTransport/TcpRingBufferImpl.h
- Code/Framework/AzNetworking/AzNetworking/TcpTransport/TcpRingBufferImpl.inl