GskUrl
A Universal Resource Locator (or Identifier)
object.
A URL is a pointer to content on the internet.
(Well, not all types of URLs apply across the internet;
especially file URLs are really quite local.)
This class provides convenient parsing and printing methods,
as well as support for downloading the content of various URL types.
Also, we provide interfaces for URL encoding and decoding strings.
This may be used to provide GET data from the HTTP client, amongst other
things.
TODO: find a reference RFC for URL encoding.
A URL (Universal Resource Locator).
This structure contains a number of read-only, pre-parsed
fields, which make it easy to use the URL from C.
It also derived from GObject, so you get the usual g_object_ref/unref
and other usual benefits.
Types of URLs that are known.
(This is an extensible enum-- you can allocate new enum values
using gsk_url_scheme_get_unique()).
@GSK_URL_SCHEME_FILE:
The URL corresponds to a local file.
@GSK_URL_SCHEME_HTTP:
The URL corresponds to HTTP-retrievable content.
@GSK_URL_SCHEME_HTTPS:
The URL corresponds to HTTPS-retrievable content.
HTTPS is secure HTTP: it is just HTTP over SSL.
@GSK_URL_SCHEME_FTP:
The URL corresponds to FTP-retrievable content.
@GSK_URL_SCHEME_OTHER:
An unknown URL scheme was encountered.
[From RFC 2396, section 2.2.]
Characters having specific meaning within a url;
these should be escaped to be passed on to the underlying scheme.
[From RFC 2396, section 2.3.]
Characters which do not normally need escaping within a URL.
@spec:
@error:
@Returns:
@spec:
@context:
@error:
@Returns:
@scheme:
@host:
@port:
@user_name:
@password:
@path:
@query:
@fragment:
@Returns:
@base_url:
@location:
@error:
@Returns:
@url:
@Returns:
@url:
@Returns:
@encoded:
@Returns:
@encoded:
@Returns:
@decoded:
@Returns:
@decoded:
@Returns:
@str:
@bad_char_out:
@str:
@bad_char_out:
@Returns:
@str:
@bad_char_out:
@Returns:
@str:
@bad_char_out:
@str:
@bad_char_out:
@encoded_query:
@Returns:
@url:
@Returns:
Function to call with an input stream if the URL
download request seems to be succeeding.
@stream: content stream of the data referenced
by the URL which was passed to gsk_url_download().
@user_data: data passed to gsk_url_download().
Function to call if the URL
download seems to be failing.
@error: the error that preventing the URL download from starting.
@user_data: data passed to gsk_url_download().
@url:
@success_func:
@failure_func:
@user_data:
Function to parse a string (of a given scheme)
into a #GskUrl. This is used to register new types
of URL. See gsk_url_scheme_get_unique().
@scheme: the type of URL, as determined by the first characters of the URL.
@url: the whole URL.
@data: data passed to gsk_url_scheme_get_unique().
@Returns: a newly allocated URL, or NULL on a parse error.
Function to convert a #GskUrl into a NUL-terminated string.
This is used to register new types
of URL. See gsk_url_scheme_get_unique().
@url: the URL to print.
@data: data passed to gsk_url_scheme_get_unique().
@Returns: a newly allocated C string, or NULL on error.
@url_scheme:
@default_port:
@parse_func:
@print_func:
@data:
@Returns:
@url:
@Returns:
@a:
@b:
@Returns:
Function to begin downloading a given URL.
A function which must eventually call gsk_url_download_fail()
or gsk_url_download_success(). (Note: it may happen long after this
function returns, but it is allowed to call these functions
before returning as well).
This function type is only used to register new methods for downloading URLs.
@download: the object representing the download.
@download_data: data passed in to gsk_url_scheme_add_dl_method().
@scheme:
@download_method:
@download_data:
@download:
@stream:
@download:
@error:
@download:
@Returns:
@download:
@new_url: