diff options
| author | Dan Winship <danw@src.gnome.org> | 2005-06-14 15:34:22 +0000 |
|---|---|---|
| committer | Dan Winship <danw@src.gnome.org> | 2005-06-14 15:34:22 +0000 |
| commit | 5069f32c25a4a1ef85b698d9cbd283418c8a8de7 (patch) | |
| tree | a84274aea41d69681642a5135b2f70f7e2a76f6d /docs/reference/tmpl | |
| parent | 4d7ce6c1f91c2f8da1be6ace4ba45325e59d7c19 (diff) | |
| download | libsoup-5069f32c25a4a1ef85b698d9cbd283418c8a8de7.tar.gz libsoup-5069f32c25a4a1ef85b698d9cbd283418c8a8de7.tar.bz2 libsoup-5069f32c25a4a1ef85b698d9cbd283418c8a8de7.zip | |
add/fix gtk-doc comments, make functions match prototypes, etc
* libsoup/*.[ch]: add/fix gtk-doc comments, make functions match
prototypes, etc
* docs/reference/*: update, fix, etc
Diffstat (limited to 'docs/reference/tmpl')
28 files changed, 1535 insertions, 833 deletions
diff --git a/docs/reference/tmpl/libsoup-unused.sgml b/docs/reference/tmpl/libsoup-unused.sgml index ab933b6e..fd309be5 100644 --- a/docs/reference/tmpl/libsoup-unused.sgml +++ b/docs/reference/tmpl/libsoup-unused.sgml @@ -1,195 +1,575 @@ -<!-- ##### SECTION ./tmpl/soup-marshal.sgml:Long_Description ##### --> +<!-- ##### SECTION ./tmpl/soup-auth-basic.sgml:Long_Description ##### --> <para> +This implements the Basic HTTP Authentication mechanism, as described +in RFC 2617. It is created automatically by #SoupSession when needed. +</para> + + +<!-- ##### SECTION ./tmpl/soup-auth-basic.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/soup-auth-basic.sgml:Short_Description ##### --> +HTTP Basic Authentication + +<!-- ##### SECTION ./tmpl/soup-auth-basic.sgml:Title ##### --> +SoupAuthBasic + + +<!-- ##### SECTION ./tmpl/soup-auth-digest.sgml:Long_Description ##### --> +<para> +This implements the Digest HTTP Authentication mechanism, as described +in RFC 2617. It is created automatically by #SoupSession when needed. </para> -<!-- ##### SECTION ./tmpl/soup-marshal.sgml:See_Also ##### --> +<!-- ##### SECTION ./tmpl/soup-auth-digest.sgml:See_Also ##### --> <para> </para> -<!-- ##### SECTION ./tmpl/soup-marshal.sgml:Short_Description ##### --> +<!-- ##### SECTION ./tmpl/soup-auth-digest.sgml:Short_Description ##### --> +HTTP Digest Authentication +<!-- ##### SECTION ./tmpl/soup-auth-digest.sgml:Title ##### --> +SoupAuthDigest -<!-- ##### SECTION ./tmpl/soup-marshal.sgml:Title ##### --> -soup-marshal + +<!-- ##### SECTION ./tmpl/soup-md5-utils.sgml:Long_Description ##### --> +<para> + +</para> -<!-- ##### SECTION ./tmpl/soup-socket-ssl.sgml:Long_Description ##### --> +<!-- ##### SECTION ./tmpl/soup-md5-utils.sgml:See_Also ##### --> <para> </para> -<!-- ##### SECTION ./tmpl/soup-socket-ssl.sgml:See_Also ##### --> +<!-- ##### SECTION ./tmpl/soup-md5-utils.sgml:Short_Description ##### --> +MD5 hash utilities + + +<!-- ##### SECTION ./tmpl/soup-md5-utils.sgml:Title ##### --> +soup-md5-utils + + +<!-- ##### SECTION ./tmpl/soup-message-private.sgml:Long_Description ##### --> <para> </para> -<!-- ##### SECTION ./tmpl/soup-socket-ssl.sgml:Short_Description ##### --> +<!-- ##### SECTION ./tmpl/soup-message-private.sgml:See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION ./tmpl/soup-message-private.sgml:Short_Description ##### --> -<!-- ##### SECTION ./tmpl/soup-socket-ssl.sgml:Title ##### --> -SoupSocketSSL +<!-- ##### SECTION ./tmpl/soup-message-private.sgml:Title ##### --> +soup-message-private -<!-- ##### SECTION ./tmpl/soup-types.sgml:Long_Description ##### --> + +<!-- ##### SECTION ./tmpl/soup-message-queue.sgml:Long_Description ##### --> +<para> +#SoupMessageQueue maintains the queue of pending messages in a +#SoupSession. +</para> + + +<!-- ##### SECTION ./tmpl/soup-message-queue.sgml:See_Also ##### --> <para> </para> -<!-- ##### SECTION ./tmpl/soup-types.sgml:See_Also ##### --> +<!-- ##### SECTION ./tmpl/soup-message-queue.sgml:Short_Description ##### --> +Message queue object + + +<!-- ##### SECTION ./tmpl/soup-message-queue.sgml:Title ##### --> +soup-message-queue + + +<!-- ##### SECTION ./tmpl/soup-misc.sgml:Long_Description ##### --> <para> </para> -<!-- ##### SECTION ./tmpl/soup-types.sgml:Short_Description ##### --> +<!-- ##### SECTION ./tmpl/soup-misc.sgml:See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION ./tmpl/soup-misc.sgml:Short_Description ##### --> +Miscellaneous functions -<!-- ##### SECTION ./tmpl/soup-types.sgml:Title ##### --> -soup-types +<!-- ##### SECTION ./tmpl/soup-misc.sgml:Title ##### --> +soup-misc -<!-- ##### SECTION ./tmpl/soup.sgml:Long_Description ##### --> +<!-- ##### SECTION ./tmpl/soup-server-auth.sgml:Long_Description ##### --> <para> </para> -<!-- ##### SECTION ./tmpl/soup.sgml:See_Also ##### --> +<!-- ##### SECTION ./tmpl/soup-server-auth.sgml:See_Also ##### --> <para> </para> -<!-- ##### SECTION ./tmpl/soup.sgml:Short_Description ##### --> +<!-- ##### SECTION ./tmpl/soup-server-auth.sgml:Short_Description ##### --> +Server-side authentication structures +<!-- ##### SECTION ./tmpl/soup-server-auth.sgml:Title ##### --> +soup-server-auth -<!-- ##### SECTION ./tmpl/soup.sgml:Title ##### --> -soup +<!-- ##### ENUM SoupAuthType ##### --> +<para> + +</para> + +@SOUP_AUTH_TYPE_BASIC: +@SOUP_AUTH_TYPE_DIGEST: + +<!-- ##### ENUM SoupDigestAlgorithm ##### --> +<para> + +</para> + +@SOUP_ALGORITHM_MD5: +@SOUP_ALGORITHM_MD5_SESS: -<!-- ##### MACRO SOUP_MAKE_TYPE ##### --> +<!-- ##### STRUCT SoupMD5Context ##### --> <para> </para> -@l: -@t: -@ci: -@i: -@parent: -<!-- ##### STRUCT SoupAddress ##### --> +<!-- ##### USER_FUNCTION SoupMessageGetHeadersFn ##### --> <para> </para> +@msg: +@headers: +@encoding: +@user_data: -<!-- ##### STRUCT SoupSoapMessagePrivate ##### --> +<!-- ##### USER_FUNCTION SoupMessageParseHeadersFn ##### --> <para> </para> +@msg: +@headers: +@header_len: +@encoding: +@content_len: +@user_data: +@Returns: -<!-- ##### MACRO soup_marshal_NONE__INT ##### --> +<!-- ##### TYPEDEF SoupMessageQueue ##### --> <para> </para> -<!-- ##### MACRO soup_marshal_NONE__NONE ##### --> +<!-- ##### STRUCT SoupMessageQueueIter ##### --> <para> </para> -<!-- ##### MACRO soup_marshal_NONE__OBJECT ##### --> +<!-- ##### STRUCT SoupServerAuthBasic ##### --> <para> </para> +@type: +@user: +@passwd: -<!-- ##### MACRO soup_marshal_NONE__OBJECT_STRING_STRING_POINTER_POINTER ##### --> +<!-- ##### USER_FUNCTION SoupServerAuthCallbackFn ##### --> <para> </para> +@auth_ctx: +@auth: +@msg: +@data: +@Returns: -<!-- ##### MACRO soup_marshal_VOID__INT ##### --> +<!-- ##### STRUCT SoupServerAuthContext ##### --> <para> </para> +@types: +@callback: +@user_data: -<!-- ##### MACRO soup_marshal_VOID__OBJECT ##### --> +<!-- ##### STRUCT SoupServerAuthDigest ##### --> <para> </para> +@type: +@algorithm: +@integrity: +@realm: +@user: +@nonce: +@nonce_count: +@cnonce: +@digest_uri: +@digest_response: +@request_method: + +<!-- ##### FUNCTION soup_base64_decode ##### --> +<para> + +</para> -<!-- ##### FUNCTION soup_marshal_VOID__OBJECT_STRING_STRING_POINTER_POINTER ##### --> +@text: +@out_len: +@Returns: + +<!-- ##### FUNCTION soup_base64_decode_step ##### --> <para> </para> -@closure: -@return_value: -@n_param_values: -@param_values: -@invocation_hint: -@marshal_data: +@in: +@len: +@out: +@state: +@save: +@Returns: -<!-- ##### MACRO soup_marshal_VOID__VOID ##### --> +<!-- ##### FUNCTION soup_base64_encode ##### --> <para> </para> +@text: +@len: +@Returns: -<!-- ##### FUNCTION soup_message_cancel ##### --> +<!-- ##### FUNCTION soup_base64_encode_close ##### --> <para> </para> -@msg: -@req: +@in: +@inlen: +@break_lines: +@out: +@state: +@save: +@Returns: -<!-- ##### FUNCTION soup_message_cleanup ##### --> +<!-- ##### FUNCTION soup_base64_encode_step ##### --> +<para> + +</para> + +@in: +@len: +@break_lines: +@out: +@state: +@save: +@Returns: + +<!-- ##### FUNCTION soup_md5_final ##### --> +<para> + +</para> + +@ctx: +@digest: + +<!-- ##### FUNCTION soup_md5_init ##### --> +<para> + +</para> + +@ctx: + +<!-- ##### FUNCTION soup_md5_update ##### --> +<para> + +</para> + +@ctx: +@buf: +@len: + +<!-- ##### FUNCTION soup_message_cleanup_response ##### --> <para> </para> @req: -<!-- ##### FUNCTION soup_message_io_cancel ##### --> +<!-- ##### FUNCTION soup_message_finished ##### --> +<para> + +</para> + +@msg: + +<!-- ##### FUNCTION soup_message_got_body ##### --> +<para> + +</para> + +@msg: + +<!-- ##### FUNCTION soup_message_got_chunk ##### --> +<para> + +</para> + +@msg: + +<!-- ##### FUNCTION soup_message_got_headers ##### --> +<para> + +</para> + +@msg: + +<!-- ##### FUNCTION soup_message_got_informational ##### --> <para> </para> @msg: -<!-- ##### FUNCTION soup_session_new ##### --> +<!-- ##### FUNCTION soup_message_io_client ##### --> +<para> + +</para> + +@msg: +@sock: +@get_headers_cb: +@parse_headers_cb: +@user_data: + +<!-- ##### FUNCTION soup_message_io_server ##### --> +<para> + +</para> + +@msg: +@sock: +@get_headers_cb: +@parse_headers_cb: +@user_data: + +<!-- ##### FUNCTION soup_message_queue_append ##### --> +<para> + +</para> + +@queue: +@msg: + +<!-- ##### FUNCTION soup_message_queue_destroy ##### --> +<para> + +</para> + +@queue: + +<!-- ##### FUNCTION soup_message_queue_first ##### --> +<para> + +</para> + +@queue: +@iter: +@Returns: + +<!-- ##### FUNCTION soup_message_queue_free_iter ##### --> +<para> + +</para> + +@queue: +@iter: + +<!-- ##### FUNCTION soup_message_queue_new ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### FUNCTION soup_message_queue_next ##### --> +<para> + +</para> + +@queue: +@iter: +@Returns: + +<!-- ##### FUNCTION soup_message_queue_remove ##### --> +<para> + +</para> + +@queue: +@iter: +@Returns: + +<!-- ##### FUNCTION soup_message_queue_remove_message ##### --> +<para> + +</para> + +@queue: +@msg: + +<!-- ##### FUNCTION soup_message_restarted ##### --> +<para> + +</para> + +@msg: + +<!-- ##### FUNCTION soup_message_run_handlers ##### --> +<para> + +</para> + +@msg: +@phase: + +<!-- ##### FUNCTION soup_message_wrote_body ##### --> +<para> + +</para> + +@msg: + +<!-- ##### FUNCTION soup_message_wrote_chunk ##### --> +<para> + +</para> + +@msg: + +<!-- ##### FUNCTION soup_message_wrote_headers ##### --> +<para> + +</para> + +@msg: + +<!-- ##### FUNCTION soup_message_wrote_informational ##### --> +<para> + +</para> + +@msg: + +<!-- ##### FUNCTION soup_server_auth_check_passwd ##### --> +<para> + +</para> + +@auth: +@passwd: +@Returns: + +<!-- ##### FUNCTION soup_server_auth_context_challenge ##### --> +<para> + +</para> + +@auth_ctx: +@msg: +@header_name: + +<!-- ##### FUNCTION soup_server_auth_free ##### --> +<para> + +</para> + +@auth: + +<!-- ##### FUNCTION soup_server_auth_get_user ##### --> +<para> + +</para> + +@auth: +@Returns: + +<!-- ##### FUNCTION soup_server_auth_new ##### --> +<para> + +</para> + +@auth_ctx: +@auth_hdrs: +@msg: +@Returns: + +<!-- ##### FUNCTION soup_signal_connect_once ##### --> +<para> + +</para> + +@instance: +@detailed_signal: +@c_handler: +@data: +@Returns: + +<!-- ##### VARIABLE soup_ssl_supported ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION soup_str_case_equal ##### --> <para> </para> +@v1: +@v2: @Returns: -<!-- ##### FUNCTION soup_session_new_with_options ##### --> +<!-- ##### FUNCTION soup_str_case_hash ##### --> <para> </para> -@optname1: -@Varargs: +@key: @Returns: diff --git a/docs/reference/tmpl/soup-address.sgml b/docs/reference/tmpl/soup-address.sgml index edc69448..0db6ca97 100644 --- a/docs/reference/tmpl/soup-address.sgml +++ b/docs/reference/tmpl/soup-address.sgml @@ -21,21 +21,31 @@ IPv4 and IPv6 addresses. </para> +<!-- ##### STRUCT SoupAddress ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL SoupAddress::dns-result ##### --> +<para> + +</para> + +@addr: +@status: + <!-- ##### ENUM SoupAddressFamily ##### --> <para> -The supported address families. Note that the -%SOUP_ADDRESS_FAMILY_IPV6 constant is available even if libsoup was -built without IPv6 support, but attempting to create an IPv6 address -will fail in that case. + </para> -@SOUP_ADDRESS_FAMILY_IPV4: an IPv4 address -@SOUP_ADDRESS_FAMILY_IPV6: an IPv6 address +@SOUP_ADDRESS_FAMILY_IPV4: +@SOUP_ADDRESS_FAMILY_IPV6: <!-- ##### MACRO SOUP_ADDRESS_ANY_PORT ##### --> <para> -This can be passed to any #SoupAddress method that expects a port to -indicate that you don't care what port is used. + </para> @@ -72,12 +82,12 @@ indicate that you don't care what port is used. <!-- ##### USER_FUNCTION SoupAddressCallback ##### --> <para> -The callback function passed to soup_address_resolve_async(). + </para> -@addr: the #SoupAddress that was resolved -@status: %SOUP_STATUS_OK or %SOUP_STATUS_CANT_RESOLVE -@data: the user data that was passed to soup_address_resolve_async() +@addr: +@status: +@data: <!-- ##### FUNCTION soup_address_resolve_async ##### --> @@ -108,6 +118,16 @@ The callback function passed to soup_address_resolve_async(). @Returns: +<!-- ##### FUNCTION soup_address_get_sockaddr ##### --> +<para> + +</para> + +@addr: +@len: +@Returns: + + <!-- ##### FUNCTION soup_address_get_physical ##### --> <para> diff --git a/docs/reference/tmpl/soup-auth-basic.sgml b/docs/reference/tmpl/soup-auth-basic.sgml deleted file mode 100644 index 5beb539e..00000000 --- a/docs/reference/tmpl/soup-auth-basic.sgml +++ /dev/null @@ -1,23 +0,0 @@ -<!-- ##### SECTION Title ##### --> -SoupAuthBasic - -<!-- ##### SECTION Short_Description ##### --> -HTTP Basic Authentication - -<!-- ##### SECTION Long_Description ##### --> -<para> -This implements the Basic HTTP Authentication mechanism, as described -in RFC 2617. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### STRUCT SoupAuthBasic ##### --> -<para> - -</para> - - diff --git a/docs/reference/tmpl/soup-auth-digest.sgml b/docs/reference/tmpl/soup-auth-digest.sgml deleted file mode 100644 index af0f0c1b..00000000 --- a/docs/reference/tmpl/soup-auth-digest.sgml +++ /dev/null @@ -1,23 +0,0 @@ -<!-- ##### SECTION Title ##### --> -SoupAuthDigest - -<!-- ##### SECTION Short_Description ##### --> -HTTP Digest Authentication - -<!-- ##### SECTION Long_Description ##### --> -<para> -This implements the Digest HTTP Authentication mechanism, as described -in RFC 2617. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### STRUCT SoupAuthDigest ##### --> -<para> - -</para> - - diff --git a/docs/reference/tmpl/soup-auth.sgml b/docs/reference/tmpl/soup-auth.sgml index 5fb0bd95..6108b77a 100644 --- a/docs/reference/tmpl/soup-auth.sgml +++ b/docs/reference/tmpl/soup-auth.sgml @@ -11,21 +11,29 @@ given bit of webspace. They are created and maintained automatically by #SoupSession. </para> +<!-- ##### SECTION See_Also ##### --> <para> -#SoupAuth itself is an abstract class. Specific HTTP Authentication -mechanisms are implemented by its subclasses. (NTLM authentication, -which works quite differently from normal HTTP authentication, is -handled by #SoupConnectionNTLM.) +#SoupSession, #SoupConnectionNTLM </para> -<!-- ##### SECTION See_Also ##### --> +<!-- ##### STRUCT SoupAuth ##### --> <para> -SoupAuthBasic, SoupAuthDigest, SoupSession, SoupConnectionNTLM +The abstract base class for handling authentication. Specific HTTP +Authentication mechanisms are implemented by its subclasses. (NTLM +authentication, which works quite differently from normal HTTP +authentication, is handled by #SoupConnectionNTLM.) </para> -<!-- ##### STRUCT SoupAuth ##### --> + +<!-- ##### STRUCT SoupAuthBasic ##### --> <para> +An object representing Basic HTTP authentication. +</para> + +<!-- ##### STRUCT SoupAuthDigest ##### --> +<para> +An object representing Digest HTTP authentication. </para> @@ -34,7 +42,7 @@ SoupAuthBasic, SoupAuthDigest, SoupSession, SoupConnectionNTLM </para> -@header: +@vals: @Returns: diff --git a/docs/reference/tmpl/soup-connection-ntlm.sgml b/docs/reference/tmpl/soup-connection-ntlm.sgml index b4e97945..7c749fca 100644 --- a/docs/reference/tmpl/soup-connection-ntlm.sgml +++ b/docs/reference/tmpl/soup-connection-ntlm.sgml @@ -2,11 +2,12 @@ SoupConnectionNTLM <!-- ##### SECTION Short_Description ##### --> - +NTLM-authenticated connection <!-- ##### SECTION Long_Description ##### --> <para> - +#SoupSession automatically creates #SoupConnectionNTLM rather than +#SoupConnection if you set the %SOUP_SESSION_USE_NTLM flag. </para> <!-- ##### SECTION See_Also ##### --> diff --git a/docs/reference/tmpl/soup-connection.sgml b/docs/reference/tmpl/soup-connection.sgml index 9cb5e6c0..cfcfb891 100644 --- a/docs/reference/tmpl/soup-connection.sgml +++ b/docs/reference/tmpl/soup-connection.sgml @@ -2,11 +2,13 @@ SoupConnection <!-- ##### SECTION Short_Description ##### --> - +a single possibly-persistent HTTP connection <!-- ##### SECTION Long_Description ##### --> <para> - +#SoupConnection represents a single connection to an HTTP server +(possibly via a proxy). Connection objects are created and destroyed +automatically by #SoupSession. </para> <!-- ##### SECTION See_Also ##### --> @@ -14,26 +16,70 @@ SoupConnection </para> -<!-- ##### MACRO SOUP_CONNECTION_ORIGIN_URI ##### --> +<!-- ##### STRUCT SoupConnection ##### --> <para> </para> +<!-- ##### SIGNAL SoupConnection::authenticate ##### --> +<para> -<!-- ##### MACRO SOUP_CONNECTION_PROXY_URI ##### --> +</para> + +@conn: +@msg: +@auth_type: +@auth_realm: +@username: +@password: + +<!-- ##### SIGNAL SoupConnection::connect-result ##### --> <para> </para> +@conn: +@status: + +<!-- ##### SIGNAL SoupConnection::disconnected ##### --> +<para> +</para> -<!-- ##### MACRO SOUP_CONNECTION_SSL_CREDENTIALS ##### --> +@conn: + +<!-- ##### SIGNAL SoupConnection::reauthenticate ##### --> <para> </para> +@conn: +@msg: +@auth_type: +@auth_realm: +@username: +@password: + +<!-- ##### ARG SoupConnection:message-filter ##### --> +<para> + +</para> +<!-- ##### ARG SoupConnection:origin-uri ##### --> +<para> + +</para> + +<!-- ##### ARG SoupConnection:proxy-uri ##### --> +<para> + +</para> + +<!-- ##### ARG SoupConnection:ssl-creds ##### --> +<para> + +</para> <!-- ##### FUNCTION soup_connection_new ##### --> <para> @@ -47,12 +93,12 @@ SoupConnection <!-- ##### USER_FUNCTION SoupConnectionCallback ##### --> <para> -The callback function passed to soup_connection_connect_async(). + </para> -@conn: the #SoupConnection -@status: an HTTP status code indicating success or failure -@data: the data passed to soup_connection_connect_async() +@conn: +@status: +@data: <!-- ##### FUNCTION soup_connection_connect_async ##### --> @@ -63,8 +109,6 @@ The callback function passed to soup_connection_connect_async(). @conn: @callback: @user_data: -<!-- # Unused Parameters # --> -@Param2: <!-- ##### FUNCTION soup_connection_connect_sync ##### --> @@ -137,3 +181,47 @@ The callback function passed to soup_connection_connect_async(). @password: +<!-- ##### FUNCTION soup_connection_release ##### --> +<para> + +</para> + +@conn: + + +<!-- ##### FUNCTION soup_connection_reserve ##### --> +<para> + +</para> + +@conn: + + +<!-- ##### MACRO SOUP_CONNECTION_ORIGIN_URI ##### --> +<para> +An alias for the "origin-uri" property. +</para> + + + +<!-- ##### MACRO SOUP_CONNECTION_PROXY_URI ##### --> +<para> +An alias for the "proxy-uri" property. +</para> + + + +<!-- ##### MACRO SOUP_CONNECTION_SSL_CREDENTIALS ##### --> +<para> +An alias for the "ssl-creds" property. +</para> + + + +<!-- ##### MACRO SOUP_CONNECTION_MESSAGE_FILTER ##### --> +<para> +An alias for the "message-filter" property. +</para> + + + diff --git a/docs/reference/tmpl/soup-dns.sgml b/docs/reference/tmpl/soup-dns.sgml index 8bef2e9c..db9d9c74 100644 --- a/docs/reference/tmpl/soup-dns.sgml +++ b/docs/reference/tmpl/soup-dns.sgml @@ -14,7 +14,31 @@ Low-level DNS routines </para> -<!-- ##### FUNCTION soup_dns_entry_from_name ##### --> +<!-- ##### FUNCTION soup_dns_init ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION soup_dns_ntop ##### --> +<para> + +</para> + +@sa: +@Returns: +<!-- # Unused Parameters # --> +@address: + + +<!-- ##### TYPEDEF SoupDNSLookup ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION soup_dns_lookup_name ##### --> <para> </para> @@ -23,48 +47,77 @@ Low-level DNS routines @Returns: -<!-- ##### FUNCTION soup_dns_entry_from_addr ##### --> +<!-- ##### FUNCTION soup_dns_lookup_address ##### --> <para> </para> -@addr: -@family: +@sockaddr: @Returns: +<!-- # Unused Parameters # --> +@address: -<!-- ##### FUNCTION soup_dns_entry_check_lookup ##### --> +<!-- ##### FUNCTION soup_dns_lookup_resolve ##### --> <para> </para> -@entry: +@lookup: @Returns: -<!-- ##### FUNCTION soup_dns_entry_cancel_lookup ##### --> +<!-- ##### USER_FUNCTION SoupDNSCallback ##### --> <para> </para> -@entry: +@lookup: +@success: +@user_data: -<!-- ##### FUNCTION soup_dns_free_hostent ##### --> +<!-- ##### FUNCTION soup_dns_lookup_resolve_async ##### --> <para> </para> -@h: +@lookup: +@callback: +@user_data: -<!-- ##### FUNCTION soup_dns_ntop ##### --> +<!-- ##### FUNCTION soup_dns_lookup_cancel ##### --> <para> </para> -@addr: -@family: +@lookup: + + +<!-- ##### FUNCTION soup_dns_lookup_get_hostname ##### --> +<para> + +</para> + +@lookup: @Returns: +<!-- ##### FUNCTION soup_dns_lookup_get_address ##### --> +<para> + +</para> + +@lookup: +@Returns: + + +<!-- ##### FUNCTION soup_dns_lookup_free ##### --> +<para> + +</para> + +@lookup: + + diff --git a/docs/reference/tmpl/soup-headers.sgml b/docs/reference/tmpl/soup-headers.sgml deleted file mode 100644 index cec103b4..00000000 --- a/docs/reference/tmpl/soup-headers.sgml +++ /dev/null @@ -1,92 +0,0 @@ -<!-- ##### SECTION Title ##### --> -soup-headers - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### FUNCTION soup_headers_parse_request ##### --> -<para> - -</para> - -@str: -@len: -@dest: -@req_method: -@req_path: -@ver: -@Returns: - - -<!-- ##### FUNCTION soup_headers_parse_status_line ##### --> -<para> - -</para> - -@status_line: -@ver: -@status_code: -@status_phrase: -@Returns: - - -<!-- ##### FUNCTION soup_headers_parse_response ##### --> -<para> - -</para> - -@str: -@len: -@dest: -@ver: -@status_code: -@status_phrase: -@Returns: - - -<!-- ##### FUNCTION soup_header_param_decode_token ##### --> -<para> - -</para> - -@in: -@Returns: - - -<!-- ##### FUNCTION soup_header_param_parse_list ##### --> -<para> - -</para> - -@header: -@Returns: - - -<!-- ##### FUNCTION soup_header_param_copy_token ##### --> -<para> - -</para> - -@tokens: -@t: -@Returns: - - -<!-- ##### FUNCTION soup_header_param_destroy_hash ##### --> -<para> - -</para> - -@table: - - diff --git a/docs/reference/tmpl/soup-marshal.sgml b/docs/reference/tmpl/soup-marshal.sgml deleted file mode 100644 index ba764273..00000000 --- a/docs/reference/tmpl/soup-marshal.sgml +++ /dev/null @@ -1,78 +0,0 @@ -<!-- ##### SECTION Title ##### --> -soup-marshal - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### MACRO soup_marshal_VOID__VOID ##### --> -<para> - -</para> - - - -<!-- ##### MACRO soup_marshal_NONE__NONE ##### --> -<para> - -</para> - - - -<!-- ##### MACRO soup_marshal_VOID__INT ##### --> -<para> - -</para> - - - -<!-- ##### MACRO soup_marshal_NONE__INT ##### --> -<para> - -</para> - - - -<!-- ##### MACRO soup_marshal_VOID__OBJECT ##### --> -<para> - -</para> - - - -<!-- ##### MACRO soup_marshal_NONE__OBJECT ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION soup_marshal_VOID__OBJECT_STRING_STRING_POINTER_POINTER ##### --> -<para> - -</para> - -@closure: -@return_value: -@n_param_values: -@param_values: -@invocation_hint: -@marshal_data: - - -<!-- ##### MACRO soup_marshal_NONE__OBJECT_STRING_STRING_POINTER_POINTER ##### --> -<para> - -</para> - - - diff --git a/docs/reference/tmpl/soup-md5-utils.sgml b/docs/reference/tmpl/soup-md5-utils.sgml index 7fd75d0a..afb42b2b 100644 --- a/docs/reference/tmpl/soup-md5-utils.sgml +++ b/docs/reference/tmpl/soup-md5-utils.sgml @@ -2,7 +2,7 @@ soup-md5-utils <!-- ##### SECTION Short_Description ##### --> - +MD5 hash utilities <!-- ##### SECTION Long_Description ##### --> <para> @@ -19,10 +19,6 @@ soup-md5-utils </para> -@buf: -@bits: -@in: -@doByteReverse: <!-- ##### FUNCTION soup_md5_init ##### --> <para> diff --git a/docs/reference/tmpl/soup-types.sgml b/docs/reference/tmpl/soup-message-filter.sgml index 02ad0554..c1bbe1bd 100644 --- a/docs/reference/tmpl/soup-types.sgml +++ b/docs/reference/tmpl/soup-message-filter.sgml @@ -1,5 +1,5 @@ <!-- ##### SECTION Title ##### --> -soup-types +SoupMessageFilter <!-- ##### SECTION Short_Description ##### --> @@ -14,15 +14,12 @@ soup-types </para> -<!-- ##### MACRO SOUP_MAKE_TYPE ##### --> +<!-- ##### FUNCTION soup_message_filter_setup_message ##### --> <para> </para> -@l: -@t: -@ci: -@i: -@parent: +@filter: +@msg: diff --git a/docs/reference/tmpl/soup-message-queue.sgml b/docs/reference/tmpl/soup-message-queue.sgml index 0abe8736..468f0d68 100644 --- a/docs/reference/tmpl/soup-message-queue.sgml +++ b/docs/reference/tmpl/soup-message-queue.sgml @@ -2,11 +2,12 @@ soup-message-queue <!-- ##### SECTION Short_Description ##### --> - +Message queue object <!-- ##### SECTION Long_Description ##### --> <para> - +#SoupMessageQueue maintains the queue of pending messages in a +#SoupSession. </para> <!-- ##### SECTION See_Also ##### --> @@ -14,10 +15,15 @@ soup-message-queue </para> +<!-- ##### TYPEDEF SoupMessageQueue ##### --> +<para> + +</para> + + <!-- ##### STRUCT SoupMessageQueueIter ##### --> <para> -An opaque data structure used to iterate the elements of a -#SoupMessageQueue. + </para> diff --git a/docs/reference/tmpl/soup-message.sgml b/docs/reference/tmpl/soup-message.sgml index 97706bdb..33b6ed3e 100644 --- a/docs/reference/tmpl/soup-message.sgml +++ b/docs/reference/tmpl/soup-message.sgml @@ -2,7 +2,7 @@ SoupMessage <!-- ##### SECTION Short_Description ##### --> - +An HTTP request and response. <!-- ##### SECTION Long_Description ##### --> <para> @@ -14,70 +14,145 @@ SoupMessage </para> +<!-- ##### STRUCT SoupMessage ##### --> +<para> + +</para> + +@method: +@status_code: +@reason_phrase: +@request: +@request_headers: +@response: +@response_headers: +@status: + +<!-- ##### SIGNAL SoupMessage::finished ##### --> +<para> + +</para> + +@msg: + +<!-- ##### SIGNAL SoupMessage::got-body ##### --> +<para> + +</para> + +@msg: + +<!-- ##### SIGNAL SoupMessage::got-chunk ##### --> +<para> + +</para> + +@msg: + +<!-- ##### SIGNAL SoupMessage::got-headers ##### --> +<para> + +</para> + +@msg: + +<!-- ##### SIGNAL SoupMessage::got-informational ##### --> +<para> + +</para> + +@msg: + +<!-- ##### SIGNAL SoupMessage::restarted ##### --> +<para> + +</para> + +@msg: + +<!-- ##### SIGNAL SoupMessage::wrote-body ##### --> +<para> + +</para> + +@msg: + +<!-- ##### SIGNAL SoupMessage::wrote-chunk ##### --> +<para> + +</para> + +@msg: + +<!-- ##### SIGNAL SoupMessage::wrote-headers ##### --> +<para> + +</para> + +@msg: + +<!-- ##### SIGNAL SoupMessage::wrote-informational ##### --> +<para> + +</para> + +@msg: + <!-- ##### ENUM SoupMessageStatus ##### --> <para> -Enum indicating the lifecycle of a #SoupMessage. + </para> -@SOUP_MESSAGE_STATUS_IDLE: The message has not yet been queued. -@SOUP_MESSAGE_STATUS_QUEUED: The message has been queued, but is -waiting for a connection to be available. -@SOUP_MESSAGE_STATUS_CONNECTING: The message is waiting for a specific -connection to finish connecting. -@SOUP_MESSAGE_STATUS_RUNNING: The message is being processed. -@SOUP_MESSAGE_STATUS_FINISHED: The message is complete (request and -response both processed). +@SOUP_MESSAGE_STATUS_IDLE: +@SOUP_MESSAGE_STATUS_QUEUED: +@SOUP_MESSAGE_STATUS_CONNECTING: +@SOUP_MESSAGE_STATUS_RUNNING: +@SOUP_MESSAGE_STATUS_FINISHED: <!-- ##### MACRO SOUP_MESSAGE_IS_STARTING ##### --> <para> -Tests if @msg is in a "starting" state, waiting to be sent. (More -commonly used to test if a message has been requeued after its first -attempt.) + </para> -@msg: a #SoupMessage -@Returns: %TRUE if @msg is waiting to be sent. +@msg: +@Returns: <!-- ##### ENUM SoupTransferEncoding ##### --> <para> -How the length of a request or response is to be encoded. + </para> -@SOUP_TRANSFER_UNKNOWN: HTTP 1.0-style (content ends when the -connection is closed) -@SOUP_TRANSFER_CHUNKED: chunked encoding (only supported for response) -@SOUP_TRANSFER_CONTENT_LENGTH: Content-Length +@SOUP_TRANSFER_UNKNOWN: +@SOUP_TRANSFER_CHUNKED: +@SOUP_TRANSFER_CONTENT_LENGTH: <!-- ##### ENUM SoupOwnership ##### --> <para> -Used by #SoupDataBuffer (and several functions) to indicate the -ownership of a buffer. + </para> -@SOUP_BUFFER_SYSTEM_OWNED: The data is owned by soup and it can free -it when it is done with it. -@SOUP_BUFFER_USER_OWNED: The data is owned by the user, who is -responsible for freeing it at the right point -@SOUP_BUFFER_STATIC: The data should not be freed. +@SOUP_BUFFER_SYSTEM_OWNED: +@SOUP_BUFFER_USER_OWNED: +@SOUP_BUFFER_STATIC: <!-- ##### STRUCT SoupDataBuffer ##### --> <para> -A data buffer used in several places. + </para> -@owner: the ownership of the data -@body: the data itself -@length: length of @body +@owner: +@body: +@length: <!-- ##### USER_FUNCTION SoupMessageCallbackFn ##### --> <para> -A callback function used by many #SoupMessage methods. + </para> -@req: the #SoupMessage in question -@user_data: user data +@req: +@user_data: <!-- ##### FUNCTION soup_message_new ##### --> @@ -88,8 +163,6 @@ A callback function used by many #SoupMessage methods. @method: @uri_string: @Returns: -<!-- # Unused Parameters # --> -@uri: <!-- ##### FUNCTION soup_message_new_from_uri ##### --> @@ -112,8 +185,6 @@ A callback function used by many #SoupMessage methods. @req_owner: @req_body: @req_length: -<!-- # Unused Parameters # --> -@req_len: <!-- ##### FUNCTION soup_message_set_response ##### --> @@ -126,8 +197,6 @@ A callback function used by many #SoupMessage methods. @resp_owner: @resp_body: @resp_length: -<!-- # Unused Parameters # --> -@resp_len: <!-- ##### FUNCTION soup_message_add_header ##### --> @@ -189,11 +258,11 @@ A callback function used by many #SoupMessage methods. <!-- ##### ENUM SoupHttpVersion ##### --> <para> -Indicates the HTTP protocol version being used. + </para> -@SOUP_HTTP_1_0: HTTP 1.0 (RFC 1945) -@SOUP_HTTP_1_1: HTTP 1.1 (RFC 2616) +@SOUP_HTTP_1_0: +@SOUP_HTTP_1_1: <!-- ##### FUNCTION soup_message_set_http_version ##### --> <para> @@ -213,15 +282,6 @@ Indicates the HTTP protocol version being used. @Returns: -<!-- ##### FUNCTION soup_message_is_keepalive ##### --> -<para> - -</para> - -@msg: -@Returns: - - <!-- ##### FUNCTION soup_message_get_uri ##### --> <para> @@ -242,19 +302,12 @@ Indicates the HTTP protocol version being used. <!-- ##### ENUM SoupMessageFlags ##### --> <para> -Various flags that can be set on a #SoupMessage to alter its behavior. + </para> -@SOUP_MESSAGE_NO_REDIRECT: The session should not follow redirect -(3xx) responses received by this message. -@SOUP_MESSAGE_OVERWRITE_CHUNKS: Rather than building up the response -body in %response, each new chunk should overwrite the previous one. -(This can be used if you are connecting to the %got_chunk signal or -have installed a %SOUP_MESSAGE_BODY_CHUNK handler.) -@SOUP_MESSAGE_EXPECT_CONTINUE: This will cause an "Expect: -100-continue" header to be added to the outgoing request, giving the -server the opportunity to reject the message (eg, with a 401 -Unauthorized) before the full request body is sent. +@SOUP_MESSAGE_NO_REDIRECT: +@SOUP_MESSAGE_OVERWRITE_CHUNKS: +@SOUP_MESSAGE_EXPECT_CONTINUE: <!-- ##### FUNCTION soup_message_set_flags ##### --> <para> @@ -274,79 +327,6 @@ Unauthorized) before the full request body is sent. @Returns: -<!-- ##### ENUM SoupHandlerPhase ##### --> -<para> -Indicates when a handler added with soup_message_add_handler() or the -like will be run. -</para> - -@SOUP_HANDLER_POST_REQUEST: The handler should run immediately after -sending the request body -@SOUP_HANDLER_PRE_BODY: The handler should run before reading the -response body (after reading the headers). -@SOUP_HANDLER_BODY_CHUNK: The handler should run after every body -chunk is read. (See also %SOUP_MESSAGE_OVERWRITE_CHUNKS.) -@SOUP_HANDLER_POST_BODY: The handler should run after the entire -message body has been read. - -<!-- ##### FUNCTION soup_message_add_handler ##### --> -<para> - -</para> - -@msg: -@type: -@handler_cb: -@user_data: - - -<!-- ##### FUNCTION soup_message_add_header_handler ##### --> -<para> - -</para> - -@msg: -@header: -@type: -@Param4: -@user_data: - - -<!-- ##### FUNCTION soup_message_add_status_code_handler ##### --> -<para> - -</para> - -@msg: -@status_code: -@type: -@Param4: -@user_data: - - -<!-- ##### FUNCTION soup_message_add_status_class_handler ##### --> -<para> - -</para> - -@msg: -@status_class: -@type: -@Param4: -@user_data: - - -<!-- ##### FUNCTION soup_message_remove_handler ##### --> -<para> - -</para> - -@msg: -@type: -@Param3: -@user_data: - - <!-- ##### FUNCTION soup_message_set_status ##### --> <para> @@ -394,90 +374,103 @@ message body has been read. @Returns: -<!-- ##### FUNCTION soup_message_send_request ##### --> -<para> - -</para> - -@req: -@sock: -@via_proxy: - - -<!-- ##### FUNCTION soup_message_read_request ##### --> +<!-- ##### FUNCTION soup_message_is_keepalive ##### --> <para> </para> -@req: -@sock: +@msg: +@Returns: -<!-- ##### FUNCTION soup_message_io_pause ##### --> +<!-- ##### ENUM SoupHandlerPhase ##### --> <para> </para> -@msg: - +@SOUP_HANDLER_POST_REQUEST: +@SOUP_HANDLER_PRE_BODY: +@SOUP_HANDLER_BODY_CHUNK: +@SOUP_HANDLER_POST_BODY: -<!-- ##### FUNCTION soup_message_io_unpause ##### --> +<!-- ##### FUNCTION soup_message_add_handler ##### --> <para> </para> @msg: +@phase: +@handler_cb: +@user_data: -<!-- ##### FUNCTION soup_message_wrote_informational ##### --> +<!-- ##### FUNCTION soup_message_add_header_handler ##### --> <para> </para> @msg: +@header: +@phase: +@handler_cb: +@user_data: -<!-- ##### FUNCTION soup_message_wrote_headers ##### --> +<!-- ##### FUNCTION soup_message_add_status_code_handler ##### --> <para> </para> @msg: +@status_code: +@phase: +@handler_cb: +@user_data: -<!-- ##### FUNCTION soup_message_wrote_chunk ##### --> +<!-- ##### FUNCTION soup_message_add_status_class_handler ##### --> <para> </para> @msg: +@status_class: +@phase: +@handler_cb: +@user_data: -<!-- ##### FUNCTION soup_message_wrote_body ##### --> +<!-- ##### FUNCTION soup_message_remove_handler ##### --> <para> </para> @msg: +@phase: +@handler_cb: +@user_data: -<!-- ##### FUNCTION soup_message_got_informational ##### --> +<!-- ##### FUNCTION soup_message_send_request ##### --> <para> </para> -@msg: +@req: +@sock: +@is_via_proxy: -<!-- ##### FUNCTION soup_message_got_headers ##### --> +<!-- ##### FUNCTION soup_message_read_request ##### --> <para> </para> -@msg: +@req: +@sock: -<!-- ##### FUNCTION soup_message_got_chunk ##### --> +<!-- ##### FUNCTION soup_message_io_pause ##### --> <para> </para> @@ -485,7 +478,7 @@ message body has been read. @msg: -<!-- ##### FUNCTION soup_message_got_body ##### --> +<!-- ##### FUNCTION soup_message_io_unpause ##### --> <para> </para> @@ -493,7 +486,7 @@ message body has been read. @msg: -<!-- ##### FUNCTION soup_message_finished ##### --> +<!-- ##### FUNCTION soup_message_io_stop ##### --> <para> </para> diff --git a/docs/reference/tmpl/soup-method.sgml b/docs/reference/tmpl/soup-method.sgml deleted file mode 100644 index e6c6bb3d..00000000 --- a/docs/reference/tmpl/soup-method.sgml +++ /dev/null @@ -1,165 +0,0 @@ -<!-- ##### SECTION Title ##### --> -soup-method - -<!-- ##### SECTION Short_Description ##### --> -HTTP method-related defines. - -<!-- ##### SECTION Long_Description ##### --> -<para> -These can be used if you don't want to specify the HTTP method to -soup_message_new() as an explicit string. This is purely a stylistic -consideration. There is no difference between using the define and -the string itself. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### MACRO SOUP_METHOD_POST ##### --> -<para> - -</para> - - - -<!-- ##### MACRO SOUP_METHOD_GET ##### --> -<para> - -</para> - - - -<!-- ##### MACRO SOUP_METHOD_HEAD ##### --> -<para> - -</para> - - - -<!-- ##### MACRO SOUP_METHOD_OPTIONS ##### --> -<para> - -</para> - - - -<!-- ##### MACRO SOUP_METHOD_PUT ##### --> -<para> - -</para> - - - -<!-- ##### MACRO SOUP_METHOD_MOVE ##### --> -<para> - -</para> - - - -<!-- ##### MACRO SOUP_METHOD_COPY ##### --> -<para> - -</para> - - - -<!-- ##### MACRO SOUP_METHOD_DELETE ##### --> -<para> - -</para> - - - -<!-- ##### MACRO SOUP_METHOD_TRACE ##### --> -<para> - -</para> - - - -<!-- ##### MACRO SOUP_METHOD_CONNECT ##### --> -<para> - -</para> - - - -<!-- ##### MACRO SOUP_METHOD_MKCOL ##### --> -<para> - -</para> - - - -<!-- ##### MACRO SOUP_METHOD_PROPPATCH ##### --> -<para> - -</para> - - - -<!-- ##### MACRO SOUP_METHOD_PROPFIND ##### --> -<para> - -</para> - - - -<!-- ##### MACRO SOUP_METHOD_PATCH ##### --> -<para> - -</para> - - - -<!-- ##### MACRO SOUP_METHOD_LOCK ##### --> -<para> - -</para> - - - -<!-- ##### MACRO SOUP_METHOD_UNLOCK ##### --> -<para> - -</para> - - - -<!-- ##### ENUM SoupMethodId ##### --> -<para> -This enumeration is used internally by routines that need to check the -HTTP method in a #SoupMessage against several different possibilities, -to avoid repeated strcmp()s. -</para> - -@SOUP_METHOD_ID_UNKNOWN: -@SOUP_METHOD_ID_POST: -@SOUP_METHOD_ID_GET: -@SOUP_METHOD_ID_HEAD: -@SOUP_METHOD_ID_OPTIONS: -@SOUP_METHOD_ID_PUT: -@SOUP_METHOD_ID_MOVE: -@SOUP_METHOD_ID_COPY: -@SOUP_METHOD_ID_DELETE: -@SOUP_METHOD_ID_TRACE: -@SOUP_METHOD_ID_CONNECT: -@SOUP_METHOD_ID_MKCOL: -@SOUP_METHOD_ID_PROPPATCH: -@SOUP_METHOD_ID_PROPFIND: -@SOUP_METHOD_ID_PATCH: -@SOUP_METHOD_ID_LOCK: -@SOUP_METHOD_ID_UNLOCK: - -<!-- ##### FUNCTION soup_method_get_id ##### --> -<para> - -</para> - -@method: -@Returns: - - diff --git a/docs/reference/tmpl/soup-misc.sgml b/docs/reference/tmpl/soup-misc.sgml index c7fb37c6..8bb7f42f 100644 --- a/docs/reference/tmpl/soup-misc.sgml +++ b/docs/reference/tmpl/soup-misc.sgml @@ -2,7 +2,7 @@ soup-misc <!-- ##### SECTION Short_Description ##### --> - +Miscellaneous functions <!-- ##### SECTION Long_Description ##### --> <para> @@ -85,8 +85,6 @@ soup-misc @c_handler: @data: @Returns: -<!-- # Unused Parameters # --> -@signal: <!-- ##### FUNCTION soup_str_case_hash ##### --> diff --git a/docs/reference/tmpl/soup-server-auth.sgml b/docs/reference/tmpl/soup-server-auth.sgml index 2497ce4e..cbe22e33 100644 --- a/docs/reference/tmpl/soup-server-auth.sgml +++ b/docs/reference/tmpl/soup-server-auth.sgml @@ -2,7 +2,7 @@ soup-server-auth <!-- ##### SECTION Short_Description ##### --> - +Server-side authentication structures <!-- ##### SECTION Long_Description ##### --> <para> @@ -14,6 +14,15 @@ soup-server-auth </para> +<!-- ##### STRUCT SoupServerAuthContext ##### --> +<para> + +</para> + +@types: +@callback: +@user_data: + <!-- ##### USER_FUNCTION SoupServerAuthCallbackFn ##### --> <para> diff --git a/docs/reference/tmpl/soup-server-message.sgml b/docs/reference/tmpl/soup-server-message.sgml index 09bb7b82..ec03fde0 100644 --- a/docs/reference/tmpl/soup-server-message.sgml +++ b/docs/reference/tmpl/soup-server-message.sgml @@ -2,7 +2,7 @@ SoupServerMessage <!-- ##### SECTION Short_Description ##### --> - +Server-side #SoupMessage <!-- ##### SECTION Long_Description ##### --> <para> @@ -14,6 +14,12 @@ SoupServerMessage </para> +<!-- ##### STRUCT SoupServerMessage ##### --> +<para> + +</para> + + <!-- ##### FUNCTION soup_server_message_new ##### --> <para> diff --git a/docs/reference/tmpl/soup-server.sgml b/docs/reference/tmpl/soup-server.sgml index 11436c17..0f6ecb26 100644 --- a/docs/reference/tmpl/soup-server.sgml +++ b/docs/reference/tmpl/soup-server.sgml @@ -2,11 +2,16 @@ SoupServer <!-- ##### SECTION Short_Description ##### --> - +HTTP server <!-- ##### SECTION Long_Description ##### --> <para> +#SoupServer implements a simple HTTP server. +</para> +<para> +This API is less stable than the soup client API, and will most likely +change in the next release. </para> <!-- ##### SECTION See_Also ##### --> @@ -14,65 +19,63 @@ SoupServer </para> -<!-- ##### STRUCT SoupServerContext ##### --> +<!-- ##### STRUCT SoupServer ##### --> <para> </para> -@msg: -@path: -@method_id: -@auth: -@server: -@handler: -@sock: -<!-- ##### USER_FUNCTION SoupServerCallbackFn ##### --> +<!-- ##### ARG SoupServer:interface ##### --> <para> </para> -@context: -@msg: -@user_data: - - -<!-- ##### USER_FUNCTION SoupServerUnregisterFn ##### --> +<!-- ##### ARG SoupServer:port ##### --> <para> </para> -@server: -@handler: -@user_data: - - -<!-- ##### MACRO SOUP_SERVER_PORT ##### --> +<!-- ##### ARG SoupServer:ssl-cert-file ##### --> <para> </para> +<!-- ##### ARG SoupServer:ssl-key-file ##### --> +<para> +</para> -<!-- ##### MACRO SOUP_SERVER_INTERFACE ##### --> +<!-- ##### STRUCT SoupServerContext ##### --> <para> </para> +@msg: +@path: +@method_id: +@auth: +@server: +@handler: +@sock: - -<!-- ##### MACRO SOUP_SERVER_SSL_CERT_FILE ##### --> +<!-- ##### USER_FUNCTION SoupServerCallbackFn ##### --> <para> </para> +@context: +@msg: +@user_data: -<!-- ##### MACRO SOUP_SERVER_SSL_KEY_FILE ##### --> +<!-- ##### USER_FUNCTION SoupServerUnregisterFn ##### --> <para> </para> +@server: +@handler: +@user_data: <!-- ##### FUNCTION soup_server_new ##### --> @@ -127,6 +130,12 @@ SoupServer @serv: +<!-- ##### TYPEDEF SoupServerHandler ##### --> +<para> + +</para> + + <!-- ##### FUNCTION soup_server_add_handler ##### --> <para> @@ -186,3 +195,31 @@ SoupServer @Returns: +<!-- ##### MACRO SOUP_SERVER_PORT ##### --> +<para> +An alias for the "port" property. +</para> + + + +<!-- ##### MACRO SOUP_SERVER_INTERFACE ##### --> +<para> +An alias for the "interface" property. +</para> + + + +<!-- ##### MACRO SOUP_SERVER_SSL_CERT_FILE ##### --> +<para> +An alias for the "ssl-cert-file" property. +</para> + + + +<!-- ##### MACRO SOUP_SERVER_SSL_KEY_FILE ##### --> +<para> +An alias for the "ssl-key-file" property. +</para> + + + diff --git a/docs/reference/tmpl/soup-session-async.sgml b/docs/reference/tmpl/soup-session-async.sgml new file mode 100644 index 00000000..05a90768 --- /dev/null +++ b/docs/reference/tmpl/soup-session-async.sgml @@ -0,0 +1,42 @@ +<!-- ##### SECTION Title ##### --> +SoupSessionAsync + +<!-- ##### SECTION Short_Description ##### --> +Soup session for asynchronous (main-loop-based) I/O. + +<!-- ##### SECTION Long_Description ##### --> +<para> +#SoupSessionASync is an implementation of #SoupSession that uses +non-blocking I/O via the glib main loop. It is intended for use in +single-threaded programs. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### STRUCT SoupSessionAsync ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION soup_session_async_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION soup_session_async_new_with_options ##### --> +<para> + +</para> + +@optname1: +@Varargs: +@Returns: + + diff --git a/docs/reference/tmpl/soup-session-sync.sgml b/docs/reference/tmpl/soup-session-sync.sgml new file mode 100644 index 00000000..65398c1b --- /dev/null +++ b/docs/reference/tmpl/soup-session-sync.sgml @@ -0,0 +1,46 @@ +<!-- ##### SECTION Title ##### --> +SoupSessionSync + +<!-- ##### SECTION Short_Description ##### --> +Soup session for blocking I/O in multithreaded programs. + +<!-- ##### SECTION Long_Description ##### --> +<para> +#SoupSessionSync is an implementation of #SoupSession that uses +synchronous I/O, intended for use in multi-threaded programs. +</para> + +<para> +Note that you cannot use soup_session_queue_message() with a +synchronous session. You can only use soup_session_send_message(). +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### STRUCT SoupSessionSync ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION soup_session_sync_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION soup_session_sync_new_with_options ##### --> +<para> + +</para> + +@optname1: +@Varargs: +@Returns: + + diff --git a/docs/reference/tmpl/soup-session.sgml b/docs/reference/tmpl/soup-session.sgml index 1f6c9b16..eb716032 100644 --- a/docs/reference/tmpl/soup-session.sgml +++ b/docs/reference/tmpl/soup-session.sgml @@ -2,7 +2,7 @@ SoupSession <!-- ##### SECTION Short_Description ##### --> - +Soup session state object <!-- ##### SECTION Long_Description ##### --> <para> @@ -14,40 +14,60 @@ SoupSession </para> -<!-- ##### MACRO SOUP_SESSION_PROXY_URI ##### --> +<!-- ##### STRUCT SoupSession ##### --> <para> </para> - -<!-- ##### MACRO SOUP_SESSION_MAX_CONNS ##### --> +<!-- ##### SIGNAL SoupSession::authenticate ##### --> <para> </para> +@session: +@msg: +@auth_type: +@auth_realm: +@username: +@password: - -<!-- ##### MACRO SOUP_SESSION_MAX_CONNS_PER_HOST ##### --> +<!-- ##### SIGNAL SoupSession::reauthenticate ##### --> <para> </para> +@session: +@msg: +@auth_type: +@auth_realm: +@username: +@password: + +<!-- ##### ARG SoupSession:max-conns ##### --> +<para> +</para> -<!-- ##### MACRO SOUP_SESSION_USE_NTLM ##### --> +<!-- ##### ARG SoupSession:max-conns-per-host ##### --> <para> </para> +<!-- ##### ARG SoupSession:proxy-uri ##### --> +<para> +</para> -<!-- ##### MACRO SOUP_SESSION_SSL_CA_FILE ##### --> +<!-- ##### ARG SoupSession:ssl-ca-file ##### --> <para> </para> +<!-- ##### ARG SoupSession:use-ntlm ##### --> +<para> +</para> <!-- ##### FUNCTION soup_session_queue_message ##### --> <para> @@ -58,8 +78,6 @@ SoupSession @msg: @callback: @user_data: -<!-- # Unused Parameters # --> -@req: <!-- ##### FUNCTION soup_session_requeue_message ##### --> @@ -69,8 +87,6 @@ SoupSession @session: @msg: -<!-- # Unused Parameters # --> -@req: <!-- ##### FUNCTION soup_session_send_message ##### --> @@ -81,8 +97,6 @@ SoupSession @session: @msg: @Returns: -<!-- # Unused Parameters # --> -@req: <!-- ##### FUNCTION soup_session_abort ##### --> @@ -93,3 +107,86 @@ SoupSession @session: +<!-- ##### FUNCTION soup_session_add_filter ##### --> +<para> + +</para> + +@session: +@filter: + + +<!-- ##### FUNCTION soup_session_cancel_message ##### --> +<para> + +</para> + +@session: +@msg: + + +<!-- ##### FUNCTION soup_session_get_connection ##### --> +<para> + +</para> + +@session: +@msg: +@try_pruning: +@is_new: +@Returns: + + +<!-- ##### FUNCTION soup_session_remove_filter ##### --> +<para> + +</para> + +@session: +@filter: + + +<!-- ##### FUNCTION soup_session_try_prune_connection ##### --> +<para> + +</para> + +@session: +@Returns: + + +<!-- ##### MACRO SOUP_SESSION_PROXY_URI ##### --> +<para> +An alias for the "proxy-uri" property. +</para> + + + +<!-- ##### MACRO SOUP_SESSION_MAX_CONNS ##### --> +<para> +An alias for the "max-conns" property. +</para> + + + +<!-- ##### MACRO SOUP_SESSION_MAX_CONNS_PER_HOST ##### --> +<para> +An alias for the "max-conns-per-host" property. +</para> + + + +<!-- ##### MACRO SOUP_SESSION_USE_NTLM ##### --> +<para> +An alias for the "use-ntlm" property. +</para> + + + +<!-- ##### MACRO SOUP_SESSION_SSL_CA_FILE ##### --> +<para> +An alias for the "ssl-ca-file" property. +</para> + + + diff --git a/docs/reference/tmpl/soup-soap-message.sgml b/docs/reference/tmpl/soup-soap-message.sgml index f6f36669..48493a3c 100644 --- a/docs/reference/tmpl/soup-soap-message.sgml +++ b/docs/reference/tmpl/soup-soap-message.sgml @@ -2,7 +2,7 @@ SoupSoapMessage <!-- ##### SECTION Short_Description ##### --> - +A SOAP request/response <!-- ##### SECTION Long_Description ##### --> <para> @@ -177,6 +177,8 @@ SoupSoapMessage </para> @msg: +@i: +<!-- # Unused Parameters # --> @Param2: @@ -319,3 +321,12 @@ SoupSoapMessage @Returns: +<!-- ##### FUNCTION soup_soap_message_parse_response ##### --> +<para> + +</para> + +@msg: +@Returns: + + diff --git a/docs/reference/tmpl/soup-soap-response.sgml b/docs/reference/tmpl/soup-soap-response.sgml new file mode 100644 index 00000000..d4cbbaad --- /dev/null +++ b/docs/reference/tmpl/soup-soap-response.sgml @@ -0,0 +1,197 @@ +<!-- ##### SECTION Title ##### --> +SoupSoapResponse + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### STRUCT SoupSoapResponse ##### --> +<para> + +</para> + + +<!-- ##### TYPEDEF SoupSoapParameter ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION soup_soap_response_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION soup_soap_response_new_from_string ##### --> +<para> + +</para> + +@xmlstr: +@Returns: + + +<!-- ##### FUNCTION soup_soap_response_set_method_name ##### --> +<para> + +</para> + +@response: +@method_name: + + +<!-- ##### FUNCTION soup_soap_parameter_get_first_child ##### --> +<para> + +</para> + +@param: +@Returns: + + +<!-- ##### FUNCTION soup_soap_parameter_get_first_child_by_name ##### --> +<para> + +</para> + +@param: +@name: +@Returns: + + +<!-- ##### FUNCTION soup_soap_parameter_get_int_value ##### --> +<para> + +</para> + +@param: +@Returns: + + +<!-- ##### FUNCTION soup_soap_parameter_get_name ##### --> +<para> + +</para> + +@param: +@Returns: + + +<!-- ##### FUNCTION soup_soap_parameter_get_next_child ##### --> +<para> + +</para> + +@param: +@Returns: + + +<!-- ##### FUNCTION soup_soap_parameter_get_next_child_by_name ##### --> +<para> + +</para> + +@param: +@name: +@Returns: + + +<!-- ##### FUNCTION soup_soap_parameter_get_property ##### --> +<para> + +</para> + +@param: +@prop_name: +@Returns: + + +<!-- ##### FUNCTION soup_soap_parameter_get_string_value ##### --> +<para> + +</para> + +@param: +@Returns: + + +<!-- ##### FUNCTION soup_soap_response_from_string ##### --> +<para> + +</para> + +@response: +@xmlstr: +@Returns: + + +<!-- ##### FUNCTION soup_soap_response_get_first_parameter ##### --> +<para> + +</para> + +@response: +@Returns: + + +<!-- ##### FUNCTION soup_soap_response_get_first_parameter_by_name ##### --> +<para> + +</para> + +@response: +@name: +@Returns: + + +<!-- ##### FUNCTION soup_soap_response_get_method_name ##### --> +<para> + +</para> + +@response: +@Returns: + + +<!-- ##### FUNCTION soup_soap_response_get_next_parameter ##### --> +<para> + +</para> + +@response: +@from: +@Returns: + + +<!-- ##### FUNCTION soup_soap_response_get_next_parameter_by_name ##### --> +<para> + +</para> + +@response: +@from: +@name: +@Returns: + + +<!-- ##### FUNCTION soup_soap_response_get_parameters ##### --> +<para> + +</para> + +@response: +@Returns: + + diff --git a/docs/reference/tmpl/soup-socket.sgml b/docs/reference/tmpl/soup-socket.sgml index 8a6389a9..78ea20c3 100644 --- a/docs/reference/tmpl/soup-socket.sgml +++ b/docs/reference/tmpl/soup-socket.sgml @@ -2,7 +2,7 @@ SoupSocket <!-- ##### SECTION Short_Description ##### --> - +a network socket <!-- ##### SECTION Long_Description ##### --> <para> @@ -14,40 +14,73 @@ SoupSocket </para> -<!-- ##### MACRO SOUP_SOCKET_FLAG_NONBLOCKING ##### --> +<!-- ##### STRUCT SoupSocket ##### --> <para> </para> +<!-- ##### SIGNAL SoupSocket::connect-result ##### --> +<para> -<!-- ##### MACRO SOUP_SOCKET_FLAG_NODELAY ##### --> +</para> + +@sock: +@status: + +<!-- ##### SIGNAL SoupSocket::disconnected ##### --> <para> </para> +@sock: + +<!-- ##### SIGNAL SoupSocket::new-connection ##### --> +<para> +</para> -<!-- ##### MACRO SOUP_SOCKET_FLAG_REUSEADDR ##### --> +@sock: +@new: + +<!-- ##### SIGNAL SoupSocket::readable ##### --> <para> </para> +@sock: +<!-- ##### SIGNAL SoupSocket::writable ##### --> +<para> -<!-- ##### MACRO SOUP_SOCKET_IS_SERVER ##### --> +</para> + +@sock: + +<!-- ##### ARG SoupSocket:is-server ##### --> <para> </para> +<!-- ##### ARG SoupSocket:nodelay ##### --> +<para> +</para> -<!-- ##### MACRO SOUP_SOCKET_SSL_CREDENTIALS ##### --> +<!-- ##### ARG SoupSocket:non-blocking ##### --> <para> </para> +<!-- ##### ARG SoupSocket:reuseaddr ##### --> +<para> +</para> + +<!-- ##### ARG SoupSocket:ssl-creds ##### --> +<para> + +</para> <!-- ##### FUNCTION soup_socket_new ##### --> <para> @@ -67,8 +100,6 @@ SoupSocket @sock: @remote_addr: @Returns: -<!-- # Unused Parameters # --> -@rem_addr: <!-- ##### FUNCTION soup_socket_listen ##### --> @@ -90,6 +121,16 @@ SoupSocket @Returns: +<!-- ##### FUNCTION soup_socket_start_proxy_ssl ##### --> +<para> + +</para> + +@sock: +@ssl_host: +@Returns: + + <!-- ##### FUNCTION soup_socket_disconnect ##### --> <para> @@ -109,25 +150,22 @@ SoupSocket <!-- ##### USER_FUNCTION SoupSocketCallback ##### --> <para> -The callback function passed to soup_socket_client_new_async(). + </para> -@sock: the #SoupSocket -@status: an HTTP status code indicating success or failure +@sock: +@status: @user_data: -<!-- # Unused Parameters # --> -@data: the data passed to soup_socket_client_new_async() <!-- ##### USER_FUNCTION SoupSocketListenerCallback ##### --> <para> -The callback function passed to soup_socket_server_new(), which -receives new connections. + </para> -@listener: the listening #SoupSocket -@sock: the newly-received #SoupSocket -@user_data: the data passed to soup_socket_server_new(). +@listener: +@sock: +@user_data: <!-- ##### FUNCTION soup_socket_client_new_async ##### --> @@ -153,8 +191,6 @@ receives new connections. @ssl_creds: @status_ret: @Returns: -<!-- # Unused Parameters # --> -@status: <!-- ##### FUNCTION soup_socket_server_new ##### --> @@ -167,8 +203,6 @@ receives new connections. @callback: @user_data: @Returns: -<!-- # Unused Parameters # --> -@Param3: <!-- ##### FUNCTION soup_socket_get_local_address ##### --> @@ -191,13 +225,13 @@ receives new connections. <!-- ##### ENUM SoupSocketIOStatus ##### --> <para> -Return value from the #SoupSocket IO methods. + </para> -@SOUP_SOCKET_OK: Success -@SOUP_SOCKET_WOULD_BLOCK: Cannot read/write any more at this time -@SOUP_SOCKET_EOF: End of file -@SOUP_SOCKET_ERROR: Other error +@SOUP_SOCKET_OK: +@SOUP_SOCKET_WOULD_BLOCK: +@SOUP_SOCKET_EOF: +@SOUP_SOCKET_ERROR: <!-- ##### FUNCTION soup_socket_read ##### --> <para> @@ -238,3 +272,38 @@ Return value from the #SoupSocket IO methods. @Returns: +<!-- ##### MACRO SOUP_SOCKET_FLAG_NONBLOCKING ##### --> +<para> +An alias for the "non-blocking" property. +</para> + + + +<!-- ##### MACRO SOUP_SOCKET_FLAG_NODELAY ##### --> +<para> +An alias for the "nodelay" property. +</para> + + + +<!-- ##### MACRO SOUP_SOCKET_FLAG_REUSEADDR ##### --> +<para> +An alias for the "reuseaddr" property. +</para> + + + +<!-- ##### MACRO SOUP_SOCKET_IS_SERVER ##### --> +<para> +An alias for the "is-server" property. +</para> + + + +<!-- ##### MACRO SOUP_SOCKET_SSL_CREDENTIALS ##### --> +<para> +An alias for the "ssl-creds" property. +</para> + + + diff --git a/docs/reference/tmpl/soup-ssl.sgml b/docs/reference/tmpl/soup-ssl.sgml index c8cedf79..d837f0c3 100644 --- a/docs/reference/tmpl/soup-ssl.sgml +++ b/docs/reference/tmpl/soup-ssl.sgml @@ -2,7 +2,7 @@ soup-ssl <!-- ##### SECTION Short_Description ##### --> - +SSL/TLS handling <!-- ##### SECTION Long_Description ##### --> <para> @@ -16,11 +16,11 @@ soup-ssl <!-- ##### ENUM SoupSSLType ##### --> <para> -What kind of SSL connection this is. + </para> -@SOUP_SSL_TYPE_CLIENT: the client side of an SSL connection -@SOUP_SSL_TYPE_SERVER: the server side of an SSL connection +@SOUP_SSL_TYPE_CLIENT: +@SOUP_SSL_TYPE_SERVER: <!-- ##### FUNCTION soup_ssl_get_client_credentials ##### --> <para> @@ -69,3 +69,27 @@ What kind of SSL connection this is. @Returns: +<!-- ##### MACRO SOUP_SSL_ERROR ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION soup_ssl_error_quark ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### ENUM SoupSocketError ##### --> +<para> + +</para> + +@SOUP_SSL_ERROR_HANDSHAKE_NEEDS_READ: +@SOUP_SSL_ERROR_HANDSHAKE_NEEDS_WRITE: +@SOUP_SSL_ERROR_CERTIFICATE: + diff --git a/docs/reference/tmpl/soup-status.sgml b/docs/reference/tmpl/soup-status.sgml index 374a820b..25f6d7fd 100644 --- a/docs/reference/tmpl/soup-status.sgml +++ b/docs/reference/tmpl/soup-status.sgml @@ -16,136 +16,127 @@ HTTP and Soup status codes <!-- ##### ENUM SoupStatusClass ##### --> <para> -The classes of HTTP and Soup status codes + </para> -@SOUP_STATUS_CLASS_TRANSPORT_ERROR: Network or Soup-level error -@SOUP_STATUS_CLASS_INFORMATIONAL: HTTP 1xx response providing partial -information about the state of a request -@SOUP_STATUS_CLASS_SUCCESS: HTTP 2xx successful response -@SOUP_STATUS_CLASS_REDIRECT: HTTP 3xx redirection response -@SOUP_STATUS_CLASS_CLIENT_ERROR: HTTP 4xx client error response -@SOUP_STATUS_CLASS_SERVER_ERROR: HTTP 5xx server error response +@SOUP_STATUS_CLASS_TRANSPORT_ERROR: +@SOUP_STATUS_CLASS_INFORMATIONAL: +@SOUP_STATUS_CLASS_SUCCESS: +@SOUP_STATUS_CLASS_REDIRECT: +@SOUP_STATUS_CLASS_CLIENT_ERROR: +@SOUP_STATUS_CLASS_SERVER_ERROR: <!-- ##### MACRO SOUP_STATUS_IS_INFORMATIONAL ##### --> <para> -Tests if @status is an Informational (1xx) response. + </para> -@status: an HTTP status code -@Returns: %TRUE if @status is an Information (1xx) response. +@status: +@Returns: <!-- ##### MACRO SOUP_STATUS_IS_SUCCESSFUL ##### --> <para> -Tests if @status is a Successful (2xx) response. + </para> -@status: an HTTP status code -@Returns: %TRUE if @status is a Successful (2xx) response. +@status: +@Returns: <!-- ##### MACRO SOUP_STATUS_IS_REDIRECTION ##### --> <para> -Tests if @status is a Redirection (3xx) response. + </para> -@status: an HTTP status code -@Returns: %TRUE if @status is a Redirection (3xx) response. +@status: +@Returns: <!-- ##### MACRO SOUP_STATUS_IS_CLIENT_ERROR ##### --> <para> -Tests if @status is a Client Error (4xx) response. + </para> -@status: an HTTP status code -@Returns: %TRUE if @status is a Client Error (4xx) response. +@status: +@Returns: <!-- ##### MACRO SOUP_STATUS_IS_SERVER_ERROR ##### --> <para> -Tests if @status is a Server Error (5xx) response. + </para> -@status: an HTTP status code -@Returns: %TRUE if @status is a Server Error (5xx) response. +@status: +@Returns: <!-- ##### ENUM SoupKnownStatusCode ##### --> <para> -These represent the known HTTP status code values, plus various -network and internal errors. + </para> -@SOUP_STATUS_NONE: No status available. (Eg, the message has not been -sent yet) -@SOUP_STATUS_CANCELLED: Message was cancelled locally -@SOUP_STATUS_CANT_RESOLVE: Unable to resolve destination host name -@SOUP_STATUS_CANT_RESOLVE_PROXY: Unable to resolve proxy host name -@SOUP_STATUS_CANT_CONNECT: Unable to connect to remote host -@SOUP_STATUS_CANT_CONNECT_PROXY: Unable to connect to proxy -@SOUP_STATUS_SSL_FAILED: SSL negotiation failed -@SOUP_STATUS_IO_ERROR: A network error occurred, or the other end -closed the connection unexpectedly -@SOUP_STATUS_MALFORMED: Malformed data (usually a programmer error) -@SOUP_STATUS_TRY_AGAIN: Try again. (Only returned in certain -specifically documented cases) -@SOUP_STATUS_CONTINUE: 100 Continue (HTTP) -@SOUP_STATUS_SWITCHING_PROTOCOLS: 101 Switching Protocols (HTTP) -@SOUP_STATUS_PROCESSING: 102 Processing (WebDAV) -@SOUP_STATUS_OK: 200 Success (HTTP). Also used by many lower-level -soup routines to indicate success. -@SOUP_STATUS_CREATED: 201 Created (HTTP) -@SOUP_STATUS_ACCEPTED: 202 Accepted (HTTP) -@SOUP_STATUS_NON_AUTHORITATIVE: 203 Non-Authoritative Information (HTTP) -@SOUP_STATUS_NO_CONTENT: 204 No Content (HTTP) -@SOUP_STATUS_RESET_CONTENT: 205 Reset Content (HTTP) -@SOUP_STATUS_PARTIAL_CONTENT: 206 Partial Content (HTTP) -@SOUP_STATUS_MULTI_STATUS: 207 Multi-Status (WebDAV) -@SOUP_STATUS_MULTIPLE_CHOICES: 300 Multiple Choices (HTTP) -@SOUP_STATUS_MOVED_PERMANENTLY: 301 Moved Permanently (HTTP) -@SOUP_STATUS_FOUND: 302 Found (HTTP) -@SOUP_STATUS_MOVED_TEMPORARILY: 302 Moved Temporarily (old name, RFC 2068) -@SOUP_STATUS_SEE_OTHER: 303 See Other (HTTP) -@SOUP_STATUS_NOT_MODIFIED: 304 Not Modified (HTTP) -@SOUP_STATUS_USE_PROXY: 305 Use Proxy (HTTP) -@SOUP_STATUS_NOT_APPEARING_IN_THIS_PROTOCOL: 306 [Unused] (HTTP) -@SOUP_STATUS_TEMPORARY_REDIRECT: 307 Temporary Redirect (HTTP) -@SOUP_STATUS_BAD_REQUEST: 400 Bad Request (HTTP) -@SOUP_STATUS_UNAUTHORIZED: 401 Unauthorized (HTTP) -@SOUP_STATUS_PAYMENT_REQUIRED: 402 Payment Required (HTTP) -@SOUP_STATUS_FORBIDDEN: 403 Forbidden (HTTP) -@SOUP_STATUS_NOT_FOUND: 404 Not Found (HTTP) -@SOUP_STATUS_METHOD_NOT_ALLOWED: 405 Method Not Allowed (HTTP) -@SOUP_STATUS_NOT_ACCEPTABLE: 406 Not Acceptable (HTTP) -@SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED: 407 Proxy Authentication -Required (HTTP) -@SOUP_STATUS_PROXY_UNAUTHORIZED: shorter alias for %SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED -@SOUP_STATUS_REQUEST_TIMEOUT: 408 Request Timeout (HTTP) -@SOUP_STATUS_CONFLICT: 409 Conflict (HTTP) -@SOUP_STATUS_GONE: 410 Gone (HTTP) -@SOUP_STATUS_LENGTH_REQUIRED: 411 Length Required (HTTP) -@SOUP_STATUS_PRECONDITION_FAILED: 412 Precondition Failed (HTTP) -@SOUP_STATUS_REQUEST_ENTITY_TOO_LARGE: 413 Request Entity Too Large (HTTP) -@SOUP_STATUS_REQUEST_URI_TOO_LONG: 414 Request-URI Too Long (HTTP) -@SOUP_STATUS_UNSUPPORTED_MEDIA_TYPE: 415 Unsupported Media Type (HTTP) -@SOUP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE: 416 Requested Range Not -Satisfiable (HTTP) -@SOUP_STATUS_INVALID_RANGE: shorter alias for %SOUP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE -@SOUP_STATUS_EXPECTATION_FAILED: 417 Expectation Failed (HTTP) -@SOUP_STATUS_UNPROCESSABLE_ENTITY: 422 Unprocessable Entity (WebDAV) -@SOUP_STATUS_LOCKED: 423 Locked (WebDAV) -@SOUP_STATUS_FAILED_DEPENDENCY: 424 Failed Dependency (WebDAV) -@SOUP_STATUS_INTERNAL_SERVER_ERROR: 500 Internal Server Error (HTTP) -@SOUP_STATUS_NOT_IMPLEMENTED: 501 Not Implemented (HTTP) -@SOUP_STATUS_BAD_GATEWAY: 502 Bad Gateway (HTTP) -@SOUP_STATUS_SERVICE_UNAVAILABLE: 503 Service Unavailable (HTTP) -@SOUP_STATUS_GATEWAY_TIMEOUT: 504 Gateway Timeout (HTTP) -@SOUP_STATUS_HTTP_VERSION_NOT_SUPPORTED: 505 HTTP Version Not -Supported (HTTP) -@SOUP_STATUS_INSUFFICIENT_STORAGE: 507 Insufficient Storage (WebDAV) -@SOUP_STATUS_NOT_EXTENDED: 510 Not Extended (RFC 2774) +@SOUP_STATUS_NONE: +@SOUP_STATUS_CANCELLED: +@SOUP_STATUS_CANT_RESOLVE: +@SOUP_STATUS_CANT_RESOLVE_PROXY: +@SOUP_STATUS_CANT_CONNECT: +@SOUP_STATUS_CANT_CONNECT_PROXY: +@SOUP_STATUS_SSL_FAILED: +@SOUP_STATUS_IO_ERROR: +@SOUP_STATUS_MALFORMED: +@SOUP_STATUS_TRY_AGAIN: +@SOUP_STATUS_CONTINUE: +@SOUP_STATUS_SWITCHING_PROTOCOLS: +@SOUP_STATUS_PROCESSING: +@SOUP_STATUS_OK: +@SOUP_STATUS_CREATED: +@SOUP_STATUS_ACCEPTED: +@SOUP_STATUS_NON_AUTHORITATIVE: +@SOUP_STATUS_NO_CONTENT: +@SOUP_STATUS_RESET_CONTENT: +@SOUP_STATUS_PARTIAL_CONTENT: +@SOUP_STATUS_MULTI_STATUS: +@SOUP_STATUS_MULTIPLE_CHOICES: +@SOUP_STATUS_MOVED_PERMANENTLY: +@SOUP_STATUS_FOUND: +@SOUP_STATUS_MOVED_TEMPORARILY: +@SOUP_STATUS_SEE_OTHER: +@SOUP_STATUS_NOT_MODIFIED: +@SOUP_STATUS_USE_PROXY: +@SOUP_STATUS_NOT_APPEARING_IN_THIS_PROTOCOL: +@SOUP_STATUS_TEMPORARY_REDIRECT: +@SOUP_STATUS_BAD_REQUEST: +@SOUP_STATUS_UNAUTHORIZED: +@SOUP_STATUS_PAYMENT_REQUIRED: +@SOUP_STATUS_FORBIDDEN: +@SOUP_STATUS_NOT_FOUND: +@SOUP_STATUS_METHOD_NOT_ALLOWED: +@SOUP_STATUS_NOT_ACCEPTABLE: +@SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED: +@SOUP_STATUS_PROXY_UNAUTHORIZED: +@SOUP_STATUS_REQUEST_TIMEOUT: +@SOUP_STATUS_CONFLICT: +@SOUP_STATUS_GONE: +@SOUP_STATUS_LENGTH_REQUIRED: +@SOUP_STATUS_PRECONDITION_FAILED: +@SOUP_STATUS_REQUEST_ENTITY_TOO_LARGE: +@SOUP_STATUS_REQUEST_URI_TOO_LONG: +@SOUP_STATUS_UNSUPPORTED_MEDIA_TYPE: +@SOUP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE: +@SOUP_STATUS_INVALID_RANGE: +@SOUP_STATUS_EXPECTATION_FAILED: +@SOUP_STATUS_UNPROCESSABLE_ENTITY: +@SOUP_STATUS_LOCKED: +@SOUP_STATUS_FAILED_DEPENDENCY: +@SOUP_STATUS_INTERNAL_SERVER_ERROR: +@SOUP_STATUS_NOT_IMPLEMENTED: +@SOUP_STATUS_BAD_GATEWAY: +@SOUP_STATUS_SERVICE_UNAVAILABLE: +@SOUP_STATUS_GATEWAY_TIMEOUT: +@SOUP_STATUS_HTTP_VERSION_NOT_SUPPORTED: +@SOUP_STATUS_INSUFFICIENT_STORAGE: +@SOUP_STATUS_NOT_EXTENDED: <!-- ##### FUNCTION soup_status_get_phrase ##### --> <para> diff --git a/docs/reference/tmpl/soup-uri.sgml b/docs/reference/tmpl/soup-uri.sgml index 5058ce64..48150ed1 100644 --- a/docs/reference/tmpl/soup-uri.sgml +++ b/docs/reference/tmpl/soup-uri.sgml @@ -2,7 +2,7 @@ soup-uri <!-- ##### SECTION Short_Description ##### --> - +URIs <!-- ##### SECTION Long_Description ##### --> <para> @@ -14,23 +14,37 @@ soup-uri </para> +<!-- ##### STRUCT SoupUri ##### --> +<para> + +</para> + +@protocol: +@user: +@passwd: +@host: +@port: +@path: +@query: +@fragment: +@broken_encoding: + <!-- ##### TYPEDEF SoupProtocol ##### --> <para> -#GQuark is used for SoupProtocol so that the protocol of a #SoupUri -can be tested quickly. + </para> <!-- ##### MACRO SOUP_PROTOCOL_HTTP ##### --> <para> -This returns the #SoupProtocol value for "http". + </para> <!-- ##### MACRO SOUP_PROTOCOL_HTTPS ##### --> <para> -This returns the #SoupProtocol value for "https". + </para> |