1. Epic GamesDeveloper
  3. IBackChannelSocketConnection

IBackChannelSocketConnection

Base class that describes a back-channel connection.

API > API/Plugins > API/Plugins/BackChannel

Base class that describes a back-channel connection. The underlying behavior will depend on the type of connection that was requested from the factory

   
Name IBackChannelSocketConnection
Type class
Header File /Engine/Plugins/Experimental/BackChannel/Source/BackChannel/Public/BackChannel/Transport/IBackChannelSocketConnection.h
Include Path #include "BackChannel/Transport/IBackChannelSocketConnection.h"

Syntax

class IBackChannelSocketConnection

Constructors

Name Remarks Include Path Unreal Specifiers

IBackChannelSocketConnection()

   BackChannel/Transport/IBackChannelSocketConnection.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IBackChannelSocketConnection()

   BackChannel/Transport/IBackChannelSocketConnection.h  

Structs

Name Remarks
FConnectionStats  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Close()

 Close the connection BackChannel/Transport/IBackChannelSocketConnection.h  

bool Connect ( const TCHAR* InEndPoint
)

 Todo (agrant 2017/12/29): Should remove 'Connect' and instead return a connected (or null..) socket from the factory Start connecting to the specified port for incoming connections. BackChannel/Transport/IBackChannelSocketConnection.h  

const FConnectionStats & GetConnectionStats()

 Return stats about this connection BackChannel/Transport/IBackChannelSocketConnection.h  

FString GetDescription()

 Return the underlying socket (if any) for this connection BackChannel/Transport/IBackChannelSocketConnection.h  

uint32 GetPacketsReceived()

 Todo - Proper stats BackChannel/Transport/IBackChannelSocketConnection.h  

FSocket * GetSocket()

 Return the underlying socket (if any) for this connection BackChannel/Transport/IBackChannelSocketConnection.h  

bool IsConnected()

 Returns true if this connection is connected to another BackChannel/Transport/IBackChannelSocketConnection.h  

bool IsListening()

 Returns true if this connection is currently listening for incoming connections BackChannel/Transport/IBackChannelSocketConnection.h  

bool Listen ( const int16 Port
)

 Start listening on the specified port for incoming connections. BackChannel/Transport/IBackChannelSocketConnection.h  

int32 ReceiveData ( void* OutBuffer,
const int32 BufferSize
)

 Receive data from our connection. BackChannel/Transport/IBackChannelSocketConnection.h  

int32 SendData ( const void* InData,
const int32 InSize
)

 Send data via our connection BackChannel/Transport/IBackChannelSocketConnection.h  

void SetBufferSizes ( int32 DesiredSendSize,
int32 DesiredReceiveSize
)

 Set the specified send and receive buffer sizes, if supported BackChannel/Transport/IBackChannelSocketConnection.h  

bool WaitForConnection ( double InTimeout,
TFunction< bool(TSharedRef< IBackChannelSocketConnection >)> InDelegate
)

 Waits for an icoming or outgoing connection to be made BackChannel/Transport/IBackChannelSocketConnection.h  

Protected

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page