Table of Contents

Class Functions

Namespace
Soup.Internal
Assembly
Soup-3.0.dll
public class Functions
Inheritance
Functions
Inherited Members

Methods

CheckVersion(uint, uint, uint)

Calls native function soup_check_version.

public static extern bool CheckVersion(uint major, uint minor, uint micro)

Parameters

major uint

Transfer ownership: None Nullable: False

minor uint

Transfer ownership: None Nullable: False

micro uint

Transfer ownership: None Nullable: False

Returns

bool

Transfer ownership: None Nullable: False

CookieParse(NonNullableUtf8StringHandle, UriHandle)

Calls native function soup_cookie_parse.

public static extern CookieOwnedHandle CookieParse(NonNullableUtf8StringHandle header, UriHandle origin)

Parameters

header NonNullableUtf8StringHandle

Transfer ownership: None Nullable: False

origin UriHandle

Transfer ownership: None Nullable: True

Returns

CookieOwnedHandle

Transfer ownership: Full Nullable: True

CookiesFree(SListHandle)

Calls native function soup_cookies_free.

public static extern void CookiesFree(SListHandle cookies)

Parameters

cookies SListHandle

Transfer ownership: None Nullable: False

CookiesFromRequest(IntPtr)

Calls native function soup_cookies_from_request.

public static extern SListOwnedHandle CookiesFromRequest(IntPtr msg)

Parameters

msg IntPtr

Transfer ownership: None Nullable: False

Returns

SListOwnedHandle

Transfer ownership: Full Nullable: False

CookiesFromResponse(IntPtr)

Calls native function soup_cookies_from_response.

public static extern SListOwnedHandle CookiesFromResponse(IntPtr msg)

Parameters

msg IntPtr

Transfer ownership: None Nullable: False

Returns

SListOwnedHandle

Transfer ownership: Full Nullable: False

CookiesToCookieHeader(SListHandle)

Calls native function soup_cookies_to_cookie_header.

public static extern NonNullableUtf8StringOwnedHandle CookiesToCookieHeader(SListHandle cookies)

Parameters

cookies SListHandle

Transfer ownership: None Nullable: False

Returns

NonNullableUtf8StringOwnedHandle

Transfer ownership: Full Nullable: False

CookiesToRequest(SListHandle, IntPtr)

Calls native function soup_cookies_to_request.

public static extern void CookiesToRequest(SListHandle cookies, IntPtr msg)

Parameters

cookies SListHandle

Transfer ownership: None Nullable: False

msg IntPtr

Transfer ownership: None Nullable: False

CookiesToResponse(SListHandle, IntPtr)

Calls native function soup_cookies_to_response.

public static extern void CookiesToResponse(SListHandle cookies, IntPtr msg)

Parameters

cookies SListHandle

Transfer ownership: None Nullable: False

msg IntPtr

Transfer ownership: None Nullable: False

DateTimeNewFromHttpString(NonNullableUtf8StringHandle)

Calls native function soup_date_time_new_from_http_string.

public static extern DateTimeOwnedHandle DateTimeNewFromHttpString(NonNullableUtf8StringHandle dateString)

Parameters

dateString NonNullableUtf8StringHandle

Transfer ownership: None Nullable: False

Returns

DateTimeOwnedHandle

Transfer ownership: Full Nullable: True

DateTimeToString(DateTimeHandle, DateFormat)

Calls native function soup_date_time_to_string.

public static extern NonNullableUtf8StringOwnedHandle DateTimeToString(DateTimeHandle date, DateFormat format)

Parameters

date DateTimeHandle

Transfer ownership: None Nullable: False

format DateFormat

Transfer ownership: None Nullable: False

Returns

NonNullableUtf8StringOwnedHandle

Transfer ownership: Full Nullable: False

FormDecode(NonNullableUtf8StringHandle)

Calls native function soup_form_decode.

public static extern HashTableUnownedHandle FormDecode(NonNullableUtf8StringHandle encodedForm)

Parameters

encodedForm NonNullableUtf8StringHandle

Transfer ownership: None Nullable: False

Returns

HashTableUnownedHandle

Transfer ownership: Container Nullable: False

FormEncodeDatalist(DataHandle)

Calls native function soup_form_encode_datalist.

public static extern NonNullableUtf8StringOwnedHandle FormEncodeDatalist(DataHandle formDataSet)

Parameters

formDataSet DataHandle

Transfer ownership: None Nullable: False

Returns

NonNullableUtf8StringOwnedHandle

Transfer ownership: Full Nullable: False

