FMultichannelTcpSocket Class Reference

#include <MultichannelTcpSocket.h>

Public Member Functions
	FMultichannelTcpSocket (FSocket *InSocket, uint64 InBandwidthLatencyProduct)
int32	BlockingReceive (uint8 *Data, int32 Count, uint32 Channel)
int32	DataAvailable (uint32 Channel)
int32	PollingReceive (uint8 *Data, int32 MaxCount, uint32 Channel)
void	Send (const uint8 *Data, int32 Count, uint32 Channel)

Detailed Description

Class to multiplex several streams on a single TCP socket.

The primary feature here is to allow blocking reads to multiple channels simultaneously without interference. Generally one of these is created on both sides of the connection, immediately after the connection is established

Constructor & Destructor Documentation

FMultichannelTcpSocket()

FMultichannelTcpSocket::FMultichannelTcpSocket ( FSocket *  InSocket, uint64  InBandwidthLatencyProduct  )

inline

Creates and initializes a new instance.

Parameters

InSocket	The underlying socket to use.
InBandwidthLatencyProduct	The maximum amount of unacknowledged data to send.

Member Function Documentation

BlockingReceive()

int32 FMultichannelTcpSocket::BlockingReceive ( uint8 *  Data, int32  Count, uint32  Channel  )

inline

Block until data is available to receive.

Can be called from any thread, but not multiple threads for one channel at once.

Parameters

Data	The buffer to fill.
Count	The number of bytes to receive.
Channel	The channel to receive on.

DataAvailable()

int32 FMultichannelTcpSocket::DataAvailable ( uint32  Channel )

inline

Non-blocking test of available data.

Can be called from any thread, but realize that if this returns > 0, another thread could steal the data.

Parameters

Channel

The channel to check.

Returns

The number of bytes in the receive buffer.

PollingReceive()

int32 FMultichannelTcpSocket::PollingReceive ( uint8 *  Data, int32  MaxCount, uint32  Channel  )

inline

Non-blocking return of available data.

Can be called from any thread, but realize that multiple threads hammering a channel at once is unlikely to give useful results.

Parameters

Data	The buffer to hold the results, if any.
MaxCount	the number of bytes in the receive buffer.
Channel	The channel to check.

Returns

The number of bytes written into Data.

Send()

void FMultichannelTcpSocket::Send ( const uint8 *  Data, int32  Count, uint32  Channel  )

inline

Send data out a given channel, this does not block on bandwidth, and never fails.

Can be called from any thread, but if you are calling from multiple threads, make sure you are sending an atomic unit.

Parameters

Data	The buffer containing the data to send.
Count	The number of bytes to send.
Channel	The channel to send on.

---

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

• Engine/Source/Runtime/Sockets/Public/MultichannelTcpSocket.h