WebsocketConnection

The WebSocket Protocol

Provides support for the WebSocket protocol.

To connect to a WebSocket server, create a class@Session and call soup.session.Session.websocketConnectAsync. To accept WebSocket connections, create a class@Server and add a handler to it with soup.server.Server.addWebsocketHandler.

(Lower-level support is available via func@websocket_client_prepare_handshake and func@websocket_client_verify_handshake, for handling the client side of the WebSocket handshake, and func@websocket_server_process_handshake for handling the server side.)

#SoupWebsocketConnection handles the details of WebSocket communication. You can use soup.websocket_connection.WebsocketConnection.sendText and soup.websocket_connection.WebsocketConnection.sendBinary to send data, and the signal@WebsocketConnection::message signal to receive data. (#SoupWebsocketConnection currently only supports asynchronous I/O.)

class WebsocketConnection : ObjectG {

void close(ushort code, string data);

ushort getCloseCode();

string getCloseData();

soup.types.WebsocketConnectionType getConnectionType();

soup.websocket_extension.WebsocketExtension[] getExtensions();

gio.iostream.IOStream getIoStream();

uint getKeepaliveInterval();

ulong getMaxIncomingPayloadSize();

string getOrigin();

string getProtocol();

soup.types.WebsocketState getState();

glib.uri.Uri getUri();

void sendBinary(ubyte[] data);

void sendMessage(soup.types.WebsocketDataType type, glib.bytes.Bytes message);

void sendText(string text);

void setKeepaliveInterval(uint interval);

void setMaxIncomingPayloadSize(ulong maxIncomingPayloadSize);

ulong connectClosed(T callback, Flag!"After" after);

ulong connectClosing(T callback, Flag!"After" after);

ulong connectError(T callback, Flag!"After" after);

ulong connectMessage(T callback, Flag!"After" after);

ulong connectPong(T callback, Flag!"After" after);

}

Members

Functions

close void close(ushort code, string data): Close the connection in an orderly fashion.
connectClosed ulong connectClosed(T callback, Flag!"After" after): Connect to Closed signal.
connectClosing ulong connectClosing(T callback, Flag!"After" after): Connect to Closing signal.
connectError ulong connectError(T callback, Flag!"After" after): Connect to Error signal.
connectMessage ulong connectMessage(T callback, Flag!"After" after): Connect to Message signal.
connectPong ulong connectPong(T callback, Flag!"After" after): Connect to Pong signal.
getCloseCode ushort getCloseCode(): Get the close code received from the WebSocket peer.
getCloseData string getCloseData(): Get the close data received from the WebSocket peer.
getConnectionType soup.types.WebsocketConnectionType getConnectionType(): Get the connection type (client/server) of the connection.
getExtensions soup.websocket_extension.WebsocketExtension[] getExtensions(): Get the extensions chosen via negotiation with the peer.
getIoStream gio.iostream.IOStream getIoStream(): Get the I/O stream the WebSocket is communicating over.
getKeepaliveInterval uint getKeepaliveInterval(): Gets the keepalive interval in seconds or 0 if disabled.
getMaxIncomingPayloadSize ulong getMaxIncomingPayloadSize(): Gets the maximum payload size allowed for incoming packets.
getOrigin string getOrigin(): Get the origin of the WebSocket.
getProtocol string getProtocol(): Get the protocol chosen via negotiation with the peer.
getState soup.types.WebsocketState getState(): Get the current state of the WebSocket.
getUri glib.uri.Uri getUri(): Get the URI of the WebSocket.
sendBinary void sendBinary(ubyte[] data): Send a binary message to the peer.
sendMessage void sendMessage(soup.types.WebsocketDataType type, glib.bytes.Bytes message): Send a message of the given type to the peer. Note that this method, allows to send text messages containing null characters.
sendText void sendText(string text): Send a null-terminated text (UTF-8) message to the peer.
setKeepaliveInterval void setKeepaliveInterval(uint interval): Sets the interval in seconds on when to send a ping message which will serve as a keepalive message.
setMaxIncomingPayloadSize void setMaxIncomingPayloadSize(ulong maxIncomingPayloadSize): Sets the maximum payload size allowed for incoming packets.

Inherited Members

From ObjectG

setGObject void setGObject(void* cObj, Flag!"Take" take): Set the GObject of a D ObjectG wrapper.
cPtr void* cPtr(Flag!"Dup" dup): Get a pointer to the underlying C object.
ref_ void* ref_(void* gObj): Calls g_object_ref() on a GObject.
unref unref(void* gObj): Calls g_object_unref() on a GObject.
getType GType getType(): Get the GType of an object.
gType GType gType [@property getter]: GObject GType property.
self ObjectG self(): Convenience method to return this cast to a type. For use in D with statements.
getDObject T getDObject(void* cptr, Flag!"Take" take): Template to get the D object from a C GObject and cast it to the given D object type.
connectSignalClosure ulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after): Connect a D closure to an object signal.
setProperty void setProperty(string propertyName, T val): Template for setting a GObject property.
getProperty T getProperty(string propertyName): Template for getting a GObject property.
compatControl size_t compatControl(size_t what, void* data)
bindProperty gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags): Creates a binding between source_property on source and target_property on target.
bindPropertyFull gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom): Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.
forceFloating void forceFloating(): This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectG.refSink.
freezeNotify void freezeNotify(): Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.
getData void* getData(string key): Gets a named field from the objects table of associations (see gobject.object.ObjectG.setData).
getProperty void getProperty(string propertyName, gobject.value.Value value): Gets a property of an object.
getQdata void* getQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata.
getv void getv(string[] names, gobject.value.Value[] values): Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
isFloating bool isFloating(): Checks whether object has a floating[floating-ref] reference.
notify void notify(string propertyName): Emits a "notify" signal for the property property_name on object.
notifyByPspec void notifyByPspec(gobject.param_spec.ParamSpec pspec): Emits a "notify" signal for the property specified by pspec on object.
refSink gobject.object.ObjectG refSink(): Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
runDispose void runDispose(): Releases all references to other objects. This can be used to break reference cycles.
setData void setData(string key, void* data): Each object carries around a table of associations from strings to pointers. This function lets you set an association.
setProperty void setProperty(string propertyName, gobject.value.Value value): Sets a property on an object.
stealData void* stealData(string key): Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
stealQdata void* stealQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:
thawNotify void thawNotify(): Reverts the effect of a previous call to gobject.object.ObjectG.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
watchClosure void watchClosure(gobject.closure.Closure closure): This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectG.ref_ and gobject.object.ObjectG.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.
connectNotify ulong connectNotify(string detail, T callback, Flag!"After" after): Connect to Notify signal.

soup websocket_connection classes

WebsocketConnection