Interface

Soup-3.0 ▶ Soup ▶ WebsocketConnection ▶ SignalSignatures

interface SignalSignatures {
    closed: () => void;
    closing: () => void;
    error: (arg0: GLib.Error) => void;
    message: (arg0: number, arg1: GLib.Bytes) => void;
    notify: (arg0: GObject.ParamSpec) => void;
    "notify::connection-type": (pspec: GObject.ParamSpec) => void;
    "notify::extensions": (pspec: GObject.ParamSpec) => void;
    "notify::io-stream": (pspec: GObject.ParamSpec) => void;
    "notify::keepalive-interval": (pspec: GObject.ParamSpec) => void;
    "notify::keepalive-pong-timeout": (pspec: GObject.ParamSpec) => void;
    "notify::max-incoming-payload-size": (pspec: GObject.ParamSpec) => void;
    "notify::origin": (pspec: GObject.ParamSpec) => void;
    "notify::protocol": (pspec: GObject.ParamSpec) => void;
    "notify::state": (pspec: GObject.ParamSpec) => void;
    "notify::uri": (pspec: GObject.ParamSpec) => void;
    pong: (arg0: GLib.Bytes) => void;
}

Hierarchy (View Summary)

Index

Properties

closed closing error message notify::connection-type notify::extensions notify::io-stream notify::keepalive-interval notify::keepalive-pong-timeout notify::max-incoming-payload-size notify::origin notify::protocol notify::state notify::uri pong

Properties - Inherited from GObject

notify

Properties

closed: () => void

Emitted when the connection has completely closed.

This happens either due to an orderly close from the peer, one initiated via WebsocketConnection.close or a fatal error condition that caused a close.

This signal will be emitted once.

closing: () => void

This signal will be emitted during an orderly close.

error: (arg0: GLib.Error) => void

Emitted when an error occurred on the WebSocket.

This may be fired multiple times. Fatal errors will be followed by the Soup.WebsocketConnection::closed signal being emitted.

message: (arg0: number, arg1: GLib.Bytes) => void

Emitted when we receive a message from the peer.

As a convenience, the message data will always be null-terminated, but the NUL byte will not be included in the length count.

"notify::connection-type": (pspec: GObject.ParamSpec) => void
"notify::extensions": (pspec: GObject.ParamSpec) => void
"notify::io-stream": (pspec: GObject.ParamSpec) => void
"notify::keepalive-interval": (pspec: GObject.ParamSpec) => void
"notify::keepalive-pong-timeout": (pspec: GObject.ParamSpec) => void
"notify::max-incoming-payload-size": (pspec: GObject.ParamSpec) => void
"notify::origin": (pspec: GObject.ParamSpec) => void
"notify::protocol": (pspec: GObject.ParamSpec) => void
"notify::state": (pspec: GObject.ParamSpec) => void
"notify::uri": (pspec: GObject.ParamSpec) => void
pong: (arg0: GLib.Bytes) => void

Emitted when we receive a Pong frame (solicited or unsolicited) from the peer.

As a convenience, the message data will always be null-terminated, but the NUL byte will not be included in the length count.

Properties - Inherited from GObject

notify: (arg0: GObject.ParamSpec) => void

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with GObject.ParamFlags.EXPLICIT_NOTIFY, then any call to g_object_set_property() results in ::notify being emitted, even if the new value is the same as the old. If they did pass GObject.ParamFlags.EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

It is important to note that you must use [canonical parameter names][class@GObject.ParamSpec#parameter-names] as detail strings for the notify signal.