GskHttpRequest

typedef struct {
  /* the command: GET, PUT, POST, HEAD, etc */
  GskHttpVerb                   verb;

  /* Note that HTTP/1.1 servers must accept the entire
   * URL being included in `path'! (maybe including http:// ... */
  char                         *path;

  GskHttpCharSet           *accept_charsets;              /* Accept-CharSet */
  GskHttpContentEncodingSet*accept_content_encodings;     /* Accept-Encoding */
  GskHttpTransferEncodingSet*accept_transfer_encodings;   /* TE */
  GskHttpMediaTypeSet      *accept_media_types;           /* Accept */
  GskHttpAuthorization     *authorization;                /* Authorization */
  GskHttpLanguageSet       *accept_languages;             /* Accept-Languages */
  char                     *host;                         /* Host */

  gboolean                  had_if_match;
  char                    **if_match;             /* If-Match */
  glong                     if_modified_since;    /* If-Modified-Since */
  char                     *user_agent;           /* User-Agent */

  char                     *referrer;             /* Referer */

  char                     *from;      /* The From: header (sect 14.22) */

  /* List of Cookie: headers. */
  GSList                   *cookies;

  GskHttpAuthorization     *proxy_auth;

  int                       keep_alive_seconds;   /* -1 if not used */

  /* rarely used: */
  int                       max_forwards;         /* -1 if not used */

  /* Nonstandard User-Agent information.
     Many browsers provide this data to allow
     dynamic content to take advantage of the
     client configuration.  (0 indicated "not supplied").  */
  unsigned                  ua_width, ua_height;
  char                     *ua_color;
  char                     *ua_os;
  char                     *ua_cpu;
  char                     *ua_language;

  GskHttpRequestCacheDirective *cache_control;        /* Cache-Control */
} GskHttpRequest;

An instance of a HTTP request header.

gsk_http_request_add_cookie ()

void        gsk_http_request_add_cookie     (GskHttpRequest *header,
                                             GskHttpCookie *cookie);

Add a Cookie header line to a request.

Cookies are defined in RFC 2965, a draft standard.

[Section 3.3.4] Sending Cookies to the Origin Server. When [the user-agent] sends a request to an origin server, the user agent includes a Cookie request header if it has stored cookies that are applicable to the request, based on (1) the request-host and request-port; (2) the request-URI; (3) the cookie's age.

gsk_http_request_remove_cookie ()

void        gsk_http_request_remove_cookie  (GskHttpRequest *header,
                                             GskHttpCookie *cookie);

Remove a cookie from the request's list and delete it.

gsk_http_request_find_cookie ()

GskHttpCookie* gsk_http_request_find_cookie (GskHttpRequest *header,
                                             const char *key);

Find a cookie provided in the request by key.

gsk_http_request_add_charsets ()

void        gsk_http_request_add_charsets   (GskHttpRequest *header,
                                             GskHttpCharSet *char_sets);

Add Accept-CharSet headers to the header. The char-sets will be freed when header is destroyed.

A CharSet is a string representing a Character Set, and an optional real quality factor for that particular Character Set. (The default is 1.0)

The CharSet "*" matches all other Character Sets. If no "*" is given, then it is as though all other character sets were given a quality of 0.0.

If no Accept-CharSet header is given, then all character sets are equally acceptable.

If a server cannot meet character set requirements, it SHOULD response with an error (GSK_HTTP_STATUS_NOT_ACCEPTABLE) but it may also ignore it, and send output in a character-set the client has not suggested.

See RFC 2616, Section 14.2.

gsk_http_request_clear_charsets ()

void        gsk_http_request_clear_charsets (GskHttpRequest *header);

Delete all accepted char-sets from the HTTP request.

This has the effect of leaving a server free to use any character set.

gsk_http_request_add_content_encodings ()

void        gsk_http_request_add_content_encodings
                                            (GskHttpRequest *header,
                                             GskHttpContentEncodingSet *set);

Add Accept-Encoding lines to the header. Each GskHttpContentEncodingSet represents a single possible encoding and an optional associated quality factor.

The rules for conduct are the same as for character set, with the exception that if no Accept-Encoding line is given then the 'identity' encoding should be preferred.

Note that the GSK http server and client handle content encoding automatically, and will do the correct thing without your intervention.

See RFC 2616, Section 14.3.

gsk_http_request_clear_content_encodings ()

void        gsk_http_request_clear_content_encodings
                                            (GskHttpRequest *header);

Delete all accepted encodings from the HTTP request.

This has the effect of leaving a server free to use any content encoding.

gsk_http_request_add_transfer_encodings ()

void        gsk_http_request_add_transfer_encodings
                                            (GskHttpRequest *header,
                                             GskHttpTransferEncodingSet *set);

The rules for conduct are the same as for character set, with the exception that the defaults are 'none' for HTTP 1.0 clients, and 'none' and 'chunked' for HTTP 1.1 clients.

Note that the GSK http server and client handle content encoding automatically, and will do the correct thing without your intervention.

This corresponds to the TE: header. See RFC 2616, Section 14.39.

gsk_http_request_clear_transfer_encodings ()

void        gsk_http_request_clear_transfer_encodings
                                            (GskHttpRequest *header);

Delete all accepted transfer encodings from the HTTP request.

This has the effect of leaving a server free to use just no encoding for HTTP 1.0 clients and also 'chunked' for HTTP 1.1 clients.

gsk_http_request_add_media ()

void        gsk_http_request_add_media      (GskHttpRequest *header,
                                             GskHttpMediaTypeSet *set);

Add Accept: headers to the header. The media-type-sets will be freed when header is destroyed.

