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
MessageHeaders.replace.)
The caller is expected to make sure that name and value are
syntactically correct.
the header name to add
the new value of name
Removes all the headers listed in the Connection header.
Clears hdrs.
Calls func once for each header value in hdrs.
Beware that unlike MessageHeaders.get_list, 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 MessageHeaders.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.
callback function to run for each header
Frees the array of ranges returned from MessageHeaders.get_ranges.
an array of Soup.Range
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 Multipart and the associated form methods.
true if hdrs contains a "Content-Disposition" header, false if not (in which case *disposition and *params will be unchanged).
Gets the message body length that hdrs declare.
This will only be non-0 if MessageHeaders.get_encoding returns Soup.Encoding.CONTENT_LENGTH.
the message body length declared by hdrs.
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.
true if hdrs contained a "Content-Range" header containing a byte range which could be parsed, false otherwise.
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.
a string with the value of the "Content-Type" header or null if hdrs does not contain that header or it cannot be parsed (in which case *params will be unchanged).
Gets the expectations declared by hdrs's "Expect" header.
Currently this will either be Soup.Expectation.CONTINUE or Soup.Expectation.UNRECOGNIZED.
the contents of hdrs's "Expect" header
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 MessageHeaders.get_one.
If name appears multiple times in hdrs,
MessageHeaders.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.
header name
the header's value or null if not found.
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 MessageHeaders.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.)
header name
the header's value or null if not found.
Parses hdrs's Range header and returns an array of the requested
byte ranges.
The returned array must be freed with MessageHeaders.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 Range, 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.
Server 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.
the total_length of the response body
true if hdrs contained a syntactically-valid "Range" header, false otherwise (in which case range and length will not be set).
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
header_contains on its value.)
header name
token to look for
true if the header is present and contains token, false otherwise.
Checks whether the header name is present in hdrs and is
(case-insensitively) equal to value.
header name
expected value
true if the header is present and its value is value, false otherwise.
Atomically increments the reference count of hdrs by one.
the passed in Soup.MessageHeaders
Removes name from hdrs.
If there are multiple values for name, they are all removed.
the header name to remove
Replaces the value of the header name in hdrs with value.
See also MessageHeaders.append.
The caller is expected to make sure that name and value are
syntactically correct.
the header name to replace
the new value of name
Sets the "Content-Disposition" header in hdrs to disposition,
optionally with additional parameters specified in params.
See MessageHeaders.get_content_disposition for a discussion of how Content-Disposition is used in HTTP.
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
MessageHeaders.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.
the message body length
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.)
Server has built-in handling for range requests, and you do not normally need to call this function youself. See MessageHeaders.get_ranges for more details.
the start of the range
the end of the range
the total length of the resource, or -1 if unknown
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.
the expectations to set
Sets hdrs's Range header to request the indicated range.
start and end are interpreted as in a Range.
If you need to request multiple ranges, use MessageHeaders.set_ranges.
the start of the range to request
the end of the range to request
Sets hdrs's Range header to request the indicated ranges.
If you only want to request a single range, you can use MessageHeaders.set_range.
an array of Soup.Range
the length of range
Atomically decrements the reference count of hdrs by one.
When the reference count reaches zero, the resources allocated by
hdrs are freed
Staticnew
The HTTP message headers associated with a request or response.