Websocket Client

The IWebsocketClient interface is for working with websocket connections. While websocket is an update to an existing HTTP connection, there is no need to pass an existing HTTP connection to IWebsocketClient. Everything will handled from the interface itself. To establish a connection, the address of the websocket server need to be passed with the leading ws:// prefix. If the connection need to be encrypted, wss:// should be used instead. The server can be passed as TCP (v4 or v6) address or as name, the IWebsocketClient tries to resolve. Note that the IWebsocketClient only handles the client side of the connection. For implement a server-side websocket connection, see IWebserverPlugin - IWebsocket.

To create an IWebsocketClient instance, the static Create() function need to be called. Two existing ISocketProvider as well as an IDns instance must be passed to Create(). Those interfaces must not be deleted before releasing the IWebsocketClient instance!

File information

Classes

class IWebsocketClient {
public:
    static IWebsocketClient * Create(class IIoMux * const iomux,
                                     class UWebsocketClient * const user,
                                     class ISocketProvider * const tcpSocketProvider,
                                     class ISocketProvider * const tlsSocketProvider,
                                     class IDns * const dns,
                                     class IInstanceLog * const log);
	
    virtual ~IWebsocketClient() {}
    virtual void Connect(const char * uri);
    virtual void Close();
    virtual void Send(const void * buf, size_t len, bool text = true);
    virtual void Recv(void * buf = nullptr, size_t len = 0);
};

Overview

Logging

Public functions

class UWebsocketClient {
public:
    virtual ~UWebsocketClient() {}
    virtual void WebsocketConnectComplete(IWebsocketClient * const websocket);
    virtual void WebsocketCloseComplete(IWebsocketClient * const websocket, closereason_t reason) ;
    virtual void WebsocketSendResult(IWebsocketClient * const websocket);
    virtual void WebsocketRecvResult(IWebsocketClient * const websocket, void * buf, size_t len, bool text, bool isFragment);
    virtual void * WebsocketRecvBuffer(size_t len) { return nullptr; }
};

Overview

Public functions

Data types

Overview

Values

Overview

Values

Code Example

IWebsocketClient

app::app(class IIoMux * iomux,
         ISocketProvider * tcpSocketProvider,
         ISocketProvider * tlsSocketProvider,
         IDns * dns)
    : iomux(iomux)
{
    this->websocketClient = IWebsocketClient::Create(iomux, this, tcpSocketProvider, tlsSocketProvider, dns);
    this->websocketClient->Connect("wss://myserver.com/websocket");
}

void app::WebsocketConnectComplete(IWebsocketClient * const websocket)
{
    printf("Websocket connected\n");
	this->websocketClient->Recv();
}

void app::WebsocketCloseComplete(IWebsocketClient * const websocket, closereason_t reason)
{
    printf("Websocket connection closed\n");
    delete this->websocketClient;
    this->websocketClient = NULL;
    iomux->Terminate();
}

void app::WebsocketSendResult(IWebsocketClient * const websocket)
{
    this->websocketClient->Close();
}

void * app::WebsocketRecvBuffer(size_t len)
{
    return malloc(len);
}

void app::WebsocketRecvResult(IWebsocketClient * const websocket, void * buf, size_t len, bool text)
{
    printf("Websocket client received data (text = %s)\n", (test ? "true" : "false"));
    debug->HexDump(buf, len);
    this->websocketClient->Send(buf, len);
	free(buf);
}