A MediaSet is a range of media accepted, with quality factors as for gsk_http_request_add_charsets().

Note that '*' in a subtype applies to all media with that major type, but if a specific subtype matches, then it's quality is given priority.

XXX: Also, there is an accept-extension 'level='... find out what it does!

See RFC 2616, Section 14.1.

gsk_http_request_clear_media ()

void        gsk_http_request_clear_media    (GskHttpRequest *header);

Delete all accepted media-type-sets from the HTTP request.

gsk_http_request_new_blank ()

GskHttpRequest* gsk_http_request_new_blank  (void);

Create a new empty HTTP request.

gsk_http_request_new ()

GskHttpRequest* gsk_http_request_new        (GskHttpVerb verb,
                                             const char *path);

Create a new simple HTTP request.

gsk_http_request_set_verb()

#define     gsk_http_request_set_verb(request, verb)

The verb is GSK's name for the type of action being requested. It is the very first word of the HTTP transaction. See GskHttpVerb for a list.

gsk_http_request_get_verb()

#define gsk_http_request_get_verb(request) (GSK_HTTP_REQUEST(request)->verb)

Get the type of action being requested. See GskHttpVerb for a list.

Every HTTP server should know GET and HEAD requested; other requests might not be allowed unless the server had indicated that they are with a "Allow" response header.

gsk_http_request_peek_from()

#define     gsk_http_request_peek_from(request)

Get the From field, if any, from the HTTP header.

gsk_http_request_set_from()

#define     gsk_http_request_set_from(request, from)

[From RFC 2616, Section 14.22] The From request-header field, if given, SHOULD contain an Internet e-mail address for the human user who controls the requesting user agent. The address SHOULD be machine-usable, as defined by "mailbox" in RFC 822 as updated by RFC 1123.

gsk_http_request_set_if_modified_since()

#define     gsk_http_request_set_if_modified_since(request, t)

[From RFC 2616, Section 14.25] The If-Modified-Since request-header field is used with a method to make it conditional: if the requested variant has not been modified since the time specified in this field, an entity will not be returned from the server; instead, a 304 (not modified) response will be returned without any message-body.

gsk_http_request_get_if_modified_since()

#define     gsk_http_request_get_if_modified_since(request)

Get the time which will be compared with the content's modification time by the server to eliminate unnecessary content transfers. If this returns (time_t)-1 then there is no If-Modified-Since header.

gsk_http_request_set_authorization ()

void        gsk_http_request_set_authorization
                                            (GskHttpRequest *request,
                                             gboolean is_proxy_auth,
                                             GskHttpAuthorization *auth);

Set the authorization for this request. This is like a key to get access to certain entities.

Proxy-Authorization is intended to provide access control to the proxy. Normal Authorization is passed through a proxy. See sections 14.8 for normal Authorization and 14.34.

gsk_http_request_set_host()

#define     gsk_http_request_set_host(request, host)

Set the Host: header for the HTTP request.

gsk_http_request_set_user_agent()

#define     gsk_http_request_set_user_agent(request, user_agent)

gsk_http_request_peek_user_agent()

#define     gsk_http_request_peek_user_agent(request)

gsk_http_request_peek_authorization ()

GskHttpAuthorization* gsk_http_request_peek_authorization
                                            (GskHttpRequest *request,
                                             gboolean is_proxy_auth);

Get the requested authorization information.

gsk_http_request_cache_directive_free ()

void        gsk_http_request_cache_directive_free
                                            (GskHttpRequestCacheDirective *directive);

Deallocate a GskHttpRequestCacheDirective.

gsk_http_request_cache_directive_new ()

GskHttpRequestCacheDirective* gsk_http_request_cache_directive_new
                                            (void);

gsk_http_request_parse_first_line ()

GskHttpRequestFirstLineStatus gsk_http_request_parse_first_line
                                            (GskHttpRequest *request,
                                             const char *line,
                                             GError **error);

Parse the first line of an HTTP request.

gsk_http_request_set_cache_control ()

void        gsk_http_request_set_cache_control
                                            (GskHttpRequest *request,
                                             GskHttpRequestCacheDirective *directive);

Set the cache-control flags in the header. Note that directive will be freed by the HTTP header when it is destroyed.

gsk_http_request_has_content_body ()

gboolean    gsk_http_request_has_content_body
                                            (GskHttpRequest *request);

Get whether this header should be accompanied by a content-body.

gsk_http_parse_cgi_query_string ()

char**      gsk_http_parse_cgi_query_string (const char *query_string,
                                             GError **error);

Parse the CGI key-value pairs from a query. The keys are normal alphanumeric strings; the values are de-escaped.

gsk_http_request_parse_cgi_query_string ()

GHashTable* gsk_http_request_parse_cgi_query_string
                                            (const char *query_string);

The "host" property

  "host"                 gchararray            : Read / Write

Hostname.

Default value: NULL

The "if-modified-since" property

  "if-modified-since"    glong                 : Read / Write

IMS tag.

Allowed values: >= -1

Default value: -1

The "max-forwards" property

  "max-forwards"         glong                 : Read / Write

IMax-Forwards.

Allowed values: [-1,32]

Default value: -1

The "path" property

  "path"                 gchararray            : Read / Write

Path.

Default value: NULL

The "referrer" property

  "referrer"             gchararray            : Read / Write

Referrer.

Default value: NULL

The "user-agent" property

  "user-agent"           gchararray            : Read / Write

User Agent.

Default value: NULL

The "verb" property

  "verb"                 GskHttpVerb           : Read / Write

verb.

Default value: GSK_HTTP_VERB_GET