1. Epic GamesDeveloper
  3. UChannel

UChannel

Base class of communication channels.

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Engine

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Engine/Channel.h
Include #include "Engine/Channel.h"

Syntax

class UChannel : public UObject

Remarks

Base class of communication channels.

Variables

  Type Name Description
Public variable uint32: 1 bIsInDormancyHysteresis  
Public variable uint32: 1 bOpenedForCheckpoint  
Public variable uint32: 1 bPausedUntilReliableACK  
Public variable uint32: 1 bPendingDormancy  
Public variable uint32: 1 bPooled  
Public variable uint32: 1 Broken  
Public variable uint32: 1 bTornOff  
Public variable int32 ChIndex  
Public variable FName ChName  
Public variable uint32: 1 Closing  
Public variable TObjectPtr< class UNetConnection > Connection  
Public variable uint32: 1 Dormant  
Public variable FInBunch * InPartialBunch  
Public variable FInBunch * InRec  
Public variable int32 NumInRec  
Public variable int32 NumOutRec  
Public variable uint32: 1 OpenAcked Variables.
Public variable uint32: 1 OpenedLocally  
Public variable FPacketIdRange OpenPacketId  
Public variable uint32: 1 OpenTemporary  
Public variable FOutBunch * OutRec  
Public variable uint32: 1 SentClosingBunch  

Functions

  Type Name Description
Public function Virtual void Notification that this channel has been placed in a channel pool and needs to reset to its original state so it can be used again like a new channel
Public function Virtual void

AppendExportBunches ( TArray< FOutBunch* >& OutExportBunches
)

 Append any export bunches
Public function Virtual void Append any "must be mapped" guids to front of bunch.
Public function void Make sure the incoming buffer is in sequence and there are no duplicates.
Protected function Virtual void Closes the actor channel but with a 'dormant' flag set so it can be reopened
Public function Virtual Const bool Return true to indicate that this channel no longer needs to Tick() every frame.
Protected function Virtual bool

CleanUp ( const bool bForDestroy,
EChannelCloseReason CloseReason
)

 Cleans up channel structures and nulls references to the channel
Public function Virtual int64

Close ( EChannelCloseReason Reason
)

 Close the base channel. Returns how many bits were written to the send buffer
Public function void

ConditionalCleanUp ( const bool bForDestroy,
EChannelCloseReason CloseReason
)

 Cleans up channel if it hasn't already been
Public function Virtual FString Describe the channel.
Public function Virtual void

Init ( UNetConnection* InConnection,
int32 InChIndex,
EChannelCreateFlags CreateFlags
)

 UChannel interface.
Public function int32

IsNetReady ( bool Saturate
)

 Return whether this channel is ready for sending.
Public function Virtual bool

ReadyForDormancy ( bool suppressLogs
)

 Returns true if channel is ready to go dormant (e.g., all outstanding property updates have been ACK'd)
Public function Virtual void

ReceivedAck ( int32 AckPacketId
)

 Positive acknowledgment processing.
Public function void Handle an acknowledgment on this channel. Note: Channel might be closed/cleaned-up by this call.
Public function bool

ReceivedAcks ( EChannelCloseReason& OutCloseReason
)

 General channel functions.
Public function Virtual void

ReceivedBunch ( FInBunch& Bunch
)

 Handle an incoming bunch.
Public function Virtual void

ReceivedNak ( int32 NakPacketId
)

 Negative acknowledgment processing.
Public function void

ReceivedRawBunch ( FInBunch& Bunch,
bool& bOutSkipAck
)

 Process a raw, possibly out-of-sequence bunch: either queue it or dispatch it.
Public function bool Process a properly-sequenced bunch.
Public function Virtual FPacketIdRange

SendBunch ( FOutBunch* Bunch,
bool Merge
)

 Send a bunch if it's not overflowed, and queue it if it's reliable.
Public function Virtual void Set the closing flag.
Public function Virtual void Puts the channel in a state to start becoming dormant.
Public function Virtual void

Tick ()

 Handle time passing on this channel.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

  Type Name Description
Public variable uint32: 1 bIsReplicationPaused Replication pausing is deprecated and will be removed

Deprecated Functions

  Type Name Description
Protected function Virtual bool Replication pausing is deprecated and will be removed
Public function void Will be removed from test/shipping in the future.
Protected function Virtual void

SetReplicationPaused ( bool InbIsReplicationPaused
)

 Replication pausing is deprecated and will be removed

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page