1. Epic GamesDeveloper
  3. IWebSocket

IWebSocket

Unreal Engine C++ API Reference > Runtime > WebSockets

References

   
Module WebSockets
Header /Engine/Source/Runtime/Online/WebSockets/Public/IWebSocket.h
Include #include "IWebSocket.h"

Syntax

class IWebSocket

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

Close ( int32 Code,
const FString& Reason
)

 Close the current connection.
Public function void

Connect ()

 Initiate a client connection to the server.
Public function bool Inquire if this web socket instance is connected to a server.
Public function FWebSocketBinaryMessageEvent &  
Public function FWebSocketClosedEvent &  
Public function FWebSocketConnectedEvent &  
Public function FWebSocketConnectionErrorEvent &  
Public function FWebSocketMessageEvent &  
Public function FWebSocketMessageSentEvent &  
Public function FWebSocketRawMessageEvent &  
Public function void

Send ( const FString& Data
)

 Transmit data over the connection.
Public function void

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

 Transmit data over the connection.
Public function void

SetTextMessageMemoryLimit ( uint64 TextMessageMemoryLimit
)

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

Classes

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page