FNetPacketNotify

[FNetPacketNotify](API\Runtime\Engine\Net\FNetPacketNotify) - Drives delivery of sequence numbers, acknowledgments and notifications of delivery sequence numbers

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/Net/NetPacketNotify.h

Include

#include "Net/NetPacketNotify.h"

Syntax

class FNetPacketNotify

Remarks

FNetPacketNotify - Drives delivery of sequence numbers, acknowledgments and notifications of delivery sequence numbers

Constructors

Name Description

Public function

FNetPacketNotify()

Constructor

Functions

Name Description

Public function

void

 

AckSeq

(
    SequenceNumberT Seq
)

Mark Seq as received and update current InSeq, missing sequence numbers will be marked as lost

Public function Const

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

Public function

SequenceNumb...

 

CommitAndIncrementOutSeq()

Increment outgoing seq number and commit data

Public function Const

SIZE_T

 

GetCurrentSequenceHistoryLength()

Get the current sequenceHistory length in bits

Public function Const

SequenceNumb...

 

GetInAckSeq()

Get the last received sequence number that we have accepted, InAckSeq cannot be larger than InSeq

Public function Const

SequenceNumb...

 

GetInSeq()

Get the last received in sequence number

Public function Const

const Sequen...

 

GetInSeqHistory()

Get the current SequenceHistory

Public function Const

SequenceNumb...

 

GetOutAckSeq()

Get the last outgoing sequence number acknowledged by remote

Public function Const

SequenceNumb...

 

GetOutSeq()

Get the current outgoing sequence number

Public function

SequenceNumb...

 

GetSequenceDelta

(
    const FNotificationHeader& Notific...
)

Gets the delta between the present sequence, and the sequence inside the specified header - if the delta is positive

Public function

void

 

Init

(
    SequenceNumberT InitialInSeq,
    SequenceNumberT InitialOutSeq
)

Init notification with expected initial sequence numbers

Public function

void

 

NakSeq

(
    SequenceNumberT Seq
)

Explicitly mark Seq as not received and update current InSeq, additional missing sequence numbers will be marked as lost

Public function Const

bool

 

ReadHeader

(
    FNotificationHeader& Data,
    FBitReader& Reader
)

Read header from stream

Public function

SequenceNumb...

 

Update

(
    const FNotificationHeader& Notific...,
    Functor&& InFunc
)

Update state of PacketNotification based on received header and invoke packet notifications for received acks.

Public function

bool

 

WriteHeader

(
    FBitWriter& Writer,
    bool bRefresh
)

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.

Classes

Name

Description

Public struct

FNotificationHeader

Typedefs

Constants

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss