Class WebsocketConnection

Namespace

Soup

Assembly

Soup-3.0.dll

public sealed class WebsocketConnection : Object, IDisposable, GTypeProvider, InstanceFactory

Inheritance

object

Object

WebsocketConnection

Implements

IDisposable

GTypeProvider

InstanceFactory

Inherited Members

Object.NewValist(Type, string, nint)

Object.NewWithProperties(Type, string[], Value[])

Object.Newv(Type, Parameter[])

Object.Handle

Object.Dispose()

Object.CompatControl(nuint, nint)

Object.InterfaceFindProperty(TypeInterface, string)

Object.InterfaceInstallProperty(TypeInterface, ParamSpec)

Object.AddWeakPointer(ref nint)

Object.BindProperty(string, Object, string, BindingFlags)

Object.BindPropertyFull(string, Object, string, BindingFlags, Closure, Closure)

Object.ForceFloating()

Object.FreezeNotify()

Object.GetData(string)

Object.GetProperty(string, Value)

Object.GetQdata(Quark)

Object.GetValist(string, nint)

Object.Getv(string[], Value[])

Object.IsFloating()

Object.Notify(string)

Object.NotifyByPspec(ParamSpec)

Object.Ref()

Object.RefSink()

Object.RemoveWeakPointer(ref nint)

Object.RunDispose()

Object.SetData(string, nint)

Object.SetProperty(string, Value)

Object.SetQdata(Quark, nint)

Object.SetValist(string, nint)

Object.Setv(string[], Value[])

Object.StealData(string)

Object.StealQdata(Quark)

Object.TakeRef()

Object.ThawNotify()

Object.Unref()

Object.WatchClosure(Closure)

Object.NotifySignal

Object.OnNotify

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

WebsocketConnection(params ConstructArgument[])

public WebsocketConnection(params ConstructArgument[] constructArguments)

Parameters

constructArguments ConstructArgument[]

WebsocketConnection(WebsocketConnectionHandle)

public WebsocketConnection(WebsocketConnectionHandle handle)

Parameters

handle WebsocketConnectionHandle

Fields

ClosedSignal

Signal Descriptor for OnClosed.

public static readonly Signal<WebsocketConnection> ClosedSignal

Field Value

Signal<WebsocketConnection>

ClosingSignal

Signal Descriptor for OnClosing.

public static readonly Signal<WebsocketConnection> ClosingSignal

Field Value

Signal<WebsocketConnection>

ConnectionTypePropertyDefinition

public static readonly Property<WebsocketConnectionType, WebsocketConnection> ConnectionTypePropertyDefinition

Field Value

Property<WebsocketConnectionType, WebsocketConnection>

ErrorSignal

Signal Descriptor for OnError.

public static readonly Signal<WebsocketConnection, WebsocketConnection.ErrorSignalArgs> ErrorSignal

Field Value

Signal<WebsocketConnection, WebsocketConnection.ErrorSignalArgs>

ExtensionsPropertyDefinition

public static readonly Property<nint, WebsocketConnection> ExtensionsPropertyDefinition

Field Value

Property<nint, WebsocketConnection>

IoStreamPropertyDefinition

public static readonly Property<IOStream?, WebsocketConnection> IoStreamPropertyDefinition

Field Value

Property<IOStream, WebsocketConnection>

KeepaliveIntervalPropertyDefinition

public static readonly Property<uint, WebsocketConnection> KeepaliveIntervalPropertyDefinition

Field Value

Property<uint, WebsocketConnection>

KeepalivePongTimeoutPropertyDefinition

public static readonly Property<uint, WebsocketConnection> KeepalivePongTimeoutPropertyDefinition

Field Value

Property<uint, WebsocketConnection>

MaxIncomingPayloadSizePropertyDefinition

public static readonly Property<ulong, WebsocketConnection> MaxIncomingPayloadSizePropertyDefinition

Field Value

Property<ulong, WebsocketConnection>

MessageSignal

Signal Descriptor for OnMessage.

public static readonly Signal<WebsocketConnection, WebsocketConnection.MessageSignalArgs> MessageSignal

Field Value

Signal<WebsocketConnection, WebsocketConnection.MessageSignalArgs>

OriginPropertyDefinition

public static readonly Property<string?, WebsocketConnection> OriginPropertyDefinition

Field Value

Property<string, WebsocketConnection>

PongSignal

Signal Descriptor for OnPong.

