Navigation
API > API/Runtime > API/Runtime/Engine
FNetPacketNotify - Drives delivery of sequence numbers, acknowledgments and notifications of delivery sequence numbers
| Name | FNetPacketNotify |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/Net/NetPacketNotify.h |
| Include Path | #include "Net/NetPacketNotify.h" |
Syntax
class FNetPacketNotify
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FNetPacketNotify() |
Constructor | Net/NetPacketNotify.h |
Structs
| Name | Remarks |
|---|---|
| FNotificationHeader | |
| FSentAckData |
Enums
Public
| Name | Remarks |
|---|---|
| FNetPacketNotify | |
| FNetPacketNotify |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| AckRecordT | TResizableCircularQueue< FSentAckData, TInlineAllocator< 128 > > | Net/NetPacketNotify.h | |
| SequenceHistoryT | TSequenceHistory< MaxSequenceHistoryLength > | Net/NetPacketNotify.h | |
| SequenceNumberT | TSequenceNumber< SequenceNumberBits, uint16 > | Net/NetPacketNotify.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AckRecord | AckRecordT | Net/NetPacketNotify.h | ||
| InAckSeq | SequenceNumberT | Net/NetPacketNotify.h | ||
| InAckSeqAck | SequenceNumberT | Net/NetPacketNotify.h | ||
| InSeq | SequenceNumberT | Net/NetPacketNotify.h | ||
| InSeqHistory | SequenceHistoryT | Track incoming sequence data. | Net/NetPacketNotify.h | |
| OutAckSeq | SequenceNumberT | Net/NetPacketNotify.h | ||
| OutSeq | SequenceNumberT | Track outgoing sequence data. | Net/NetPacketNotify.h | |
| WaitingForFlushSeqAck | SequenceNumberT | Net/NetPacketNotify.h | ||
| WrittenHistoryWordCount | SIZE_T | Net/NetPacketNotify.h | ||
| WrittenInAckSeq | SequenceNumberT | Net/NetPacketNotify.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AckSeq
(
SequenceNumberT Seq |
Mark Seq as received and update current InSeq, missing sequence numbers will be marked as lost | Net/NetPacketNotify.h | |
bool CanSend() |
If we do have more unacknowledged sequence numbers in-flight than our maximum sendwindow we should not send more as the receiving end will not be able to detect if the sequence number has wrapped around | Net/NetPacketNotify.h | |
SequenceNumberT CommitAndIncrementOutSeq() |
Increment outgoing seq number and commit data | Net/NetPacketNotify.h | |
SequenceNumberT::DifferenceT GetCurrentSequenceHistoryLength() |
Get the current sequenceHistory length in bits, clamped to the maximum history length | Net/NetPacketNotify.h | |
SequenceNumberT GetInAckSeq() |
Get the last received sequence number that we have accepted, InAckSeq cannot be larger than InSeq | Net/NetPacketNotify.h | |
SequenceNumberT GetInSeq() |
Get the last received in sequence number | Net/NetPacketNotify.h | |
const SequenceHistoryT & GetInSeqHistory() |
Get the current SequenceHistory | Net/NetPacketNotify.h | |
SequenceNumberT GetOutAckSeq() |
Get the last outgoing sequence number acknowledged by remote | Net/NetPacketNotify.h | |
SequenceNumberT GetOutSeq() |
Get the current outgoing sequence number | Net/NetPacketNotify.h | |
SequenceNumberT::DifferenceT GetSequenceDelta
(
const FNotificationHeader& NotificationData |
Gets the delta between the present sequence, and the sequence inside the specified header - if the delta is positive | Net/NetPacketNotify.h | |
void Init
(
SequenceNumberT InitialInSeq, |
Init notification with expected initial sequence numbers | Net/NetPacketNotify.h | |
bool IsSequenceWindowFull
(
uint32 SafetyMargin |
Return whether we can send packets without exhausting the packet sequence history window, as it could cause packets to be NAKed even when they've been received by the remote peer. | Net/NetPacketNotify.h | |
bool IsWaitingForSequenceHistoryFlush() |
Returns true if we are currently waiting for a flush of the sequence window | Net/NetPacketNotify.h | |
void NakSeq
(
SequenceNumberT Seq |
Explicitly mark Seq as not received and update current InSeq, additional missing sequence numbers will be marked as lost | Net/NetPacketNotify.h | |
bool ReadHeader
(
FNotificationHeader& Data, |
Read header from stream | Net/NetPacketNotify.h | |
SequenceNumberT::DifferenceT Update
(
const FNotificationHeader& NotificationData, |
Update state of PacketNotification based on received header and invoke packet notifications for received acks. | Net/NetPacketNotify.h | |
bool WriteHeader
(
FBitWriter& Writer, |
Write NotificationHeader, and update outgoing ack record if bRefresh is true we will attempt to refresh a previously written header if the resulting size will be the same as the already written header. | Net/NetPacketNotify.h |