UControlChannel

A channel for exchanging connection control messages.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Engine/ControlChannel.h

Include

#include "Engine/ControlChannel.h"

Syntax

class UControlChannel : public UChannel

Remarks

A channel for exchanging connection control messages.

Variables

Name Description

Public variable

bool

 

bNeedsEndianInspection

Used to interrogate the first packet received to determine endianess of the sending client

Public variable

TArray< FQueued...

 

QueuedMessages

Provides an extra buffer beyond RELIABLE_BUFFER for control channel messages as we must be able to guarantee delivery for them because they include package map updates and other info critical to client/server synchronization

Constructors

Name Description

Public function

UControlChannel

(
    const FObjectInitializer& ObjectIn...
)

Public function

UControlChannel

(
    const FObjectInitializer& ObjectIn...
)

Default constructor

Functions

Name Description

Public function

bool

 

CheckEndianess

(
    FInBunch& Bunch
)

Inspects the packet for endianess information.

Public function

void

 

QueueMessage

(
    const FOutBunch* Bunch
)

Adds the given bunch to the QueuedMessages list.

Public function

void

 

ReceiveDestructionInfo

(
    FInBunch& Bunch
)

Handle receiving a destruction message for an actor outside of an actor channel.

Public function

int64

 

SendDestructionInfo

(
    FActorDestructionInfo* Destruc...
)

Sends a message to destroy a specific actor without creating an actor channel.

Overridden from UChannel

Name Description

Public function Virtual Const

bool

 

CanStopTicking()

Always tick the control channel for now.

Public function Virtual

FString

 

Describe()

Describe the text channel.

Public function Virtual

void

 

Init

(
    UNetConnection* InConnection,
    int32 InChIndex,
    EChannelCreateFlags CreateFlags
)

UChannel interface.

Public function Virtual

void

 

ReceivedBunch

(
    FInBunch& Bunch
)

Handle an incoming bunch.

Public function Virtual

FPacketIdRan...

 

SendBunch

(
    FOutBunch* Bunch,
    bool Merge
)

Send a bunch if it's not overflowed, and queue it if it's reliable.

Public function Virtual

void

 

Tick()

Handle time passing on this channel.

Constants

Name

Description

MAX_QUEUED_CONTROL_MESSAGES

Maximum size of additional buffer if this is exceeded as well, we kill the connection.