FormEncodeHash(HashTableHandle)

Calls native function soup_form_encode_hash.

public static extern NonNullableUtf8StringOwnedHandle FormEncodeHash(HashTableHandle formDataSet)

Parameters

formDataSet HashTableHandle

Transfer ownership: None Nullable: False

Returns

NonNullableUtf8StringOwnedHandle

Transfer ownership: Full Nullable: False

FormEncodeValist(NonNullableUtf8StringHandle, IntPtr)

Calls native function soup_form_encode_valist.

public static extern NonNullableUtf8StringOwnedHandle FormEncodeValist(NonNullableUtf8StringHandle firstField, IntPtr args)

Parameters

firstField NonNullableUtf8StringHandle

Transfer ownership: None Nullable: False

args IntPtr

Transfer ownership: None Nullable: False

Returns

NonNullableUtf8StringOwnedHandle

Transfer ownership: Full Nullable: False

GetMajorVersion()

Calls native function soup_get_major_version.

public static extern uint GetMajorVersion()

Returns

uint

Transfer ownership: None Nullable: False

GetMicroVersion()

Calls native function soup_get_micro_version.

public static extern uint GetMicroVersion()

Returns

uint

Transfer ownership: None Nullable: False

GetMinorVersion()

Calls native function soup_get_minor_version.

public static extern uint GetMinorVersion()

Returns

uint

Transfer ownership: None Nullable: False

HeaderContains(NonNullableUtf8StringHandle, NonNullableUtf8StringHandle)

Calls native function soup_header_contains.

public static extern bool HeaderContains(NonNullableUtf8StringHandle header, NonNullableUtf8StringHandle token)

Parameters

header NonNullableUtf8StringHandle

Transfer ownership: None Nullable: False

token NonNullableUtf8StringHandle

Transfer ownership: None Nullable: False

Returns

bool

Transfer ownership: None Nullable: False

HeaderFreeList(SListHandle)

Calls native function soup_header_free_list.

public static extern void HeaderFreeList(SListHandle list)

Parameters

list SListHandle

Transfer ownership: None Nullable: False

HeaderFreeParamList(HashTableHandle)

Calls native function soup_header_free_param_list.

public static extern void HeaderFreeParamList(HashTableHandle paramList)

Parameters

paramList HashTableHandle

Transfer ownership: None Nullable: False

HeaderGStringAppendParam(StringHandle, NonNullableUtf8StringHandle, NullableUtf8StringHandle)

Calls native function soup_header_g_string_append_param.

public static extern void HeaderGStringAppendParam(StringHandle @string, NonNullableUtf8StringHandle name, NullableUtf8StringHandle value)

Parameters

string StringHandle
name NonNullableUtf8StringHandle

Transfer ownership: None Nullable: False

value NullableUtf8StringHandle

Transfer ownership: None Nullable: True

HeaderGStringAppendParamQuoted(StringHandle, NonNullableUtf8StringHandle, NonNullableUtf8StringHandle)

Calls native function soup_header_g_string_append_param_quoted.

public static extern void HeaderGStringAppendParamQuoted(StringHandle @string, NonNullableUtf8StringHandle name, NonNullableUtf8StringHandle value)

Parameters

string StringHandle
name NonNullableUtf8StringHandle

Transfer ownership: None Nullable: False

value NonNullableUtf8StringHandle

Transfer ownership: None Nullable: False

HeaderParseList(NonNullableUtf8StringHandle)

Calls native function soup_header_parse_list.

public static extern SListOwnedHandle HeaderParseList(NonNullableUtf8StringHandle header)

Parameters

header NonNullableUtf8StringHandle

Transfer ownership: None Nullable: False

Returns

SListOwnedHandle

Transfer ownership: Full Nullable: False

HeaderParseParamList(NonNullableUtf8StringHandle)

Calls native function soup_header_parse_param_list.

public static extern HashTableOwnedHandle HeaderParseParamList(NonNullableUtf8StringHandle header)

Parameters

header NonNullableUtf8StringHandle

Transfer ownership: None Nullable: False

Returns

HashTableOwnedHandle

Transfer ownership: Full Nullable: False

HeaderParseParamListStrict(NonNullableUtf8StringHandle)

Calls native function soup_header_parse_param_list_strict.

public static extern HashTableOwnedHandle HeaderParseParamListStrict(NonNullableUtf8StringHandle header)

Parameters

header NonNullableUtf8StringHandle

Transfer ownership: None Nullable: False

Returns

HashTableOwnedHandle

Transfer ownership: Full Nullable: True

