Websocket.md

UEWebsocket

unreal engine 4 websocket plugin(support ssl) for both c++ and blueprint developer.

This plugin is for unreal engine 4 c++ and blueprint developers, you can easily use c++ or blueprint to connect to remote server and send receive messages.

Supported Platform

★ 1. Win64

★ 3. Android

★ 4. IOS

★ 7. Win32

Usage

Blueprint

★ Connect To Server

★ Bind Event, Send And Receive Data

★ ssl support

this plugin support wss, it will automatic create ca file, the ca content is an array in WebSocketCA.cpp file.

C++

Please first check the demo project:demo projejct

★ Connect To Server(C++)

1. define a websocket object in your class, and event function to bind.

  UFUNCTION()
  void OnDataReceive(const FString& data);

  UFUNCTION()
  void OnConnectionClose();

  UFUNCTION()
  void OnConnectComplete();

  UFUNCTION()
  void OnConnectError(const FString& strError);

  UPROPERTY(BlueprintReadOnly)
  UWebSocketBase* mDemoSocket;

2. in cpp function, create socket and bind event

bool connectFail = false;
 mDemoSocket = UWebSocketBlueprintLibrary::Connect("wss://echo.websocket.org", connectFail);

 if (connectFail)
 {
 	OnConnectError(TEXT("connect fail, please check url format") );
 	mDemoSocket = nullptr;
 	return;
 }

 
 mDemoSocket->OnConnectComplete.AddDynamic(this, &ADemoGameMode::OnConnectComplete);
 mDemoSocket->OnConnectError.AddDynamic(this, &ADemoGameMode::OnConnectError);
 mDemoSocket->OnClosed.AddDynamic(this, &ADemoGameMode::OnConnectionClose);
 mDemoSocket->OnReceiveData.AddDynamic(this, &ADemoGameMode::OnDataReceive);

★ Send Data(C++)

mDemoSocket->SendText(TEXT("C++ Hello World"));

★ Reconnect(C++)

void ADemoGameMode::CppReconnectShowCase()
{
  if (mDemoSocket != nullptr)
  {
  	mDemoSocket->Close();
  	mDemoSocket = nullptr;
  }

  bool connectFail = false;
  mDemoSocket = UWebSocketBlueprintLibrary::Connect("wss://echo.websocket.org", connectFail);

  if (connectFail)
  {
  	OnConnectError(TEXT("connect fail, please check url format") );
  	mDemoSocket = nullptr;
  	return;
  }

  
  mDemoSocket->OnConnectComplete.AddDynamic(this, &ADemoGameMode::OnConnectComplete);
  mDemoSocket->OnConnectError.AddDynamic(this, &ADemoGameMode::OnConnectError);
  mDemoSocket->OnClosed.AddDynamic(this, &ADemoGameMode::OnConnectionClose);
  mDemoSocket->OnReceiveData.AddDynamic(this, &ADemoGameMode::OnDataReceive);
}

FAQ

if u have any problem can not fix by yourself, please email me:[email protected].

why the socket stop working after some time?

The reason is the websocket object is delete by GC, here is the solution:
if u use websocket in c++, please remmber use it as a class member like this:

    UPROPERTY()
    UWebSocketBase* mDemoSocket;

with UPROPERTY, the object will not free by GC when the owner is not delete.

if u use in blueprint, after connect, please save the websocket object as a variable to avoid GC.

tutorial video: