GskHttpResponse

typedef struct _GskHttpResponse GskHttpResponse;

An instance of a HTTP response header.

gsk_http_response_new_blank ()

GskHttpResponse* gsk_http_response_new_blank
                                            (void);

Create a new, empty default response.

gsk_http_response_new_redirect ()

GskHttpResponse* gsk_http_response_new_redirect
                                            (const char *location);

Create a redirection HTTP response header.

We use the 302 ("Found") status code.

gsk_http_response_from_request ()

GskHttpResponse* gsk_http_response_from_request
                                            (GskHttpRequest *request,
                                             GskHttpStatus status_code,
                                             gssize length);

Create a response which macthes the request, with a caller-supplied status code and optional length.

gsk_http_response_process_first_line ()

gboolean    gsk_http_response_process_first_line
                                            (GskHttpResponse *response,
                                             const char *line);

Parse the first line of an HTTP response.

gsk_http_response_set_status_code()

#define     gsk_http_response_set_status_code(response, status)

Set what kind of response is going to be given. See GskHttpStatus for a description of all the status codes defined in HTTP/1.1 (RFC 2616).

gsk_http_response_get_status_code()

#define     gsk_http_response_get_status_code(response)

Query the status code from a response.

gsk_http_response_set_allowed_verbs ()

void        gsk_http_response_set_allowed_verbs
                                            (GskHttpResponse *response,
                                             guint allowed);

Set the Allow: header to indicate a particular set of HTTP verbs are allowed from the client. If you give a request with a verb which is not allowed, you should get a GSK_HTTP_STATUS_METHOD_NOT_ALLOWED response. That response MUST have an Allow: header.

gsk_http_response_get_allowed_verbs()

#define     gsk_http_response_get_allowed_verbs(header)

Get the bitmask of verbs allowed by the server, according to the Allow: header line.

XXX: what should happen in the absence of an Allow header????

gsk_http_response_set_age()

#define     gsk_http_response_set_age(response, age)

Set the age of a response. This is only used for cached responses. It tells the length of time that the data has been sitting in the cache. [See RFC 2616, Section 14.6]

gsk_http_response_get_age()

#define     gsk_http_response_get_age(response)

Get the age of a response. This is only used for cached responses. It tells the length of time that the data has been sitting in the cache. [See RFC 2616, Section 14.6]

If there is no Age field, -1 is returned.

gsk_http_response_set_location()

#define     gsk_http_response_set_location(response, location)

[RFC 2616, 14.30] The Location response-header field is used to redirect the recipient to a location other than the Request-URI for completion of the request or identification of a new resource. For 201 (Created) responses, the Location is that of the new resource which was created by the request. For 3xx responses, the location SHOULD indicate the server's preferred URI for automatic redirection to the resource. The field value consists of a single absolute URI.

gsk_http_response_peek_location()

#define     gsk_http_response_peek_location(response)

Peek at the destination for a redirect. May return NULL if there is no redirect planned.

gsk_http_response_set_etag()

#define     gsk_http_response_set_etag(response, etag)

Provide a unique tag for the content- this may be used by caches and proxy servers.

[RFC 2616, 14.19] The ETag response-header field provides the current value of the entity tag for the requested variant. The headers used with entity

This is typically used in conjunction with the If-Match, If-None-Match, and Vary. 14.24, 14.26 and 14.44, 13.3.3.

gsk_http_response_peek_etag()

#define     gsk_http_response_peek_etag(response)

Get the entity-tag for this content from the header. This is NULL by default, to indicate that there is no ETag field.

gsk_http_response_set_cache_control ()

