UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FMultichannelTcpReceiver Class Reference

#include <MultichannelTcpReceiver.h>

+ Inheritance diagram for FMultichannelTcpReceiver:

Public Member Functions

 FMultichannelTcpReceiver (FSocket *InSocket, const FOnMultichannelTcpReceive &InReceiveDelegate)
 
 ~FMultichannelTcpReceiver ()
 
int32 GetBytesReceived ()
 
virtual bool Init ()
 
virtual uint32 Run ()
 
virtual void Stop ()
 
virtual void Exit ()
 
- Public Member Functions inherited from FRunnable
virtual class FSingleThreadRunnableGetSingleThreadInterface ()
 
virtual ~FRunnable ()
 

Detailed Description

Implements a receiver for multichannel TCP sockets.

Constructor & Destructor Documentation

◆ FMultichannelTcpReceiver()

FMultichannelTcpReceiver::FMultichannelTcpReceiver ( FSocket InSocket,
const FOnMultichannelTcpReceive InReceiveDelegate 
)
inline

Creates and initializes a new instance.

Parameters
InSocketThe socket to receive from.
InReceiveDelegateDelete to handle data as it becomes available, called from the receive thread.

◆ ~FMultichannelTcpReceiver()

FMultichannelTcpReceiver::~FMultichannelTcpReceiver ( )
inline

Destructor.

Member Function Documentation

◆ Exit()

virtual void FMultichannelTcpReceiver::Exit ( void  )
inlinevirtual

Exits the runnable object.

Called in the context of the aggregating thread to perform any cleanup.

See also
Init, Run, Stop

Reimplemented from FRunnable.

◆ GetBytesReceived()

int32 FMultichannelTcpReceiver::GetBytesReceived ( )
inline

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

◆ Init()

virtual bool FMultichannelTcpReceiver::Init ( void  )
inlinevirtual

Initializes the runnable object.

This method is called in the context of the thread object that aggregates this, not the thread that passes this runnable to a new thread.

Returns
True if initialization was successful, false otherwise
See also
Run, Stop, Exit

Reimplemented from FRunnable.

◆ Run()

virtual uint32 FMultichannelTcpReceiver::Run ( )
inlinevirtual

Runs the runnable object.

This is where all per object thread work is done. This is only called if the initialization was successful.

Returns
The exit code of the runnable object
See also
Init, Stop, Exit

Implements FRunnable.

◆ Stop()

virtual void FMultichannelTcpReceiver::Stop ( void  )
inlinevirtual

Stops the runnable object.

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

See also
Init, Run, Exit

Reimplemented from FRunnable.


The documentation for this class was generated from the following file: