MessageHeaders

---

Object Hierarchy:

Description:

Content:

Creation methods:

• public MessageHeaders (MessageHeadersType type)
  Creates a MessageHeaders. (#SoupMessage does this automatically for its own headers. You would only need to use this method if you are manually parsing or generating message headers.)

Methods:

• public void append (string name, string value)
  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 replace.)
• public void clear ()
  Clears hdrs.
• public void foreach (MessageHeadersForeachFunc func)
  Calls func once for each header value in hdrs.
• public void free ()
  Frees hdrs.
• public void free_ranges (Range ranges)
  Frees the array of ranges returned from get_ranges.
• public unowned string get (string name)
  Gets the value of header name in hdrs.
• public bool get_content_disposition (out string disposition, out HashTable<string,string> params)
  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.
• public int64 get_content_length ()
  Gets the message body length that hdrs declare. This will only be non-0 if get_encoding returns CONTENT_LENGTH.
• public bool get_content_range (int64 start, int64 end, int64 total_length)
  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.
• public unowned string get_content_type (out HashTable<string,string> params)
  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.
• public Encoding get_encoding ()
  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.
• public Expectation get_expectations ()
  Gets the expectations declared by hdrs's "Expect" header. Currently this will either be CONTINUE or UNRECOGNIZED.
• public unowned string get_list (string name)
  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 get_one.
• public unowned string get_one (string name)
  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 get_list.
• public bool get_ranges (int64 total_length, out Range ranges, int length)
  Parses hdrs's Range header and returns an array of the requested byte ranges. The returned array must be freed with free_ranges.
• public void remove (string name)
  Removes name from hdrs. If there are multiple values for name, they are all removed.
• public void replace (string name, string value)
  Replaces the value of the header name in hdrs with value. (See also append.)
• public void set_content_disposition (string disposition, HashTable<string,string>? params)
  Sets the "Content-Disposition" header in hdrs to disposition, optionally with additional parameters specified in params.
• public void set_content_length (int64 content_length)
  Sets the message body length that hdrs will declare, and sets hdrs's encoding to CONTENT_LENGTH.
• public void set_content_range (int64 start, int64 end, int64 total_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.)
• public void set_content_type (string content_type, HashTable<string,string>? params)
  Sets the "Content-Type" header in hdrs to content_type, optionally with additional parameters specified in params.
• public void set_encoding (Encoding encoding)
  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.
• public void set_expectations (Expectation expectations)
  Sets hdrs's "Expect" header according to expectations.
• public void set_range (int64 start, int64 end)
  Sets hdrs's Range header to request the indicated range. start and end are interpreted as in a Range.
• public void set_ranges (Range ranges, int length)
  Sets hdrs's Range header to request the indicated ranges. (If you only want to request a single range, you can use set_range.)