HeaderParseSemiParamList(NonNullableUtf8StringHandle)

Calls native function soup_header_parse_semi_param_list.

public static extern HashTableOwnedHandle HeaderParseSemiParamList(NonNullableUtf8StringHandle header)

Parameters

header NonNullableUtf8StringHandle

Transfer ownership: None Nullable: False

Returns

HashTableOwnedHandle

Transfer ownership: Full Nullable: False

HeaderParseSemiParamListStrict(NonNullableUtf8StringHandle)

Calls native function soup_header_parse_semi_param_list_strict.

public static extern HashTableOwnedHandle HeaderParseSemiParamListStrict(NonNullableUtf8StringHandle header)

Parameters

header NonNullableUtf8StringHandle

Transfer ownership: None Nullable: False

Returns

HashTableOwnedHandle

Transfer ownership: Full Nullable: True

HeadersParse(NonNullableUtf8StringHandle, int, MessageHeadersHandle)

Calls native function soup_headers_parse.

public static extern bool HeadersParse(NonNullableUtf8StringHandle str, int len, MessageHeadersHandle dest)

Parameters

str NonNullableUtf8StringHandle

Transfer ownership: None Nullable: False

len int

Transfer ownership: None Nullable: False

dest MessageHeadersHandle

Transfer ownership: None Nullable: False

Returns

bool

Transfer ownership: None Nullable: False

HeadersParseRequest(NonNullableUtf8StringHandle, int, MessageHeadersHandle, out NonNullableUtf8StringOwnedHandle, out NonNullableUtf8StringOwnedHandle, out IntPtr)

Calls native function soup_headers_parse_request.

public static extern uint HeadersParseRequest(NonNullableUtf8StringHandle str, int len, MessageHeadersHandle reqHeaders, out NonNullableUtf8StringOwnedHandle reqMethod, out NonNullableUtf8StringOwnedHandle reqPath, out IntPtr ver)

Parameters

str NonNullableUtf8StringHandle

Transfer ownership: None Nullable: False

len int

Transfer ownership: None Nullable: False

reqHeaders MessageHeadersHandle

Transfer ownership: None Nullable: False

reqMethod NonNullableUtf8StringOwnedHandle

Transfer ownership: Full Nullable: False

reqPath NonNullableUtf8StringOwnedHandle

Transfer ownership: Full Nullable: False

ver IntPtr

Transfer ownership: Full Nullable: False

Returns

uint

Transfer ownership: None Nullable: False

HeadersParseResponse(NonNullableUtf8StringHandle, int, MessageHeadersHandle, out IntPtr, out uint, out NonNullableUtf8StringOwnedHandle)

Calls native function soup_headers_parse_response.

public static extern bool HeadersParseResponse(NonNullableUtf8StringHandle str, int len, MessageHeadersHandle headers, out IntPtr ver, out uint statusCode, out NonNullableUtf8StringOwnedHandle reasonPhrase)

Parameters

str NonNullableUtf8StringHandle

Transfer ownership: None Nullable: False

len int

Transfer ownership: None Nullable: False

headers MessageHeadersHandle

Transfer ownership: None Nullable: False

ver IntPtr

Transfer ownership: Full Nullable: False

statusCode uint

Transfer ownership: Full Nullable: False

reasonPhrase NonNullableUtf8StringOwnedHandle

Transfer ownership: Full Nullable: False

Returns

bool

Transfer ownership: None Nullable: False

HeadersParseStatusLine(NonNullableUtf8StringHandle, out IntPtr, out uint, out NonNullableUtf8StringOwnedHandle)

Calls native function soup_headers_parse_status_line.

public static extern bool HeadersParseStatusLine(NonNullableUtf8StringHandle statusLine, out IntPtr ver, out uint statusCode, out NonNullableUtf8StringOwnedHandle reasonPhrase)

Parameters

statusLine NonNullableUtf8StringHandle

Transfer ownership: None Nullable: False

ver IntPtr

Transfer ownership: Full Nullable: False

statusCode uint

Transfer ownership: Full Nullable: False

reasonPhrase NonNullableUtf8StringOwnedHandle

Transfer ownership: Full Nullable: False

Returns

bool

Transfer ownership: None Nullable: False

MessageHeadersIterInit(MessageHeadersIterOwnedHandle, MessageHeadersHandle)

Calls native function soup_message_headers_iter_init.

public static extern void MessageHeadersIterInit(MessageHeadersIterOwnedHandle iter, MessageHeadersHandle hdrs)

Parameters