public static readonly Signal<WebsocketConnection, WebsocketConnection.PongSignalArgs> PongSignal

Field Value

Signal<WebsocketConnection, WebsocketConnection.PongSignalArgs>

ProtocolPropertyDefinition

public static readonly Property<string?, WebsocketConnection> ProtocolPropertyDefinition

Field Value

Property<string, WebsocketConnection>

StatePropertyDefinition

public static readonly Property<WebsocketState, WebsocketConnection> StatePropertyDefinition

Field Value

Property<WebsocketState, WebsocketConnection>

UriPropertyDefinition

public static readonly Property<Uri, WebsocketConnection> UriPropertyDefinition

Field Value

Property<Uri, WebsocketConnection>

Properties

ConnectionType

public WebsocketConnectionType ConnectionType { get; }

Property Value

WebsocketConnectionType

Extensions

public nint Extensions { get; }

Property Value

nint

IoStream

public IOStream? IoStream { get; }

Property Value

IOStream

KeepaliveInterval

public uint KeepaliveInterval { get; set; }

Property Value

uint

KeepalivePongTimeout

public uint KeepalivePongTimeout { get; set; }

Property Value

uint

MaxIncomingPayloadSize

public ulong MaxIncomingPayloadSize { get; set; }

Property Value

ulong

Origin

public string? Origin { get; }

Property Value

string

Protocol

public string? Protocol { get; }

Property Value

string

State

public WebsocketState State { get; }

Property Value

WebsocketState

Uri

public Uri Uri { get; }

Property Value

Uri

Methods

Close(ushort, string?)

public void Close(ushort code, string? data)

Parameters

code ushort

data string

GetCloseCode()

public ushort GetCloseCode()

Returns

ushort

GetCloseData()

public string GetCloseData()

Returns

string

GetConnectionType()

public WebsocketConnectionType GetConnectionType()

Returns

WebsocketConnectionType

GetExtensions()

public List GetExtensions()

Returns

List

GetGType()

public static Type GetGType()

Returns

Type

GetIoStream()

public IOStream GetIoStream()

Returns

IOStream

GetKeepaliveInterval()

public uint GetKeepaliveInterval()

Returns

uint

GetKeepalivePongTimeout()

[Version("3.6")]
public uint GetKeepalivePongTimeout()

Returns

uint

GetMaxIncomingPayloadSize()

public ulong GetMaxIncomingPayloadSize()

Returns

ulong

GetOrigin()

public string? GetOrigin()

Returns

string

GetProtocol()

public string? GetProtocol()

Returns

string

GetState()

public WebsocketState GetState()

Returns

WebsocketState

GetUri()

public Uri GetUri()

Returns

Uri

SendBinary(Span<byte>)

public void SendBinary(Span<byte> data)

Parameters

data Span<byte>

SendMessage(WebsocketDataType, Bytes)

public void SendMessage(WebsocketDataType type, Bytes message)

Parameters

type WebsocketDataType

message Bytes

SendText(string)

public void SendText(string text)

Parameters

text string

SetKeepaliveInterval(uint)

public void SetKeepaliveInterval(uint interval)

Parameters

interval uint

SetKeepalivePongTimeout(uint)

[Version("3.6")]
public void SetKeepalivePongTimeout(uint pongTimeout)

Parameters

pongTimeout uint

SetMaxIncomingPayloadSize(ulong)

public void SetMaxIncomingPayloadSize(ulong maxIncomingPayloadSize)

Parameters

maxIncomingPayloadSize ulong

Events

OnClosed

public event SignalHandler<WebsocketConnection> OnClosed

Event Type

SignalHandler<WebsocketConnection>

OnClosing

public event SignalHandler<WebsocketConnection> OnClosing

Event Type

SignalHandler<WebsocketConnection>

OnError

public event SignalHandler<WebsocketConnection, WebsocketConnection.ErrorSignalArgs> OnError

Event Type

SignalHandler<WebsocketConnection, WebsocketConnection.ErrorSignalArgs>

OnMessage

public event SignalHandler<WebsocketConnection, WebsocketConnection.MessageSignalArgs> OnMessage

Event Type

SignalHandler<WebsocketConnection, WebsocketConnection.MessageSignalArgs>

OnPong

public event SignalHandler<WebsocketConnection, WebsocketConnection.PongSignalArgs> OnPong

Event Type

SignalHandler<WebsocketConnection, WebsocketConnection.PongSignalArgs>