soup/org.gtkkn.bindings.soup/MessageHeaders

MessageHeaders

class MessageHeaders(pointer: <Error class: unknown class><<Error class: unknown class>>)

The HTTP message headers associated with a request or response.

Skipped during bindings generation

parameter disposition: disposition: Out parameter is not supported
parameter start: start: Out parameter is not supported
parameter params: params: Out parameter is not supported
parameter ranges: ranges: Out parameter is not supported

Constructors

MessageHeaders

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

soupMessageHeadersPointer

val soupMessageHeadersPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

append

fun append(name: String, value: String)

Appends a new header with name @name and value @value to @hdrs.

cleanConnectionHeaders

fun cleanConnectionHeaders()

Removes all the headers listed in the Connection header.

clear

fun clear()

Clears @hdrs.

foreach

fun foreach(func: MessageHeadersForeachFunc)

Calls @func once for each header value in @hdrs.

freeRanges

fun freeRanges(ranges: Range)

Frees the array of ranges returned from method@MessageHeaders.get_ranges.

getContentLength

fun getContentLength(): <Error class: unknown class>

Gets the message body length that @hdrs declare.

getEncoding

fun getEncoding(): Encoding

Gets the message body encoding that @hdrs declare.

getExpectations

fun getExpectations(): Expectation

Gets the expectations declared by @hdrs's "Expect" header.

getHeadersType

fun getHeadersType(): MessageHeadersType

Gets the type of headers.

getList

fun getList(name: String): String?

Gets the value of header @name in @hdrs.

getOne

fun getOne(name: String): String?

Gets the value of header @name in @hdrs.

headerContains

fun headerContains(name: String, token: String): Boolean

Checks whether the list-valued header @name is present in @hdrs, and contains a case-insensitive match for @token.

headerEquals

fun headerEquals(name: String, value: String): Boolean

Checks whether the header @name is present in @hdrs and is (case-insensitively) equal to @value.

ref

fun ref(): MessageHeaders

Atomically increments the reference count of @hdrs by one.

remove

fun remove(name: String)

Removes @name from @hdrs.

replace

fun replace(name: String, value: String)

Replaces the value of the header @name in @hdrs with @value.

setContentDisposition

fun setContentDisposition(disposition: String, params: <Error class: unknown class>? = null)

Sets the "Content-Disposition" header in @hdrs to @disposition, optionally with additional parameters specified in @params.

setContentLength

fun setContentLength(contentLength: <Error class: unknown class>)

Sets the message body length that @hdrs will declare, and sets

setContentRange

fun setContentRange(start: <Error class: unknown class>, end: <Error class: unknown class>, totalLength: <Error class: unknown class>)

Sets @hdrs's Content-Range header according to the given values.

setContentType

fun setContentType(contentType: String, params: <Error class: unknown class>? = null)

Sets the "Content-Type" header in @hdrs to @content_type.

setEncoding

fun setEncoding(encoding: Encoding)

Sets the message body encoding that @hdrs will declare.

setExpectations

fun setExpectations(expectations: Expectation)

Sets @hdrs's "Expect" header according to @expectations.

setRange

fun setRange(start: <Error class: unknown class>, end: <Error class: unknown class>)

Sets @hdrs's Range header to request the indicated range.

setRanges

fun setRanges(ranges: Range, length: <Error class: unknown class>)

Sets @hdrs's Range header to request the indicated ranges.

unref

fun unref()

Atomically decrements the reference count of @hdrs by one.