iter MessageHeadersIterOwnedHandle

Transfer ownership: None Nullable: False

hdrs MessageHeadersHandle

Transfer ownership: None Nullable: False

SessionErrorQuark()

Calls native function soup_session_error_quark.

public static extern uint SessionErrorQuark()

Returns

uint

Transfer ownership: None Nullable: False

StatusGetPhrase(uint)

Calls native function soup_status_get_phrase.

public static extern NonNullableUtf8StringUnownedHandle StatusGetPhrase(uint statusCode)

Parameters

statusCode uint

Transfer ownership: None Nullable: False

Returns

NonNullableUtf8StringUnownedHandle

Transfer ownership: None Nullable: False

TldDomainIsPublicSuffix(NonNullableUtf8StringHandle)

Calls native function soup_tld_domain_is_public_suffix.

public static extern bool TldDomainIsPublicSuffix(NonNullableUtf8StringHandle domain)

Parameters

domain NonNullableUtf8StringHandle

Transfer ownership: None Nullable: False

Returns

bool

Transfer ownership: None Nullable: False

TldErrorQuark()

Calls native function soup_tld_error_quark.

public static extern uint TldErrorQuark()

Returns

uint

Transfer ownership: None Nullable: False

TldGetBaseDomain(NonNullableUtf8StringHandle, out ErrorOwnedHandle)

Calls native function soup_tld_get_base_domain.

public static extern NonNullableUtf8StringUnownedHandle TldGetBaseDomain(NonNullableUtf8StringHandle hostname, out ErrorOwnedHandle error)

Parameters

hostname NonNullableUtf8StringHandle

Transfer ownership: None Nullable: False

error ErrorOwnedHandle

Returns

NonNullableUtf8StringUnownedHandle

Transfer ownership: None Nullable: False

UriDecodeDataUri(NonNullableUtf8StringHandle, out NullableUtf8StringOwnedHandle)

Calls native function soup_uri_decode_data_uri.

public static extern BytesOwnedHandle UriDecodeDataUri(NonNullableUtf8StringHandle uri, out NullableUtf8StringOwnedHandle contentType)

Parameters

uri NonNullableUtf8StringHandle

Transfer ownership: None Nullable: False

contentType NullableUtf8StringOwnedHandle

Transfer ownership: Full Nullable: True

Returns

BytesOwnedHandle

Transfer ownership: Full Nullable: False

UriEqual(UriHandle, UriHandle)

Calls native function soup_uri_equal.

public static extern bool UriEqual(UriHandle uri1, UriHandle uri2)

Parameters

uri1 UriHandle

Transfer ownership: None Nullable: False

uri2 UriHandle

Transfer ownership: None Nullable: False

Returns

bool

Transfer ownership: None Nullable: False

WebsocketClientPrepareHandshake(IntPtr, NullableUtf8StringHandle, Utf8StringArrayNullTerminatedHandle, IntPtr)

Calls native function soup_websocket_client_prepare_handshake.

public static extern void WebsocketClientPrepareHandshake(IntPtr msg, NullableUtf8StringHandle origin, Utf8StringArrayNullTerminatedHandle protocols, IntPtr supportedExtensions)

Parameters

msg IntPtr

Transfer ownership: None Nullable: False

origin NullableUtf8StringHandle

Transfer ownership: None Nullable: True

protocols Utf8StringArrayNullTerminatedHandle

Transfer ownership: None Nullable: True

supportedExtensions IntPtr

Transfer ownership: None Nullable: True

WebsocketErrorQuark()

Calls native function soup_websocket_error_quark.

public static extern uint WebsocketErrorQuark()

Returns

uint

Transfer ownership: None Nullable: False

WebsocketServerCheckHandshake(IntPtr, NullableUtf8StringHandle, Utf8StringArrayNullTerminatedHandle, IntPtr, out ErrorOwnedHandle)

Calls native function soup_websocket_server_check_handshake.

public static extern bool WebsocketServerCheckHandshake(IntPtr msg, NullableUtf8StringHandle origin, Utf8StringArrayNullTerminatedHandle protocols, IntPtr supportedExtensions, out ErrorOwnedHandle error)

Parameters

msg IntPtr

Transfer ownership: None Nullable: False

origin NullableUtf8StringHandle

Transfer ownership: None Nullable: True

protocols Utf8StringArrayNullTerminatedHandle

Transfer ownership: None Nullable: True

supportedExtensions IntPtr

Transfer ownership: None Nullable: True

error ErrorOwnedHandle

Returns

bool

Transfer ownership: None Nullable: False