WebSocket

Represents a single WebSocket connection.

shared static this ()
{
  runTask(() => connectToWS());
}

void connectToWS ()
{
  auto ws_url = URL("wss://websockets.example.com/websocket/auth_token");
  auto ws = connectWebSocket(ws_url);
  logInfo("WebSocket connected");

  while (ws.waitForData())
  {
    auto txt = ws.receiveText;
    logInfo("Received: %s", txt);
  }
  logFatal("Connection lost!");
}

@safe final

class WebSocket {

bool connected [@property getter];

short closeCode [@property getter];

const(char)[] closeReason [@property getter];

const(HTTPServerRequest) request [@property getter];

bool dataAvailableForRead [@property getter];

bool waitForData();

bool waitForData(Duration timeout);

void send(const(char)[] data);

void send(ubyte[] data);

void send(void delegate(scope OutgoingWebSocketMessage) @(safe) sender, FrameOpcode frameOpcode);

void send(void delegate(scope OutgoingWebSocketMessage) @(safe) sender);

void close(short code, const(char)[] reason);

ubyte[] receiveBinary(bool strict);

string receiveText(bool strict);

void receive(void delegate(scope IncomingWebSocketMessage) @(safe) receiver);

}

Members

Functions

close void close(short code, const(char)[] reason): Actively closes the connection.
receive void receive(void delegate(scope IncomingWebSocketMessage) @(safe) receiver): Receives a new message using an InputStream.
receiveBinary ubyte[] receiveBinary(bool strict)
receiveText string receiveText(bool strict): Receives a new message and returns its contents as a newly allocated data array.
send void send(const(char)[] data): Sends a text message.
send void send(ubyte[] data): Sends a binary message.
send void send(void delegate(scope OutgoingWebSocketMessage) @(safe) sender, FrameOpcode frameOpcode): Sends a message using an output stream.
send deprecated void send(void delegate(scope OutgoingWebSocketMessage) @(safe) sender): Compatibility overload - will be removed soon.
waitForData bool waitForData()
bool waitForData(Duration timeout): Waits until either a message arrives or until the connection is closed.

Properties

closeCode short closeCode [@property getter]: Returns the close code sent by the remote end.
closeReason const(char)[] closeReason [@property getter]: Returns the close reason sent by the remote end.
connected bool connected [@property getter]: Determines if the WebSocket connection is still alive and ready for sending.
dataAvailableForRead bool dataAvailableForRead [@property getter]: Checks if data is readily available for read.
request const(HTTPServerRequest) request [@property getter]: The HTTP request that established the web socket connection.

WebSocket

Members

Functions

Properties

Meta

Source