Navigation
API > API/Runtime > API/Runtime/Sockets
Implements a sender for multichannel TCP sockets.
| Name | FMultichannelTcpSender |
| Type | class |
| Header File | /Engine/Source/Runtime/Sockets/Public/MultichannelTcpSender.h |
| Include Path | #include "MultichannelTcpSender.h" |
Syntax
class FMultichannelTcpSender : public FRunnable
Inheritance Hierarchy
- FRunnable → FMultichannelTcpSender
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMultichannelTcpSender
(
FSocket* InSocket, |
Creates and initializes a new instance. | MultichannelTcpSender.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FMultichannelTcpSender() |
Destructor. | MultichannelTcpSender.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BytesSent | int32 | Holds the total number of payload bytes sent to the socket. | MultichannelTcpSender.h | |
| EventToRestart | FScopedEvent * | Holds an event to trigger when bandwidth has freed up. | MultichannelTcpSender.h | |
| OkToSendDelegate | FOnMultichannelTcpOkToSend | Holds a delegate to be invoked when checking if there is sufficient bandwidth to send. | MultichannelTcpSender.h | |
| SendBuffers | TMap< uint32, TArray< uint8 > * > | Holds the buffers to hold pending per-channel data. | MultichannelTcpSender.h | |
| SendBuffersCriticalSection | FCriticalSection | Holds the critical section to guard the send buffers. | MultichannelTcpSender.h | |
| Socket | FSocket * | Holds the socket to use. | MultichannelTcpSender.h | |
| Thread | FRunnableThread * | Holds the thread that is running this instance. | MultichannelTcpSender.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AttemptResumeSending() |
Call when bandwidth tests should be retried, possibly sending data if there is available bandwidth. | MultichannelTcpSender.h | |
virtual void Exit() |
MultichannelTcpSender.h | ||
int32 GetBytesSent() |
Gets the number of payload bytes actually sent to the socket. | MultichannelTcpSender.h | |
virtual bool Init() |
MultichannelTcpSender.h | ||
virtual uint32 Run() |
MultichannelTcpSender.h | ||
void Send
(
const uint8* Data, |
Sends data through the given channel.This method does not block on bandwidth and never fails. | MultichannelTcpSender.h | |
virtual void Stop() |
MultichannelTcpSender.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AttemptResumeSendingInternal() |
Internal call similar to AttemptResumeSending, but does not do the requisite lock. | MultichannelTcpSender.h |