vibe.d beta banner
get vibe.d
0.8.4

Asynchronous I/O that doesn’t get in your way, written in D

Class WebSocket

Represents a single WebSocket connection.

class WebSocket ;
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!");
}

Properties

NameTypeDescription
closeCode[get] shortReturns the close code sent by the remote end.
closeReason[get] const(char)[]Returns the close reason sent by the remote end.
connected[get] boolDetermines if the WebSocket connection is still alive and ready for sending.
dataAvailableForRead[get] boolChecks if data is readily available for read.
request[get] const(HTTPServerRequest)The HTTP request that established the web socket connection.

Methods

NameDescription
close Actively closes the connection.
receive Receives a new message using an InputStream.
receiveBinary Receives a new message and returns its contents as a newly allocated data array.
receiveText Receives a new message and returns its contents as a newly allocated data array.
send Sends a text message.
send Sends a binary message.
send Sends a message using an output stream.
send Compatibility overload - will be removed soon.
waitForData Waits until either a message arrives or until the connection is closed.
Authors

Jan Krüger

Copyright

© 2012-2014 RejectedSoftware e.K.

License

Subject to the terms of the MIT license, as written in the included LICENSE.txt file.