WebSocket Class Reference

Synchronous WebSocket client implementation. More...

#include <gin_websocket.h>

Public Types
enum	ReadyStateValues { CLOSING , CLOSED , OPEN }

Public Member Functions
	~WebSocket ()
bool	readIncoming ()
void	poll (int timeout=0)
void	send (const juce::String &message)
void	sendBinary (const juce::String &message)
void	sendBinary (const juce::MemoryBlock &message)
void	sendPing ()
void	close ()
ReadyStateValues	getReadyState () const
void	dispatch (std::function< void(const juce::MemoryBlock &message, bool isBinary)> callback)

Static Public Member Functions
static WebSocket *	fromURL (const juce::String &url, const juce::String &origin={})
static WebSocket *	fromURLNoMask (const juce::String &url, const juce::String &origin={})
static WebSocket *	fromURL (const juce::String &url, bool useMask, const juce::String &origin)
static WebSocket *	fromURL (const juce::String &url, const juce::String &origin, const juce::StringPairArray &customHeaders)

Public Attributes
ReadyStateValues	readyStateValues

Detailed Description

Synchronous WebSocket client implementation.

WebSocket provides a blocking WebSocket client based on the RFC 6455 protocol. Originally based on easywsclient, heavily refactored for JUCE integration. Supports both text and binary messages, ping/pong, and secure connections.

Key Features:

• WebSocket protocol (RFC 6455) implementation
• Text and binary message support
• Ping/pong keep-alive
• TLS/SSL support via SecureStreamingSocket
• Optional frame masking (required for client-to-server)
• Custom headers for authentication/protocols

Connection States:

• OPEN: Connected and ready
• CLOSING: Close handshake initiated
• CLOSED: Connection closed

Usage:

// Create connection
auto* ws = WebSocket::fromURL("wss://example.com/socket");
 
if (ws)
{
    // Send message
    ws->send("Hello, server!");
 
    // Poll for incoming messages
    ws->poll(100); // timeout in ms
 
    // Dispatch received messages
    ws->dispatch([](const juce::MemoryBlock& data, bool isBinary) {
        if (!isBinary)
        {
            juce::String msg = data.toString();
            DBG("Received: " + msg);
        }
    });
 
    // Close connection
    ws->close();
    delete ws;
}

Note: This is a synchronous (blocking) implementation. For asynchronous operations with callbacks, use AsyncWebsocket instead.

See also

AsyncWebsocket, SecureStreamingSocket, WSHeaderType

Member Enumeration Documentation

ReadyStateValues

enum WebSocket::ReadyStateValues

Enumerator
CLOSING
CLOSED
OPEN

Constructor & Destructor Documentation

~WebSocket()

WebSocket::~WebSocket

(

)

Member Function Documentation

fromURL() [1/3]

WebSocket * WebSocket::fromURL ( const juce::String & url, const juce::String & origin = {} )

static

fromURLNoMask()

WebSocket * WebSocket::fromURLNoMask ( const juce::String & url, const juce::String & origin = {} )

static

fromURL() [2/3]

WebSocket * WebSocket::fromURL ( const juce::String & url, bool useMask, const juce::String & origin )

static

fromURL() [3/3]

WebSocket * WebSocket::fromURL ( const juce::String & url, const juce::String & origin, const juce::StringPairArray & customHeaders )

static

readIncoming()

bool WebSocket::readIncoming

(

)

poll()

void WebSocket::poll

(

int

timeout = 0

)

send()

void WebSocket::send

(

const juce::String &

message

)

sendBinary() [1/2]

void WebSocket::sendBinary

(

const juce::String &

message

)

sendBinary() [2/2]

void WebSocket::sendBinary

(

const juce::MemoryBlock &

message

)

sendPing()

void WebSocket::sendPing

(

)

close()

void WebSocket::close

(

)

getReadyState()

ReadyStateValues WebSocket::getReadyState

(

)

const

dispatch()

void WebSocket::dispatch

(

std::function< void(const juce::MemoryBlock &message, bool isBinary)>

callback

)

References OPEN.

Member Data Documentation

readyStateValues

ReadyStateValues WebSocket::readyStateValues

---

The documentation for this class was generated from the following file:

• gin_websocket.h