void        gsk_http_response_set_cache_control
                                            (GskHttpResponse *response,
                                             GskHttpResponseCacheDirective *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_response_peek_cache_control()

#define     gsk_http_response_peek_cache_control(response)

Obtain the GskHttpCacheDirective associated with the response.

gsk_http_response_set_last_modified()

#define     gsk_http_response_set_last_modified(response, last_modified)

[RFC 2616, Section 14.29] The Last-Modified entity-header field indicates the date and time at which the origin server believes the variant was last modified.

If the time is -1, then there will be no Last-Modified header printed.

gsk_http_response_get_last_modified()

#define     gsk_http_response_get_last_modified(response)

Get the time that the response advertises that the content was last modified. It returns -1 if there will be no such indication.

gsk_http_response_set_expires()

#define     gsk_http_response_set_expires(response, expires)

[From RFC 2616, Section 14.21] The Expires entity-header field gives the date/time after which the response is considered stale. A stale cache entry may not normally be returned by a cache (either a proxy cache or a user agent cache) unless it is first validated with the origin server (or with an intermediate cache that has a fresh copy of the entity). See section 13.2 for further discussion of the expiration model.

The presence of an Expires field does not imply that the original resource will change or cease to exist at, before, or after that time.

gsk_http_response_get_expires()

#define     gsk_http_response_get_expires(response)

Get the expiration time for this content, or -1 if no expiration time given.

gsk_http_response_set_md5 ()

void        gsk_http_response_set_md5       (GskHttpResponse *response,
                                             const guint8 *md5sum);

Set the MD5 field of the HTTP response to the given md5sum. GSK does not attempt to verify the MD5 sum; the caller should be sure they have the right MD5 sum.

gsk_http_response_peek_md5 ()

const guint8* gsk_http_response_peek_md5    (GskHttpResponse *response);

Get the MD5 sum associated with this response. (It should be the MD5 sum of the content stream).

It will return NULL if there is no associated content MD5 sum. This is the default state.

gsk_http_response_set_server()

#define     gsk_http_response_set_server(response, server)

Set the server name of this HTTP header. This may be any ASCII string.

See RFC 2616, Section 14.38.

gsk_http_response_peek_server()

#define     gsk_http_response_peek_server(response)

Obtain a reference to the type of server from which this response came, as a C string. This field is optional, but is helpful for debugging, etc.

gsk_http_response_set_retry_after ()

void        gsk_http_response_set_retry_after
                                            (GskHttpResponse *response,
                                             gboolean is_relative,
                                             glong time);

Set the Retry-After header for this response.

[From RFC 2616, Section 14.37] The Retry-After response-header field can be used with a 503 (Service Unavailable) response to indicate how long the service is expected to be unavailable to the requesting client. This field MAY also be used with any 3xx (Redirection) response to indicate the minimum time the user-agent is asked wait before issuing the redirected request.

gsk_http_response_set_no_retry_after ()

void        gsk_http_response_set_no_retry_after
                                            (GskHttpResponse *response);

Clear the Retry-After header for this response.

gsk_http_response_set_authenticate ()

void        gsk_http_response_set_authenticate
                                            (GskHttpResponse *response,
                                             gboolean is_proxy_auth,
                                             GskHttpAuthenticate *auth);

Set the authentication for this response. 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_response_peek_authenticate ()

GskHttpAuthenticate* gsk_http_response_peek_authenticate
                                            (GskHttpResponse *response,
                                             gboolean is_proxy_auth);

Get the responseed authentication information.

gsk_http_response_has_content_body ()

gboolean    gsk_http_response_has_content_body
                                            (GskHttpResponse *response,
                                             GskHttpRequest *request);

Find out whether a HTTP Response should be accompanied by a body.

It also depends on the request, in particular, HEAD requests do not retrieve bodies.

gsk_http_response_cache_directive_free ()

void        gsk_http_response_cache_directive_free
                                            (GskHttpResponseCacheDirective *directive);

Deallocate a GskHttpResponseCacheDirective.

gsk_http_response_cache_directive_new ()

GskHttpResponseCacheDirective* gsk_http_response_cache_directive_new
                                            (void);

gsk_http_response_cache_directive_set_no_cache_name ()

void        gsk_http_response_cache_directive_set_no_cache_name
                                            (GskHttpResponseCacheDirective *directive,
                                             const char *name,
                                             gsize name_len);

Intended for more detailed specification of no-cache data, which is never supposed to be cached.

[RFC 2616, 14.9.1] If the no-cache directive does specify one or more field-names, then a cache MAY use the response to satisfy a subsequent request, subject to any other restrictions on caching. However, the specified field-name(s) MUST NOT be sent in the response to a subsequent request without successful revalidation with the origin server. This allows an origin server to prevent the re-use of certain header fields in a response, while still allowing caching of the rest of the response.

good luck.

gsk_http_response_cache_directive_set_private_name ()

void        gsk_http_response_cache_directive_set_private_name
                                            (GskHttpResponseCacheDirective *directive,
                                             const char *name,
                                             gsize name_len);

Intended for more detailed specification of private cache data.

gsk_http_response_get_content_subtype

#define gsk_http_response_get_content_subtype gsk_http_header_get_content_subtype

gsk_http_response_get_content_type

#define gsk_http_response_get_content_type gsk_http_header_get_content_type

gsk_http_response_set_content_subtype

#define gsk_http_response_set_content_subtype gsk_http_header_set_content_subtype

gsk_http_response_set_content_type

#define gsk_http_response_set_content_type gsk_http_header_set_content_type

The "age" property

  "age"                  glong                 : Read / Write

Age of content.

Allowed values: >= -1

Default value: -1

The "e-tag" property

  "e-tag"                gchararray            : Read / Write

Unique identifier for this content.

Default value: NULL

The "expires" property

  "expires"              glong                 : Read / Write

Length of time to wait for content to expire.

Allowed values: >= -1

Default value: -1

The "last-modified" property

  "last-modified"        glong                 : Read / Write

Time this content was last changed.

Allowed values: >= -1

Default value: -1

The "location" property

  "location"             gchararray            : Read / Write

The URL of the content, for redirect responses.

Default value: NULL

The "server" property

  "server"               gchararray            : Read / Write

Name of this webserver program.

Default value: NULL

The "status-code" property

  "status-code"          GskHttpStatus         : Read / Write

HTTP status code.

Default value: GSK_HTTP_STATUS_OK