Gjsify LogoGjsify Logo

The HTTP message headers associated with a request or response.

record

Hierarchy

  • MessageHeaders

Index

Constructors

Properties

name: string

Methods

  • append(name: string, value: string): void
  • Appends a new header with name name and value value to hdrs. (If there is an existing header with name name, then this creates a second one, which is only allowed for list-valued headers; see also soup_message_headers_replace().)

    The caller is expected to make sure that name and value are syntactically correct.

    Parameters

    • name: string

      the header name to add

    • value: string

      the new value of name

    Returns void

  • clean_connection_headers(): void
  • clear(): void
  • Calls func once for each header value in hdrs.

    Beware that unlike soup_message_headers_get(), this processes the headers in exactly the way they were added, rather than concatenating multiple same-named headers into a single value. (This is intentional; it ensures that if you call soup_message_headers_append() multiple times with the same name, then the I/O code will output multiple copies of the header when sending the message to the remote implementation, which may be required for interoperability in some cases.)

    You may not modify the headers from func.

    Parameters

    Returns void

  • free(): void
  • get(name: string): string
  • Gets the value of header name in hdrs.

    This method was supposed to work correctly for both single-valued and list-valued headers, but because some HTTP clients/servers mistakenly send multiple copies of headers that are supposed to be single-valued, it sometimes returns incorrect results. To fix this, the methods soup_message_headers_get_one() and soup_message_headers_get_list() were introduced, so callers can explicitly state which behavior they are expecting.

    Parameters

    • name: string

      header name

    Returns string

  • get_content_disposition(): [boolean, string, HashTable<string | number | symbol, string | number | boolean>]
  • Looks up the "Content-Disposition" header in hdrs, parses it, and returns its value in *disposition and *params. params can be %NULL if you are only interested in the disposition-type.

    In HTTP, the most common use of this header is to set a disposition-type of "attachment", to suggest to the browser that a response should be saved to disk rather than displayed in the browser. If params contains a "filename" parameter, this is a suggestion of a filename to use. (If the parameter value in the header contains an absolute or relative path, libsoup will truncate it down to just the final path component, so you do not need to test this yourself.)

    Content-Disposition is also used in "multipart/form-data", however this is handled automatically by #SoupMultipart and the associated form methods.

    Returns [boolean, string, HashTable<string | number | symbol, string | number | boolean>]

  • get_content_length(): number
  • Gets the message body length that hdrs declare. This will only be non-0 if soup_message_headers_get_encoding() returns %SOUP_ENCODING_CONTENT_LENGTH.

    Returns number

  • get_content_range(): [boolean, number, number, number]
  • Parses hdrs's Content-Range header and returns it in start, end, and total_length. If the total length field in the header was specified as "*", then total_length will be set to -1.

    Returns [boolean, number, number, number]

  • get_content_type(): [string, HashTable<string | number | symbol, string | number | boolean>]
  • Looks up the "Content-Type" header in hdrs, parses it, and returns its value in *content_type and *params. params can be %NULL if you are only interested in the content type itself.

    Returns [string, HashTable<string | number | symbol, string | number | boolean>]

  • Gets the message body encoding that hdrs declare. This may not always correspond to the encoding used on the wire; eg, a HEAD response may declare a Content-Length or Transfer-Encoding, but it will never actually include a body.

    Returns Soup.Encoding

  • get_list(name: string): string
  • Gets the value of header name in hdrs. Use this for headers whose values are comma-delimited lists, and which are therefore allowed to appear multiple times in the headers. For non-list-valued headers, use soup_message_headers_get_one().

    If name appears multiple times in hdrs, soup_message_headers_get_list() will concatenate all of the values together, separated by commas. This is sometimes awkward to parse (eg, WWW-Authenticate, Set-Cookie), but you have to be able to deal with it anyway, because the HTTP spec explicitly states that this transformation is allowed, and so an upstream proxy could do the same thing.

    Parameters

    • name: string

      header name

    Returns string

  • get_one(name: string): string
  • Gets the value of header name in hdrs. Use this for headers whose values are not comma-delimited lists, and which therefore can only appear at most once in the headers. For list-valued headers, use soup_message_headers_get_list().

    If hdrs does erroneously contain multiple copies of the header, it is not defined which one will be returned. (Ideally, it will return whichever one makes libsoup most compatible with other HTTP implementations.)

    Parameters

    • name: string

      header name

    Returns string

  • get_ranges(total_length: number): [boolean, Soup.Range[]]
  • Parses hdrs's Range header and returns an array of the requested byte ranges. The returned array must be freed with soup_message_headers_free_ranges().

    If total_length is non-0, its value will be used to adjust the returned ranges to have explicit start and end values, and the returned ranges will be sorted and non-overlapping. If total_length is 0, then some ranges may have an end value of -1, as described under #SoupRange, and some of the ranges may be redundant.

    Beware that even if given a total_length, this function does not check that the ranges are satisfiable.

    #SoupServer has built-in handling for range requests. If your server handler returns a %SOUP_STATUS_OK response containing the complete response body (rather than pausing the message and returning some of the response body later), and there is a Range header in the request, then libsoup will automatically convert the response to a %SOUP_STATUS_PARTIAL_CONTENT response containing only the range(s) requested by the client.

    The only time you need to process the Range header yourself is if either you need to stream the response body rather than returning it all at once, or you do not already have the complete response body available, and only want to generate the parts that were actually requested by the client.

    Parameters

    • total_length: number

      the total_length of the response body

    Returns [boolean, Soup.Range[]]

  • header_contains(name: string, token: string): boolean
  • Checks whether the list-valued header name is present in hdrs, and contains a case-insensitive match for token.

    (If name is present in hdrs, then this is equivalent to calling soup_header_contains() on its value.)

    Parameters

    • name: string

      header name

    • token: string

      token to look for

    Returns boolean

  • header_equals(name: string, value: string): boolean
  • Checks whether the header name is present in hdrs and is (case-insensitively) equal to value.

    Parameters

    • name: string

      header name

    • value: string

      expected value

    Returns boolean

  • remove(name: string): void
  • Removes name from hdrs. If there are multiple values for name, they are all removed.

    Parameters

    • name: string

      the header name to remove

    Returns void

  • replace(name: string, value: string): void
  • Replaces the value of the header name in hdrs with value. (See also soup_message_headers_append().)

    The caller is expected to make sure that name and value are syntactically correct.

    Parameters

    • name: string

      the header name to replace

    • value: string

      the new value of name

    Returns void

  • set_content_disposition(disposition: string, params: HashTable<string | number | symbol, string | number | boolean>): void
  • Sets the "Content-Disposition" header in hdrs to disposition, optionally with additional parameters specified in params.

    See soup_message_headers_get_content_disposition() for a discussion of how Content-Disposition is used in HTTP.

    Parameters

    • disposition: string

      the disposition-type

    • params: HashTable<string | number | symbol, string | number | boolean>

      additional parameters, or %NULL

    Returns void

  • set_content_length(content_length: number): void
  • Sets the message body length that hdrs will declare, and sets hdrs's encoding to %SOUP_ENCODING_CONTENT_LENGTH.

    You do not normally need to call this; if hdrs is set to use Content-Length encoding, libsoup will automatically set its Content-Length header for you immediately before sending the headers. One situation in which this method is useful is when generating the response to a HEAD request; Calling soup_message_headers_set_content_length() allows you to put the correct content length into the response without needing to waste memory by filling in a response body which won't actually be sent.

    Parameters

    • content_length: number

      the message body length

    Returns void

  • set_content_range(start: number, end: number, total_length: number): void
  • Sets hdrs's Content-Range header according to the given values. (Note that total_length is the total length of the entire resource that this is a range of, not simply end - start + 1.)

    #SoupServer has built-in handling for range requests, and you do not normally need to call this function youself. See soup_message_headers_get_ranges() for more details.

    Parameters

    • start: number

      the start of the range

    • end: number

      the end of the range

    • total_length: number

      the total length of the resource, or -1 if unknown

    Returns void

  • set_content_type(content_type: string, params: HashTable<string | number | symbol, string | number | boolean>): void
  • Sets the "Content-Type" header in hdrs to content_type, optionally with additional parameters specified in params.

    Parameters

    • content_type: string

      the MIME type

    • params: HashTable<string | number | symbol, string | number | boolean>

      additional parameters, or %NULL

    Returns void

  • Sets the message body encoding that hdrs will declare. In particular, you should use this if you are going to send a request or response in chunked encoding.

    Parameters

    Returns void

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

    Currently %SOUP_EXPECTATION_CONTINUE is the only known expectation value. You should set this value on a request if you are sending a large message body (eg, via POST or PUT), and want to give the server a chance to reject the request after seeing just the headers (eg, because it will require authentication before allowing you to post, or because you're POSTing to a URL that doesn't exist). This saves you from having to transmit the large request body when the server is just going to ignore it anyway.

    Parameters

    Returns void

  • set_range(start: number, end: number): void
  • Sets hdrs's Range header to request the indicated range. start and end are interpreted as in a #SoupRange.

    If you need to request multiple ranges, use soup_message_headers_set_ranges().

    Parameters

    • start: number

      the start of the range to request

    • end: number

      the end of the range to request

    Returns void

  • set_ranges(ranges: Soup.Range, length: number): void
  • Sets hdrs's Range header to request the indicated ranges. (If you only want to request a single range, you can use soup_message_headers_set_range().)

    Parameters

    • ranges: Soup.Range

      an array of #SoupRange

    • length: number

      the length of range

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method