1. Epic GamesDeveloper
  3. IWebSocket

IWebSocket

API > API/Runtime > API/Runtime/WebSockets

   
Name IWebSocket
Type class
Header File /Engine/Source/Runtime/Online/WebSockets/Public/IWebSocket.h
Include Path #include "IWebSocket.h"

Syntax

class IWebSocket

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IWebSocket()

   IWebSocket.h  

Classes

Name Remarks
FWebSocketBinaryMessageEvent Delegate called when web socket binary data has been received.
FWebSocketClosedEvent Delegate called when a web socket connection has been closed.
FWebSocketConnectedEvent Delegate called when a web socket connection has been established successfully.
FWebSocketConnectionErrorEvent Delegate called when a web socket connection could not be established.
FWebSocketMessageEvent Delegate called when a web socket text message has been received.
FWebSocketMessageSentEvent Delegate called when a web socket text message has been sent. Assume UTF-8 encoding.
FWebSocketRawMessageEvent Delegate called when any web socket data has been received.

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Close ( int32 Code,
const FString& Reason
)

 Close the current connection. IWebSocket.h  

void Connect ()

 Initiate a client connection to the server. IWebSocket.h  

bool IsConnected()

 Inquire if this web socket instance is connected to a server. IWebSocket.h  

FWebSocketBinaryMessageEvent & OnBinaryMessage()

   IWebSocket.h  

FWebSocketClosedEvent & OnClosed()

   IWebSocket.h  

FWebSocketConnectedEvent & OnConnected()

   IWebSocket.h  

FWebSocketConnectionErrorEvent & OnConnectionError()

   IWebSocket.h  

FWebSocketMessageEvent & OnMessage()

   IWebSocket.h  

FWebSocketMessageSentEvent & OnMessageSent()

   IWebSocket.h  

FWebSocketRawMessageEvent & OnRawMessage()

   IWebSocket.h  

void Send ( const FString& Data
)

 Transmit data over the connection. IWebSocket.h  

void Send ( const void* Data,
SIZE_T Size,
bool bIsBinary
)

 Transmit data over the connection. IWebSocket.h  

void SetTextMessageMemoryLimit ( uint64 TextMessageMemoryLimit
)

 Optionally change memory limit for receiving UTF-8 text on this socket. IWebSocket.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page