Table of Contents

Class Session

Namespace
Soup
Assembly
Soup-3.0.dll
public class Session : Object, IObject, INotifyPropertyChanged, IDisposable, IHandle, GTypeProvider
Inheritance
Session
Implements
Inherited Members

Constructors

Session(bool, params ConstructArgument[])

protected Session(bool owned, params ConstructArgument[] constructArguments)

Parameters

owned bool
constructArguments ConstructArgument[]

Session(IntPtr, bool)

protected Session(IntPtr ptr, bool ownedRef)

Parameters

ptr IntPtr
ownedRef bool

Fields

AcceptLanguageAutoPropertyDefinition

public static readonly Property<bool, Session> AcceptLanguageAutoPropertyDefinition

Field Value

Property<bool, Session>

AcceptLanguagePropertyDefinition

public static readonly Property<string?, Session> AcceptLanguagePropertyDefinition

Field Value

Property<string, Session>

IdleTimeoutPropertyDefinition

public static readonly Property<uint, Session> IdleTimeoutPropertyDefinition

Field Value

Property<uint, Session>

LocalAddressPropertyDefinition

public static readonly Property<InetSocketAddress?, Session> LocalAddressPropertyDefinition

Field Value

Property<InetSocketAddress, Session>

MaxConnsPerHostPropertyDefinition

public static readonly Property<int, Session> MaxConnsPerHostPropertyDefinition

Field Value

Property<int, Session>

MaxConnsPropertyDefinition

public static readonly Property<int, Session> MaxConnsPropertyDefinition

Field Value

Property<int, Session>

ProxyResolverPropertyDefinition

public static readonly Property<ProxyResolver, Session> ProxyResolverPropertyDefinition

Field Value

Property<ProxyResolver, Session>

RemoteConnectablePropertyDefinition

public static readonly Property<SocketConnectable, Session> RemoteConnectablePropertyDefinition

Field Value

Property<SocketConnectable, Session>

RequestQueuedSignal

Signal Descriptor for OnRequestQueued.

public static readonly Signal<Session, Session.RequestQueuedSignalArgs> RequestQueuedSignal

Field Value

Signal<Session, Session.RequestQueuedSignalArgs>

RequestUnqueuedSignal

Signal Descriptor for OnRequestUnqueued.

public static readonly Signal<Session, Session.RequestUnqueuedSignalArgs> RequestUnqueuedSignal

Field Value

Signal<Session, Session.RequestUnqueuedSignalArgs>

TimeoutPropertyDefinition

public static readonly Property<uint, Session> TimeoutPropertyDefinition

Field Value

Property<uint, Session>

TlsDatabasePropertyDefinition

public static readonly Property<TlsDatabase?, Session> TlsDatabasePropertyDefinition

Field Value

Property<TlsDatabase, Session>

TlsInteractionPropertyDefinition

public static readonly Property<TlsInteraction?, Session> TlsInteractionPropertyDefinition

Field Value

Property<TlsInteraction, Session>

UserAgentPropertyDefinition

public static readonly Property<string?, Session> UserAgentPropertyDefinition

Field Value

Property<string, Session>

Properties

AcceptLanguage

public string? AcceptLanguage { get; set; }

Property Value

string

AcceptLanguageAuto

public bool AcceptLanguageAuto { get; set; }

Property Value

bool

IdleTimeout

public uint IdleTimeout { get; set; }

Property Value

uint

LocalAddress

public InetSocketAddress? LocalAddress { get; }

Property Value

InetSocketAddress

MaxConns

public int MaxConns { get; }

Property Value

int

MaxConnsPerHost

public int MaxConnsPerHost { get; }

Property Value

int

ProxyResolver

public ProxyResolver ProxyResolver { get; set; }

Property Value

ProxyResolver

RemoteConnectable

public SocketConnectable RemoteConnectable { get; }

Property Value

SocketConnectable

Timeout

public uint Timeout { get; set; }

Property Value

uint

TlsDatabase

public TlsDatabase? TlsDatabase { get; set; }

Property Value

TlsDatabase

TlsInteraction

public TlsInteraction? TlsInteraction { get; set; }

Property Value

TlsInteraction

UserAgent

public string? UserAgent { get; set; }

Property Value

string

Methods

Abort()

public void Abort()

AddFeature(SessionFeature)

public void AddFeature(SessionFeature feature)

Parameters

feature SessionFeature

AddFeatureByType(Type)

public void AddFeatureByType(Type featureType)

Parameters

featureType Type

GetAcceptLanguage()

public string? GetAcceptLanguage()

Returns

string

GetAcceptLanguageAuto()

public bool GetAcceptLanguageAuto()

Returns

bool

GetAsyncResultMessage(AsyncResult)

public Message? GetAsyncResultMessage(AsyncResult result)

Parameters

result AsyncResult

