FMultichannelTcpSender

Implements a sender for multichannel TCP sockets.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FRunnable

FMultichannelTcpSender

References

Module

Sockets

Header

/Engine/Source/Runtime/Sockets/Public/MultichannelTcpSender.h

Include

#include "MultichannelTcpSender.h"

Syntax

class FMultichannelTcpSender : public FRunnable

Remarks

Implements a sender for multichannel TCP sockets.

Constructors

Name Description

Public function

FMultichannelTcpSender

(
    FSocket* InSocket,
    const FOnMultichannelTcpOkToSend& ...
)

Creates and initializes a new instance.

Destructors

Name Description

Public function

~FMultichannelTcpSender()

Destructor.

Functions

Name Description

Public function

void

 

AttemptResumeSending()

Call when bandwidth tests should be retried, possibly sending data if there is available bandwidth.

Protected function

void

 

AttemptResumeSendingInternal()

Internal call similar to AttemptResumeSending, but does not do the requisite lock.

Public function

int32

 

GetBytesSent()

Gets the number of payload bytes actually sent to the socket.

Public function

void

 

Send

(
    const uint8* Data,
    int32 Count,
    uint32 Channel
)

Sends data through the given channel.

This method does not block on bandwidth and never fails.

Overridden from FRunnable

Name Description

Public function Virtual

void

 

Exit()

Exits the runnable object.

Public function Virtual

bool

 

Init()

Initializes the runnable object.

Public function Virtual

uint32

 

Run()

Runs the runnable object.

Public function Virtual

void

 

Stop()

Stops the runnable object.

This is called if a thread is requested to terminate early.

Constants

Name

Description

MaxPacket

Defines the maximum payload size per packet (in bytes).