Returns

Message

GetFeature(Type)

public SessionFeature? GetFeature(Type featureType)

Parameters

featureType Type

Returns

SessionFeature

GetFeatureForMessage(Type, Message)

public SessionFeature? GetFeatureForMessage(Type featureType, Message msg)

Parameters

featureType Type
msg Message

Returns

SessionFeature

GetGType()

public static Type GetGType()

Returns

Type

GetIdleTimeout()

public uint GetIdleTimeout()

Returns

uint

GetLocalAddress()

public InetSocketAddress? GetLocalAddress()

Returns

InetSocketAddress

GetMaxConns()

public uint GetMaxConns()

Returns

uint

GetMaxConnsPerHost()

public uint GetMaxConnsPerHost()

Returns

uint

GetProxyResolver()

public ProxyResolver? GetProxyResolver()

Returns

ProxyResolver

GetRemoteConnectable()

public SocketConnectable? GetRemoteConnectable()

Returns

SocketConnectable

GetTimeout()

public uint GetTimeout()

Returns

uint

GetTlsDatabase()

public TlsDatabase? GetTlsDatabase()

Returns

TlsDatabase

GetTlsInteraction()

public TlsInteraction? GetTlsInteraction()

Returns

TlsInteraction

GetUserAgent()

public string? GetUserAgent()

Returns

string

HasFeature(Type)

public bool HasFeature(Type featureType)

Parameters

featureType Type

Returns

bool

New()

public static Session New()

Returns

Session

PreconnectFinish(AsyncResult)

public bool PreconnectFinish(AsyncResult result)

Parameters

result AsyncResult

Returns

bool

RemoveFeature(SessionFeature)

public void RemoveFeature(SessionFeature feature)

Parameters

feature SessionFeature

RemoveFeatureByType(Type)

public void RemoveFeatureByType(Type featureType)

Parameters

featureType Type

Send(Message, Cancellable?)

public InputStream Send(Message msg, Cancellable? cancellable)

Parameters

msg Message
cancellable Cancellable

Returns

InputStream

SendAndRead(Message, Cancellable?)

public Bytes SendAndRead(Message msg, Cancellable? cancellable)

Parameters

msg Message
cancellable Cancellable

Returns

Bytes

SendAndReadFinish(AsyncResult)

public Bytes SendAndReadFinish(AsyncResult result)

Parameters

result AsyncResult

Returns

Bytes

SendAndSplice(Message, OutputStream, OutputStreamSpliceFlags, Cancellable?)

[Version("3.4")]
public long SendAndSplice(Message msg, OutputStream outStream, OutputStreamSpliceFlags flags, Cancellable? cancellable)

Parameters

msg Message
outStream OutputStream
flags OutputStreamSpliceFlags
cancellable Cancellable

Returns

long

SendAndSpliceFinish(AsyncResult)

[Version("3.4")]
public long SendAndSpliceFinish(AsyncResult result)

Parameters

result AsyncResult

Returns

long

SendFinish(AsyncResult)

public InputStream SendFinish(AsyncResult result)

Parameters

result AsyncResult

Returns

InputStream

SetAcceptLanguage(string)

public void SetAcceptLanguage(string acceptLanguage)

Parameters

acceptLanguage string

SetAcceptLanguageAuto(bool)

public void SetAcceptLanguageAuto(bool acceptLanguageAuto)

Parameters

acceptLanguageAuto bool

SetIdleTimeout(uint)

public void SetIdleTimeout(uint timeout)

Parameters

timeout uint

SetProxyResolver(ProxyResolver?)

public void SetProxyResolver(ProxyResolver? proxyResolver)

Parameters

proxyResolver ProxyResolver

SetTimeout(uint)

public void SetTimeout(uint timeout)

Parameters

timeout uint

SetTlsDatabase(TlsDatabase?)

public void SetTlsDatabase(TlsDatabase? tlsDatabase)

Parameters

tlsDatabase TlsDatabase

SetTlsInteraction(TlsInteraction?)

public void SetTlsInteraction(TlsInteraction? tlsInteraction)

Parameters

tlsInteraction TlsInteraction

SetUserAgent(string)

public void SetUserAgent(string userAgent)

Parameters

userAgent string

WebsocketConnectFinish(AsyncResult)

public WebsocketConnection WebsocketConnectFinish(AsyncResult result)

Parameters

result AsyncResult

Returns

WebsocketConnection

Events

OnRequestQueued

public event SignalHandler<Session, Session.RequestQueuedSignalArgs> OnRequestQueued

Event Type

SignalHandler<Session, Session.RequestQueuedSignalArgs>

OnRequestUnqueued

public event SignalHandler<Session, Session.RequestUnqueuedSignalArgs> OnRequestUnqueued

Event Type

SignalHandler<Session, Session.RequestUnqueuedSignalArgs>