libsoup r1010 - in branches/libsoup-2.4: . docs/reference docs/reference/tmpl libsoup
- From: danw svn gnome org
- To: svn-commits-list gnome org
- Subject: libsoup r1010 - in branches/libsoup-2.4: . docs/reference docs/reference/tmpl libsoup
- Date: Sun, 6 Jan 2008 15:52:43 +0000 (GMT)
Author: danw
Date: Sun Jan 6 15:52:42 2008
New Revision: 1010
URL: http://svn.gnome.org/viewvc/libsoup?rev=1010&view=rev
Log:
* libsoup/*.c: misc documentation updates/gtk-doc fixes
* libsoup/soup-server.c: finally start documenting this properly.
* libsoup/soup-status.h (SoupStatusClass): kill this, since
soup_message_add_status_class_handler() is gone now.
* libsoup/soup-status.c (soup_status_get_phrase): Update docs to
explain that you probably don't want to use this.
* libsoup/soup-misc.h (SOUP_SSL_ERROR, SoupSSLError): Move these
here, since soup-ssl.h isn't installed.
* docs/references: start updating this...
Added:
branches/libsoup-2.4/docs/reference/tmpl/soup-auth-domain-basic.sgml
branches/libsoup-2.4/docs/reference/tmpl/soup-auth-domain-digest.sgml
branches/libsoup-2.4/docs/reference/tmpl/soup-auth-domain.sgml
branches/libsoup-2.4/docs/reference/tmpl/soup-message-body.sgml
branches/libsoup-2.4/docs/reference/tmpl/soup-message-headers.sgml
branches/libsoup-2.4/docs/reference/tmpl/soup-method.sgml
branches/libsoup-2.4/docs/reference/tmpl/soup-value-utils.sgml
branches/libsoup-2.4/docs/reference/tmpl/soup-xmlrpc.sgml
Removed:
branches/libsoup-2.4/docs/reference/tmpl/soup-connection-ntlm.sgml
branches/libsoup-2.4/docs/reference/tmpl/soup-connection.sgml
branches/libsoup-2.4/docs/reference/tmpl/soup-dns.sgml
branches/libsoup-2.4/docs/reference/tmpl/soup-md5-utils.sgml
branches/libsoup-2.4/docs/reference/tmpl/soup-message-filter.sgml
branches/libsoup-2.4/docs/reference/tmpl/soup-message-private.sgml
branches/libsoup-2.4/docs/reference/tmpl/soup-message-queue.sgml
branches/libsoup-2.4/docs/reference/tmpl/soup-server-auth.sgml
branches/libsoup-2.4/docs/reference/tmpl/soup-server-message.sgml
branches/libsoup-2.4/docs/reference/tmpl/soup-soap-message.sgml
branches/libsoup-2.4/docs/reference/tmpl/soup-soap-response.sgml
branches/libsoup-2.4/docs/reference/tmpl/soup-ssl.sgml
branches/libsoup-2.4/docs/reference/tmpl/soup-xmlrpc-message.sgml
branches/libsoup-2.4/docs/reference/tmpl/soup-xmlrpc-response.sgml
Modified:
branches/libsoup-2.4/ChangeLog
branches/libsoup-2.4/docs/reference/libsoup-docs.sgml
branches/libsoup-2.4/docs/reference/libsoup-sections.txt
branches/libsoup-2.4/docs/reference/libsoup.types
branches/libsoup-2.4/docs/reference/tmpl/libsoup-unused.sgml
branches/libsoup-2.4/docs/reference/tmpl/soup-address.sgml
branches/libsoup-2.4/docs/reference/tmpl/soup-auth.sgml
branches/libsoup-2.4/docs/reference/tmpl/soup-message.sgml
branches/libsoup-2.4/docs/reference/tmpl/soup-misc.sgml
branches/libsoup-2.4/docs/reference/tmpl/soup-server.sgml
branches/libsoup-2.4/docs/reference/tmpl/soup-session.sgml
branches/libsoup-2.4/docs/reference/tmpl/soup-socket.sgml
branches/libsoup-2.4/docs/reference/tmpl/soup-status.sgml
branches/libsoup-2.4/docs/reference/tmpl/soup-uri.sgml
branches/libsoup-2.4/libsoup/soup-auth-domain-basic.c
branches/libsoup-2.4/libsoup/soup-auth-domain-digest.c
branches/libsoup-2.4/libsoup/soup-auth.c
branches/libsoup-2.4/libsoup/soup-message-headers.c
branches/libsoup-2.4/libsoup/soup-message.c
branches/libsoup-2.4/libsoup/soup-message.h
branches/libsoup-2.4/libsoup/soup-misc.h
branches/libsoup-2.4/libsoup/soup-server.c
branches/libsoup-2.4/libsoup/soup-server.h
branches/libsoup-2.4/libsoup/soup-ssl.h
branches/libsoup-2.4/libsoup/soup-status.c
branches/libsoup-2.4/libsoup/soup-status.h
branches/libsoup-2.4/libsoup/soup-xmlrpc.c
Modified: branches/libsoup-2.4/ChangeLog
==============================================================================
--- branches/libsoup-2.4/ChangeLog (original)
+++ branches/libsoup-2.4/ChangeLog Sun Jan 6 15:52:42 2008
@@ -1,3 +1,20 @@
+2008-01-06 Dan Winship <danw gnome org>
+
+ * libsoup/*.c: misc documentation updates/gtk-doc fixes
+
+ * libsoup/soup-server.c: finally start documenting this properly.
+
+ * libsoup/soup-status.h (SoupStatusClass): kill this, since
+ soup_message_add_status_class_handler() is gone now.
+
+ * libsoup/soup-status.c (soup_status_get_phrase): Update docs to
+ explain that you probably don't want to use this.
+
+ * libsoup/soup-misc.h (SOUP_SSL_ERROR, SoupSSLError): Move these
+ here, since soup-ssl.h isn't installed.
+
+ * docs/references: start updating this...
+
2008-01-04 Dan Winship <danw gnome org>
* libsoup/soup-message-body.c (soup_buffer_new)
Modified: branches/libsoup-2.4/docs/reference/libsoup-docs.sgml
==============================================================================
--- branches/libsoup-2.4/docs/reference/libsoup-docs.sgml (original)
+++ branches/libsoup-2.4/docs/reference/libsoup-docs.sgml Sun Jan 6 15:52:42 2008
@@ -16,30 +16,24 @@
<title>libsoup API Reference</title>
<xi:include href="xml/soup-address.xml"/>
<xi:include href="xml/soup-auth.xml"/>
- <xi:include href="xml/soup-connection.xml"/>
- <xi:include href="xml/soup-connection-ntlm.xml"/>
+ <xi:include href="xml/soup-auth-domain.xml"/>
+ <xi:include href="xml/soup-auth-domain-basic.xml"/>
+ <xi:include href="xml/soup-auth-domain-digest.xml"/>
<xi:include href="xml/soup-message.xml"/>
- <xi:include href="xml/soup-message-filter.xml"/>
- <xi:include href="xml/soup-server-message.xml"/>
+ <xi:include href="xml/soup-message-headers.xml"/>
+ <xi:include href="xml/soup-message-body.xml"/>
+ <xi:include href="xml/soup-method.xml"/>
<xi:include href="xml/soup-server.xml"/>
<xi:include href="xml/soup-session.xml"/>
<xi:include href="xml/soup-session-async.xml"/>
<xi:include href="xml/soup-session-sync.xml"/>
- <xi:include href="xml/soup-soap-message.xml"/>
- <xi:include href="xml/soup-soap-response.xml"/>
<xi:include href="xml/soup-socket.xml"/>
<xi:include href="xml/soup-status.xml"/>
<xi:include href="xml/soup-uri.xml"/>
- <xi:include href="xml/soup-xmlrpc-message.xml"/>
- <xi:include href="xml/soup-xmlrpc-response.xml"/>
+ <xi:include href="xml/soup-value-utils.xml"/>
+ <xi:include href="xml/soup-xmlrpc.xml"/>
<xi:include href="xml/soup-misc.xml"/>
</chapter>
- <chapter>
- <title>libsoup internals</title>
- <xi:include href="xml/soup-dns.xml"/>
- <xi:include href="xml/soup-ssl.xml"/>
- </chapter>
-
<index></index>
</book>
Modified: branches/libsoup-2.4/docs/reference/libsoup-sections.txt
==============================================================================
--- branches/libsoup-2.4/docs/reference/libsoup-sections.txt (original)
+++ branches/libsoup-2.4/docs/reference/libsoup-sections.txt Sun Jan 6 15:52:42 2008
@@ -2,26 +2,13 @@
<FILE>soup-message</FILE>
<TITLE>SoupMessage</TITLE>
SoupMessage
-SoupMessageStatus
-SOUP_MESSAGE_IS_STARTING
-SoupTransferEncoding
-SoupOwnership
-SoupDataBuffer
-SoupMessageCallbackFn
<SUBSECTION>
soup_message_new
soup_message_new_from_uri
soup_message_set_request
soup_message_set_response
<SUBSECTION>
-soup_message_add_header
-soup_message_get_header
-soup_message_get_header_list
-soup_message_foreach_header
-soup_message_remove_header
-soup_message_clear_headers
-<SUBSECTION>
-SoupHttpVersion
+SoupHTTPVersion
soup_message_set_http_version
soup_message_get_http_version
soup_message_get_uri
@@ -32,25 +19,17 @@
<SUBSECTION>
soup_message_set_status
soup_message_set_status_full
-soup_message_add_chunk
-soup_message_add_final_chunk
-soup_message_pop_chunk
soup_message_is_keepalive
-soup_message_get_request_encoding
-soup_message_get_response_encoding
<SUBSECTION>
-SoupHandlerPhase
-soup_message_add_handler
soup_message_add_header_handler
soup_message_add_status_code_handler
-soup_message_add_status_class_handler
-soup_message_remove_handler
<SUBSECTION>
-soup_message_send_request
-soup_message_read_request
-soup_message_io_pause
-soup_message_io_unpause
-soup_message_io_stop
+SOUP_MESSAGE_METHOD
+SOUP_MESSAGE_URI
+SOUP_MESSAGE_HTTP_VERSION
+SOUP_MESSAGE_FLAGS
+SOUP_MESSAGE_STATUS_CODE
+SOUP_MESSAGE_REASON_PHRASE
<SUBSECTION Standard>
SOUP_MESSAGE
SOUP_IS_MESSAGE
@@ -63,6 +42,20 @@
SoupMessagePrivate
SOUP_MESSAGE_GET_PRIVATE
<SUBSECTION Private>
+soup_message_wrote_informational
+soup_message_wrote_headers
+soup_message_wrote_chunk
+soup_message_wrote_body
+soup_message_got_informational
+soup_message_got_headers
+soup_message_got_chunk
+soup_message_got_body
+soup_message_finished
+soup_message_restarted
+</SECTION>
+
+<SECTION>
+<FILE>soup-method</FILE>
SOUP_METHOD_OPTIONS
SOUP_METHOD_GET
SOUP_METHOD_HEAD
@@ -79,35 +72,60 @@
SOUP_METHOD_LOCK
SOUP_METHOD_UNLOCK
SOUP_METHOD_PATCH
-SoupMethodId
-soup_method_get_id
-soup_message_wrote_informational
-soup_message_wrote_headers
-soup_message_wrote_chunk
-soup_message_wrote_body
-soup_message_got_informational
-soup_message_got_headers
-soup_message_got_chunk
-soup_message_got_body
-soup_message_finished
-soup_message_restarted
-SoupMessageGetHeadersFn
-SoupMessageParseHeadersFn
-soup_message_cleanup_response
-soup_message_io_client
-soup_message_io_in_progress
-soup_message_io_server
-soup_message_run_handlers
-soup_message_send_request_internal
-soup_message_get_auth
-soup_message_get_proxy_auth
-soup_message_set_auth
-soup_message_set_proxy_auth
+</SECTION>
+
+<SECTION>
+<FILE>soup-message-headers</FILE>
+<TITLE>SoupMessageHeaders</TITLE>
+SoupMessageHeaders
+SoupMessageHeadersType
+soup_message_headers_new
+soup_message_headers_free
+<SUBSECTION>
+soup_message_headers_append
+soup_message_headers_replace
+soup_message_headers_remove
+soup_message_headers_clear
+soup_message_headers_get
+SoupMessageHeadersForeachFunc
+soup_message_headers_foreach
+<SUBSECTION>
+SoupEncoding
+soup_message_headers_get_encoding
+soup_message_headers_set_encoding
+soup_message_headers_get_content_length
+soup_message_headers_set_content_length
+<SUBSECTION>
+SoupExpectation
+soup_message_headers_get_expectations
+soup_message_headers_set_expectations
+</SECTION>
+
+<SECTION>
+<FILE>soup-message-body</FILE>
+<TITLE>SoupMessageBody</TITLE>
+SoupBuffer
+SoupMemoryUse
+soup_buffer_new
+soup_buffer_new_subbuffer
+soup_buffer_copy
+soup_buffer_free
+<SUBSECTION>
+SoupMessageBody
+soup_message_body_new
+soup_message_body_free
+<SUBSECTION>
+soup_message_body_append
+soup_message_body_append_buffer
+soup_message_body_truncate
+soup_message_body_complete
+soup_message_body_flatten
+soup_message_body_get_chunk
</SECTION>
<SECTION>
<FILE>soup-status</FILE>
-SoupStatusClass
+SOUP_STATUS_IS_TRANSPORT_ERROR
SOUP_STATUS_IS_INFORMATIONAL
SOUP_STATUS_IS_SUCCESSFUL
SOUP_STATUS_IS_REDIRECTION
@@ -115,32 +133,37 @@
SOUP_STATUS_IS_SERVER_ERROR
SoupKnownStatusCode
soup_status_get_phrase
-<SUBSECTION Standard>
-SOUP_STATUS_IS_TRANSPORT_ERROR
+<SUBSECTION>
+SOUP_HTTP_ERROR
+<SUBSECTION Private>
+soup_http_error_quark
</SECTION>
<SECTION>
<FILE>soup-server</FILE>
<TITLE>SoupServer</TITLE>
SoupServer
-SoupServerContext
-SoupServerCallbackFn
-SoupServerUnregisterFn
soup_server_new
-soup_server_get_protocol
+soup_server_is_https
soup_server_get_port
soup_server_get_listener
soup_server_run
soup_server_run_async
soup_server_quit
+soup_server_get_async_context
<SUBSECTION>
-SoupServerHandler
+SoupServerCallback
soup_server_add_handler
soup_server_remove_handler
-soup_server_get_handler
-soup_server_list_handlers
-soup_server_context_get_client_address
-soup_server_context_get_client_host
+SoupClientContext
+soup_client_context_get_address
+soup_client_context_get_host
+<SUBSECTION>
+soup_server_add_auth_domain
+soup_server_remove_auth_domain
+<SUBSECTION>
+soup_server_pause_message
+soup_server_unpause_message
<SUBSECTION>
SOUP_SERVER_PORT
SOUP_SERVER_INTERFACE
@@ -156,18 +179,84 @@
SOUP_IS_SERVER_CLASS
SOUP_SERVER_GET_CLASS
SoupServerClass
-<SUBSECTION Private>
-soup_server_auth_check_passwd
-soup_server_auth_context_challenge
-soup_server_auth_free
-soup_server_auth_get_user
-soup_server_auth_new
-SoupServerAuthBasic
-SoupServerAuthCallbackFn
-SoupServerAuthContext
-SoupServerAuthDigest
-SoupAuthType
-SoupDigestAlgorithm
+</SECTION>
+
+<SECTION>
+<FILE>soup-auth-domain</FILE>
+<TITLE>SoupAuthDomain</TITLE>
+SoupAuthDomain
+<SUBSECTION>
+soup_auth_domain_add_path
+soup_auth_domain_remove_path
+soup_auth_domain_set_filter
+soup_auth_domain_get_realm
+<SUBSECTION>
+soup_auth_domain_covers
+soup_auth_domain_accepts
+soup_auth_domain_challenge
+<SUBSECTION>
+SOUP_AUTH_DOMAIN_REALM
+SOUP_AUTH_DOMAIN_PROXY
+SOUP_AUTH_DOMAIN_ADD_PATH
+SOUP_AUTH_DOMAIN_REMOVE_PATH
+SOUP_AUTH_DOMAIN_FILTER
+SOUP_AUTH_DOMAIN_FILTER_DATA
+<SUBSECTION Standard>
+SOUP_AUTH_DOMAIN
+SOUP_IS_AUTH_DOMAIN
+SOUP_TYPE_AUTH_DOMAIN
+soup_auth_domain_get_type
+SOUP_AUTH_DOMAIN_CLASS
+SOUP_IS_AUTH_DOMAIN_CLASS
+SOUP_AUTH_DOMAIN_GET_CLASS
+SoupAuthDomainClass
+</SECTION>
+
+<SECTION>
+<FILE>soup-auth-domain-basic</FILE>
+<TITLE>SoupAuthDomainBasic</TITLE>
+SoupAuthDomainBasic
+soup_auth_domain_basic_new
+<SUBSECTION>
+SoupAuthDomainBasicAuthCallback
+soup_auth_domain_basic_set_auth_callback
+<SUBSECTION>
+SOUP_AUTH_DOMAIN_BASIC_AUTH_CALLBACK
+SOUP_AUTH_DOMAIN_BASIC_AUTH_DATA
+<SUBSECTION Standard>
+SOUP_AUTH_DOMAIN_BASIC
+SOUP_IS_AUTH_DOMAIN_BASIC
+SOUP_TYPE_AUTH_DOMAIN_BASIC
+soup_auth_domain_basic_get_type
+SOUP_AUTH_DOMAIN_BASIC_CLASS
+SOUP_IS_AUTH_DOMAIN_BASIC_CLASS
+SOUP_AUTH_DOMAIN_BASIC_GET_CLASS
+SoupAuthDomainBasicClass
+</SECTION>
+
+<SECTION>
+<FILE>soup-auth-domain-digest</FILE>
+<TITLE>SoupAuthDomainDigest</TITLE>
+SoupAuthDomainDigest
+soup_auth_domain_digest_new
+<SUBSECTION>
+SoupAuthDomainDigestAuthCallback
+soup_auth_domain_digest_set_auth_callback
+soup_auth_domain_digest_encode_password
+<SUBSECTION>
+soup_auth_domain_digest_evil_check_password
+<SUBSECTION>
+SOUP_AUTH_DOMAIN_DIGEST_AUTH_CALLBACK
+SOUP_AUTH_DOMAIN_DIGEST_AUTH_DATA
+<SUBSECTION Standard>
+SOUP_AUTH_DOMAIN_DIGEST
+SOUP_IS_AUTH_DOMAIN_DIGEST
+SOUP_TYPE_AUTH_DOMAIN_DIGEST
+soup_auth_domain_digest_get_type
+SOUP_AUTH_DOMAIN_DIGEST_CLASS
+SOUP_IS_AUTH_DOMAIN_DIGEST_CLASS
+SOUP_AUTH_DOMAIN_DIGEST_GET_CLASS
+SoupAuthDomainDigestClass
</SECTION>
<SECTION>
@@ -179,10 +268,11 @@
soup_address_new
soup_address_new_from_sockaddr
soup_address_new_any
+<SUBSECTION>
SoupAddressCallback
soup_address_resolve_async
-soup_address_resolve_async_full
soup_address_resolve_sync
+<SUBSECTION>
soup_address_get_name
soup_address_get_sockaddr
soup_address_get_physical
@@ -199,100 +289,19 @@
</SECTION>
<SECTION>
-<FILE>soup-soap-message</FILE>
-SoupSoapMessage
-<TITLE>SoupSoapMessage</TITLE>
-soup_soap_message_new
-soup_soap_message_new_from_uri
-soup_soap_message_start_envelope
-soup_soap_message_end_envelope
-soup_soap_message_start_body
-soup_soap_message_end_body
-soup_soap_message_start_element
-soup_soap_message_end_element
-soup_soap_message_start_fault
-soup_soap_message_end_fault
-soup_soap_message_start_fault_detail
-soup_soap_message_end_fault_detail
-soup_soap_message_start_header
-soup_soap_message_end_header
-soup_soap_message_start_header_element
-soup_soap_message_end_header_element
-soup_soap_message_write_int
-soup_soap_message_write_double
-soup_soap_message_write_base64
-soup_soap_message_write_time
-soup_soap_message_write_string
-soup_soap_message_write_buffer
-soup_soap_message_set_element_type
-soup_soap_message_set_null
-soup_soap_message_add_attribute
-soup_soap_message_add_namespace
-soup_soap_message_set_default_namespace
-soup_soap_message_set_encoding_style
-soup_soap_message_reset
-soup_soap_message_persist
-soup_soap_message_get_namespace_prefix
-soup_soap_message_get_xml_doc
-soup_soap_message_parse_response
-<SUBSECTION Standard>
-SOUP_IS_SOAP_MESSAGE
-SOUP_IS_SOAP_MESSAGE_CLASS
-SOUP_SOAP_MESSAGE
-SOUP_SOAP_MESSAGE_CLASS
-SOUP_SOAP_MESSAGE_GET_CLASS
-SOUP_TYPE_SOAP_MESSAGE
-SoupSoapMessageClass
-soup_soap_message_get_type
-</SECTION>
-
-<SECTION>
-<FILE>soup-soap-response</FILE>
-<TITLE>SoupSoapResponse</TITLE>
-SoupSoapResponse
-SoupSoapParameter
-soup_soap_response_new
-soup_soap_response_new_from_string
-soup_soap_response_set_method_name
-soup_soap_parameter_get_first_child
-soup_soap_parameter_get_first_child_by_name
-soup_soap_parameter_get_int_value
-soup_soap_parameter_get_name
-soup_soap_parameter_get_next_child
-soup_soap_parameter_get_next_child_by_name
-soup_soap_parameter_get_property
-soup_soap_parameter_get_string_value
-soup_soap_response_from_string
-soup_soap_response_get_first_parameter
-soup_soap_response_get_first_parameter_by_name
-soup_soap_response_get_method_name
-soup_soap_response_get_next_parameter
-soup_soap_response_get_next_parameter_by_name
-soup_soap_response_get_parameters
-<SUBSECTION Standard>
-SOUP_IS_SOAP_RESPONSE
-SOUP_IS_SOAP_RESPONSE_CLASS
-SOUP_SOAP_RESPONSE
-SOUP_SOAP_RESPONSE_CLASS
-SOUP_SOAP_RESPONSE_GET_CLASS
-SOUP_TYPE_SOAP_RESPONSE
-SoupSoapResponseClass
-soup_soap_response_get_type
-</SECTION>
-
-<SECTION>
<FILE>soup-session</FILE>
<TITLE>SoupSession</TITLE>
SoupSession
+<SUBSECTION>
+SoupSessionCallback
soup_session_queue_message
soup_session_requeue_message
soup_session_send_message
-soup_session_abort
-soup_session_add_filter
soup_session_cancel_message
-soup_session_get_connection
-soup_session_remove_filter
-soup_session_try_prune_connection
+soup_session_abort
+<SUBSECTION>
+soup_session_get_async_context
+<SUBSECTION>
SOUP_SESSION_PROXY_URI
SOUP_SESSION_MAX_CONNS
SOUP_SESSION_MAX_CONNS_PER_HOST
@@ -309,17 +318,6 @@
SOUP_TYPE_SESSION
SoupSessionClass
soup_session_get_type
-<SUBSECTION Private>
-SoupMessageQueue
-SoupMessageQueueIter
-soup_message_queue_append
-soup_message_queue_destroy
-soup_message_queue_first
-soup_message_queue_free_iter
-soup_message_queue_new
-soup_message_queue_next
-soup_message_queue_remove
-soup_message_queue_remove_message
</SECTION>
<SECTION>
@@ -360,16 +358,27 @@
<FILE>soup-auth</FILE>
<TITLE>SoupAuth</TITLE>
SoupAuth
-SoupAuthBasic
-SoupAuthDigest
-soup_auth_new_from_header_list
+soup_auth_new
+soup_auth_update
+<SUBSECTION>
+soup_auth_is_for_proxy
soup_auth_get_scheme_name
+soup_auth_get_host
soup_auth_get_realm
+soup_auth_get_info
+<SUBSECTION>
soup_auth_authenticate
soup_auth_is_authenticated
+<SUBSECTION>
soup_auth_get_authorization
soup_auth_get_protection_space
soup_auth_free_protection_space
+<SUBSECTION>
+SOUP_AUTH_SCHEME_NAME
+SOUP_AUTH_REALM
+SOUP_AUTH_HOST
+SOUP_AUTH_IS_FOR_PROXY
+SOUP_AUTH_IS_AUTHENTICATED
<SUBSECTION Standard>
SOUP_AUTH
SOUP_IS_AUTH
@@ -379,22 +388,6 @@
SOUP_IS_AUTH_CLASS
SOUP_AUTH_GET_CLASS
SoupAuthClass
-SOUP_AUTH_BASIC
-SOUP_IS_AUTH_BASIC
-SOUP_TYPE_AUTH_BASIC
-soup_auth_basic_get_type
-SOUP_AUTH_BASIC_CLASS
-SOUP_IS_AUTH_BASIC_CLASS
-SOUP_AUTH_BASIC_GET_CLASS
-SoupAuthBasicClass
-SOUP_AUTH_DIGEST
-SOUP_IS_AUTH_DIGEST
-SOUP_TYPE_AUTH_DIGEST
-soup_auth_digest_get_type
-SOUP_AUTH_DIGEST_CLASS
-SOUP_IS_AUTH_DIGEST_CLASS
-SOUP_AUTH_DIGEST_GET_CLASS
-SoupAuthDigestClass
</SECTION>
<SECTION>
@@ -402,31 +395,37 @@
<TITLE>SoupSocket</TITLE>
SoupSocket
soup_socket_new
-soup_socket_connect
+<SUBSECTION>
+SoupSocketCallback
+soup_socket_connect_async
+soup_socket_connect_sync
+<SUBSECTION>
soup_socket_listen
+<SUBSECTION>
soup_socket_start_ssl
soup_socket_start_proxy_ssl
+<SUBSECTION>
soup_socket_disconnect
soup_socket_is_connected
-SoupSocketCallback
-SoupSocketListenerCallback
-soup_socket_client_new_async
-soup_socket_client_new_sync
-soup_socket_server_new
+<SUBSECTION>
soup_socket_get_local_address
soup_socket_get_remote_address
+<SUBSECTION>
SoupSocketIOStatus
soup_socket_read
soup_socket_read_until
soup_socket_write
+<SUBSECTION>
+SOUP_SSL_ERROR
+SoupSSLError
+<SUBSECTION>
+SOUP_SOCKET_LOCAL_ADDRESS
+SOUP_SOCKET_REMOTE_ADDRESS
SOUP_SOCKET_FLAG_NONBLOCKING
-SOUP_SOCKET_FLAG_NODELAY
-SOUP_SOCKET_FLAG_REUSEADDR
-SOUP_SOCKET_FLAG_CLOEXEC
-SOUP_SOCKET_TIMEOUT
SOUP_SOCKET_IS_SERVER
SOUP_SOCKET_SSL_CREDENTIALS
SOUP_SOCKET_ASYNC_CONTEXT
+SOUP_SOCKET_TIMEOUT
<SUBSECTION Standard>
SOUP_SOCKET
SOUP_IS_SOCKET
@@ -436,261 +435,111 @@
SOUP_IS_SOCKET_CLASS
SOUP_SOCKET_GET_CLASS
SoupSocketClass
-</SECTION>
-
-<SECTION>
-<FILE>soup-connection-ntlm</FILE>
-<TITLE>SoupConnectionNTLM</TITLE>
-SoupConnectionNTLM
-<SUBSECTION Standard>
-SOUP_CONNECTION_NTLM
-SOUP_IS_CONNECTION_NTLM
-SOUP_TYPE_CONNECTION_NTLM
-soup_connection_ntlm_get_type
-SOUP_CONNECTION_NTLM_CLASS
-SOUP_IS_CONNECTION_NTLM_CLASS
-SOUP_CONNECTION_NTLM_GET_CLASS
-SoupConnectionNTLMClass
-</SECTION>
-
-<SECTION>
-<FILE>soup-connection</FILE>
-<TITLE>SoupConnection</TITLE>
-SoupConnection
-soup_connection_new
-SoupConnectionCallback
-soup_connection_connect_async
-soup_connection_connect_sync
-soup_connection_disconnect
-soup_connection_is_in_use
-soup_connection_last_used
-soup_connection_send_request
-soup_connection_authenticate
-soup_connection_reauthenticate
-soup_connection_release
-soup_connection_reserve
-SOUP_CONNECTION_ORIGIN_URI
-SOUP_CONNECTION_PROXY_URI
-SOUP_CONNECTION_SSL_CREDENTIALS
-SOUP_CONNECTION_MESSAGE_FILTER
-SOUP_CONNECTION_ASYNC_CONTEXT
-SOUP_CONNECTION_TIMEOUT
-<SUBSECTION Standard>
-SOUP_CONNECTION
-SOUP_IS_CONNECTION
-SOUP_TYPE_CONNECTION
-soup_connection_get_type
-SOUP_CONNECTION_CLASS
-SOUP_IS_CONNECTION_CLASS
-SOUP_CONNECTION_GET_CLASS
-SoupConnectionClass
-</SECTION>
-
-<SECTION>
-<FILE>soup-server-message</FILE>
-<TITLE>SoupServerMessage</TITLE>
-SoupServerMessage
-soup_server_message_new
-soup_server_message_get_server
-soup_server_message_set_encoding
-soup_server_message_get_encoding
-soup_server_message_start
-soup_server_message_is_started
-soup_server_message_finish
-soup_server_message_is_finished
-<SUBSECTION Standard>
-SOUP_SERVER_MESSAGE
-SOUP_IS_SERVER_MESSAGE
-SOUP_TYPE_SERVER_MESSAGE
-soup_server_message_get_type
-SOUP_SERVER_MESSAGE_CLASS
-SOUP_IS_SERVER_MESSAGE_CLASS
-SOUP_SERVER_MESSAGE_GET_CLASS
-SoupServerMessageClass
-</SECTION>
-
-<SECTION>
-<FILE>soup-dns</FILE>
-soup_dns_init
-soup_dns_ntop
-SoupDNSLookup
-soup_dns_lookup_name
-soup_dns_lookup_address
-soup_dns_lookup_resolve
-SoupDNSCallback
-soup_dns_lookup_resolve_async
-soup_dns_lookup_cancel
-soup_dns_lookup_get_hostname
-soup_dns_lookup_get_address
-soup_dns_lookup_free
-</SECTION>
-
-<SECTION>
-<FILE>soup-ssl</FILE>
-soup_ssl_supported
-<SUBSECTION>
-SoupSSLType
-SoupSSLCredentials
-soup_ssl_get_client_credentials
-soup_ssl_free_client_credentials
-soup_ssl_get_server_credentials
-soup_ssl_free_server_credentials
-soup_ssl_wrap_iochannel
-SOUP_SSL_ERROR
+<SUBSECTION Private>
soup_ssl_error_quark
-SoupSocketError
</SECTION>
<SECTION>
<FILE>soup-uri</FILE>
-<TITLE>SoupUri</TITLE>
-SoupUri
-SoupProtocol
-SOUP_PROTOCOL_HTTP
-SOUP_PROTOCOL_HTTPS
+<TITLE>SoupURI</TITLE>
+SoupURI
soup_uri_new_with_base
soup_uri_new
soup_uri_to_string
soup_uri_copy
-soup_uri_copy_root
soup_uri_equal
soup_uri_free
soup_uri_encode
soup_uri_decode
soup_uri_normalize
soup_uri_uses_default_port
-</SECTION>
-
-<SECTION>
-<FILE>soup-message-filter</FILE>
-<TITLE>SoupMessageFilter</TITLE>
-soup_message_filter_setup_message
-<SUBSECTION Standard>
-SOUP_IS_MESSAGE_FILTER
-SOUP_IS_MESSAGE_FILTER_CLASS
-SOUP_MESSAGE_FILTER
-SOUP_MESSAGE_FILTER_CLASS
-SOUP_MESSAGE_FILTER_GET_CLASS
-SOUP_MESSAGE_FILTER_GET_CLASS
-SOUP_TYPE_MESSAGE_FILTER
-SoupMessageFilterClass
-soup_message_filter_get_type
+soup_uri_is_https
+<SUBSECTION Standard>
+SOUP_TYPE_URI
+soup_uri_get_type
</SECTION>
<SECTION>
<FILE>soup-misc</FILE>
<TITLE>Soup Miscellaneous Utilities</TITLE>
-soup_base64_decode
-soup_base64_encode
-soup_base64_decode_step
-soup_base64_encode_step
-soup_base64_encode_close
+SoupDate
+SoupDateFormat
+soup_date_new
+soup_date_new_from_string
+soup_date_new_from_time_t
+soup_date_to_string
+soup_date_free
+<SUBSECTION>
+soup_form_decode_urlencoded
+soup_form_encode_urlencoded
+soup_form_encode_urlencoded_list
<SUBSECTION>
-soup_add_idle
-soup_add_io_watch
-soup_add_timeout
-soup_signal_connect_once
-<SUBSECTION>
-soup_date_parse
-soup_date_iso8601_parse
-soup_date_generate
-soup_gmtime
-soup_mktime_utc
-<SUBSECTION>
-soup_header_param_copy_token
-soup_header_param_decode_token
-soup_header_param_destroy_hash
-soup_header_param_parse_list
soup_headers_parse_request
soup_headers_parse_response
soup_headers_parse_status_line
<SUBSECTION>
+soup_header_parse_list
+soup_header_parse_quality_list
+soup_header_free_list
+soup_header_contains
+soup_header_parse_param_list
+soup_header_free_param_list
+<SUBSECTION>
soup_str_case_equal
soup_str_case_hash
<SUBSECTION>
+soup_add_idle
+soup_add_io_watch
+soup_add_timeout
+<SUBSECTION>
+soup_ssl_supported
+<SUBSECTION Private>
+soup_date_copy
+soup_signal_connect_once
soup_xml_real_node
</SECTION>
<SECTION>
-<FILE>soup-xmlrpc-message</FILE>
-<TITLE>SoupXmlrpcMessage</TITLE>
-SoupXmlrpcMessage
-soup_xmlrpc_message_new
-soup_xmlrpc_message_new_from_uri
-soup_xmlrpc_message_from_string
-<SUBSECTION>
-soup_xmlrpc_message_start_call
-soup_xmlrpc_message_end_call
-soup_xmlrpc_message_start_param
-soup_xmlrpc_message_end_param
-<SUBSECTION>
-soup_xmlrpc_message_write_int
-soup_xmlrpc_message_write_boolean
-soup_xmlrpc_message_write_string
-soup_xmlrpc_message_write_double
-soup_xmlrpc_message_write_datetime
-soup_xmlrpc_message_write_base64
-<SUBSECTION>
-soup_xmlrpc_message_start_struct
-soup_xmlrpc_message_end_struct
-soup_xmlrpc_message_start_member
-soup_xmlrpc_message_end_member
-<SUBSECTION>
-soup_xmlrpc_message_start_array
-soup_xmlrpc_message_end_array
-<SUBSECTION>
-soup_xmlrpc_message_to_string
-soup_xmlrpc_message_persist
-<SUBSECTION>
-soup_xmlrpc_message_parse_response
-<SUBSECTION Standard>
-SOUP_IS_XMLRPC_MESSAGE
-SOUP_IS_XMLRPC_MESSAGE_CLASS
-SOUP_TYPE_XMLRPC_MESSAGE
-SOUP_XMLRPC_MESSAGE
-SOUP_XMLRPC_MESSAGE_CLASS
-SOUP_XMLRPC_MESSAGE_GET_CLASS
-SoupXmlrpcMessageClass
-soup_xmlrpc_message_get_type
-</SECTION>
-
-<SECTION>
-<FILE>soup-xmlrpc-response</FILE>
-<TITLE>SoupXmlrpcResponse</TITLE>
-SoupXmlrpcResponse
-soup_xmlrpc_response_new
-soup_xmlrpc_response_new_from_string
-soup_xmlrpc_response_from_string
-soup_xmlrpc_response_to_string
-<SUBSECTION>
-SoupXmlrpcValue
-SoupXmlrpcValueType
-soup_xmlrpc_response_is_fault
-soup_xmlrpc_response_get_value
-<SUBSECTION>
-soup_xmlrpc_value_get_type
-soup_xmlrpc_value_get_int
-soup_xmlrpc_value_get_double
-soup_xmlrpc_value_get_boolean
-soup_xmlrpc_value_get_string
-soup_xmlrpc_value_get_datetime
-soup_xmlrpc_value_get_base64
-soup_xmlrpc_value_get_struct
-<SUBSECTION>
-SoupXmlrpcValueArrayIterator
-soup_xmlrpc_value_array_get_iterator
-soup_xmlrpc_value_array_iterator_prev
-soup_xmlrpc_value_array_iterator_next
-soup_xmlrpc_value_array_iterator_get_value
-<SUBSECTION>
-soup_xmlrpc_value_dump
-<SUBSECTION Standard>
-SOUP_IS_XMLRPC_RESPONSE
-SOUP_IS_XMLRPC_RESPONSE_CLASS
-SOUP_TYPE_XMLRPC_RESPONSE
-SOUP_XMLRPC_RESPONSE
-SOUP_XMLRPC_RESPONSE_CLASS
-SOUP_XMLRPC_RESPONSE_GET_CLASS
-SoupXmlrpcResponseClass
-soup_xmlrpc_response_get_type
+<FILE>soup-xmlrpc</FILE>
+<TITLE>XMLRPC Support</TITLE>
+<SUBSECTION>
+soup_xmlrpc_build_method_call
+soup_xmlrpc_request_new
+soup_xmlrpc_parse_method_response
+<SUBSECTION>
+soup_xmlrpc_parse_method_call
+soup_xmlrpc_extract_method_call
+soup_xmlrpc_build_method_response
+soup_xmlrpc_build_fault
+soup_xmlrpc_set_response
+soup_xmlrpc_set_fault
+<SUBSECTION>
+SOUP_XMLRPC_ERROR
+SoupXMLRPCError
+SOUP_XMLRPC_FAULT
+<SUBSECTION Private>
+soup_xmlrpc_error_quark
+soup_xmlrpc_fault_quark
+</SECTION>
+
+<SECTION>
+<FILE>soup-value-utils</FILE>
+<TITLE>GValue Support</TITLE>
+soup_value_hash_new
+soup_value_hash_insert_value
+soup_value_hash_insert
+soup_value_hash_lookup
+<SUBSECTION>
+soup_value_array_from_args
+soup_value_array_to_args
+soup_value_array_insert
+soup_value_array_append
+soup_value_array_get_nth
+<SUBSECTION>
+SOUP_VALUE_SETV
+SOUP_VALUE_GETV
+<SUBSECTION>
+SOUP_TYPE_BYTE_ARRAY
+<SUBSECTION Private>
+soup_byte_array_get_type
</SECTION>
Modified: branches/libsoup-2.4/docs/reference/libsoup.types
==============================================================================
--- branches/libsoup-2.4/docs/reference/libsoup.types (original)
+++ branches/libsoup-2.4/docs/reference/libsoup.types Sun Jan 6 15:52:42 2008
@@ -1,37 +1,14 @@
-#include <libsoup/soup-address.h>
-#include <libsoup/soup-auth.h>
-#include <libsoup/soup-auth-basic.h>
-#include <libsoup/soup-auth-digest.h>
-#include <libsoup/soup-connection.h>
-#include <libsoup/soup-connection-ntlm.h>
-#include <libsoup/soup-message.h>
-#include <libsoup/soup-message-filter.h>
-#include <libsoup/soup-server-message.h>
-#include <libsoup/soup-server.h>
-#include <libsoup/soup-session.h>
-#include <libsoup/soup-session-sync.h>
-#include <libsoup/soup-session-async.h>
-#include <libsoup/soup-soap-message.h>
-#include <libsoup/soup-soap-response.h>
-#include <libsoup/soup-socket.h>
-#include <libsoup/soup-xmlrpc-message.h>
-#include <libsoup/soup-xmlrpc-response.h>
+#include <libsoup/soup.h>
soup_address_get_type
soup_auth_get_type
-soup_auth_basic_get_type
-soup_auth_digest_get_type
-soup_connection_get_type
-soup_connection_ntlm_get_type
+soup_auth_domain_get_type
+soup_auth_domain_basic_get_type
+soup_auth_domain_digest_get_type
soup_message_get_type
-soup_message_filter_get_type
-soup_server_message_get_type
soup_server_get_type
soup_session_get_type
soup_session_sync_get_type
soup_session_async_get_type
-soup_soap_message_get_type
-soup_soap_response_get_type
soup_socket_get_type
-soup_xmlrpc_message_get_type
-soup_xmlrpc_response_get_type
+
Modified: branches/libsoup-2.4/docs/reference/tmpl/libsoup-unused.sgml
==============================================================================
--- branches/libsoup-2.4/docs/reference/tmpl/libsoup-unused.sgml (original)
+++ branches/libsoup-2.4/docs/reference/tmpl/libsoup-unused.sgml Sun Jan 6 15:52:42 2008
@@ -40,6 +40,81 @@
SoupAuthDigest
+<!-- ##### SECTION ./tmpl/soup-connection-ntlm.sgml:Long_Description ##### -->
+<para>
+#SoupSession automatically creates #SoupConnectionNTLM rather than
+#SoupConnection if you set the %SOUP_SESSION_USE_NTLM flag.
+</para>
+
+
+<!-- ##### SECTION ./tmpl/soup-connection-ntlm.sgml:See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/soup-connection-ntlm.sgml:Short_Description ##### -->
+NTLM-authenticated connection
+
+
+<!-- ##### SECTION ./tmpl/soup-connection-ntlm.sgml:Stability_Level ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/soup-connection-ntlm.sgml:Title ##### -->
+SoupConnectionNTLM
+
+
+<!-- ##### SECTION ./tmpl/soup-connection.sgml: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 ./tmpl/soup-connection.sgml:See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/soup-connection.sgml:Short_Description ##### -->
+a single possibly-persistent HTTP connection
+
+
+<!-- ##### SECTION ./tmpl/soup-connection.sgml:Stability_Level ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/soup-connection.sgml:Title ##### -->
+SoupConnection
+
+
+<!-- ##### SECTION ./tmpl/soup-dns.sgml:Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/soup-dns.sgml:See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/soup-dns.sgml:Short_Description ##### -->
+Low-level DNS routines
+
+
+<!-- ##### SECTION ./tmpl/soup-dns.sgml:Stability_Level ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/soup-dns.sgml:Title ##### -->
+soup-dns
+
+
<!-- ##### SECTION ./tmpl/soup-md5-utils.sgml:Long_Description ##### -->
<para>
@@ -84,6 +159,30 @@
Soup Miscellaneous Utilities
+<!-- ##### SECTION ./tmpl/soup-message-filter.sgml:Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/soup-message-filter.sgml:See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/soup-message-filter.sgml:Short_Description ##### -->
+Automatic message processing
+
+
+<!-- ##### SECTION ./tmpl/soup-message-filter.sgml:Stability_Level ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/soup-message-filter.sgml:Title ##### -->
+SoupMessageFilter
+
+
<!-- ##### SECTION ./tmpl/soup-message-private.sgml:Long_Description ##### -->
<para>
@@ -145,353 +244,2499 @@
soup-server-auth
-<!-- ##### ENUM SoupAuthType ##### -->
+<!-- ##### SECTION ./tmpl/soup-server-message.sgml:Long_Description ##### -->
<para>
</para>
- SOUP_AUTH_TYPE_BASIC:
- SOUP_AUTH_TYPE_DIGEST:
-<!-- ##### ENUM SoupDigestAlgorithm ##### -->
+<!-- ##### SECTION ./tmpl/soup-server-message.sgml:See_Also ##### -->
<para>
</para>
- SOUP_ALGORITHM_MD5:
- SOUP_ALGORITHM_MD5_SESS:
-<!-- ##### STRUCT SoupMD5Context ##### -->
-<para>
+<!-- ##### SECTION ./tmpl/soup-server-message.sgml:Short_Description ##### -->
+Server-side #SoupMessage
-</para>
+<!-- ##### SECTION ./tmpl/soup-server-message.sgml:Stability_Level ##### -->
-<!-- ##### USER_FUNCTION SoupMessageGetHeadersFn ##### -->
-<para>
-</para>
- msg:
- headers:
- encoding:
- user_data:
+<!-- ##### SECTION ./tmpl/soup-server-message.sgml:Title ##### -->
+SoupServerMessage
-<!-- ##### USER_FUNCTION SoupMessageParseHeadersFn ##### -->
+
+<!-- ##### SECTION ./tmpl/soup-soap-message.sgml:Long_Description ##### -->
<para>
</para>
- msg:
- headers:
- header_len:
- encoding:
- content_len:
- user_data:
- Returns:
-<!-- ##### TYPEDEF SoupMessageQueue ##### -->
+<!-- ##### SECTION ./tmpl/soup-soap-message.sgml:See_Also ##### -->
<para>
</para>
-<!-- ##### STRUCT SoupMessageQueueIter ##### -->
-<para>
+<!-- ##### SECTION ./tmpl/soup-soap-message.sgml:Short_Description ##### -->
+A SOAP request
-</para>
+<!-- ##### SECTION ./tmpl/soup-soap-message.sgml:Stability_Level ##### -->
-<!-- ##### STRUCT SoupServerAuthBasic ##### -->
-<para>
-</para>
- type:
- user:
- passwd:
+<!-- ##### SECTION ./tmpl/soup-soap-message.sgml:Title ##### -->
+SoupSoapMessage
-<!-- ##### USER_FUNCTION SoupServerAuthCallbackFn ##### -->
+
+<!-- ##### SECTION ./tmpl/soup-soap-response.sgml:Long_Description ##### -->
<para>
</para>
- auth_ctx:
- auth:
- msg:
- data:
- Returns:
-<!-- ##### STRUCT SoupServerAuthContext ##### -->
+<!-- ##### SECTION ./tmpl/soup-soap-response.sgml:See_Also ##### -->
<para>
</para>
- types:
- callback:
- user_data:
-<!-- ##### STRUCT SoupServerAuthDigest ##### -->
-<para>
+<!-- ##### SECTION ./tmpl/soup-soap-response.sgml:Short_Description ##### -->
+A SOAP response
-</para>
- type:
- algorithm:
- integrity:
- realm:
- user:
- nonce:
- nonce_count:
- cnonce:
- digest_uri:
- digest_response:
- request_method:
+<!-- ##### SECTION ./tmpl/soup-soap-response.sgml:Stability_Level ##### -->
-<!-- ##### FUNCTION soup_md5_final ##### -->
-<para>
-</para>
- ctx:
- digest:
+<!-- ##### SECTION ./tmpl/soup-soap-response.sgml:Title ##### -->
+SoupSoapResponse
-<!-- ##### FUNCTION soup_md5_final_hex ##### -->
+
+<!-- ##### SECTION ./tmpl/soup-ssl.sgml:Long_Description ##### -->
<para>
</para>
- ctx:
- digest:
-<!-- ##### FUNCTION soup_md5_init ##### -->
+<!-- ##### SECTION ./tmpl/soup-ssl.sgml:See_Also ##### -->
<para>
</para>
- ctx:
-<!-- ##### FUNCTION soup_md5_update ##### -->
-<para>
+<!-- ##### SECTION ./tmpl/soup-ssl.sgml:Short_Description ##### -->
+SSL/TLS handling
-</para>
- ctx:
- buf:
- len:
+<!-- ##### SECTION ./tmpl/soup-ssl.sgml:Stability_Level ##### -->
-<!-- ##### FUNCTION soup_message_cleanup_response ##### -->
+
+
+<!-- ##### SECTION ./tmpl/soup-ssl.sgml:Title ##### -->
+soup-ssl
+
+
+<!-- ##### SECTION ./tmpl/soup-xmlrpc-message.sgml:Long_Description ##### -->
<para>
</para>
- req:
-<!-- ##### FUNCTION soup_message_finished ##### -->
+<!-- ##### SECTION ./tmpl/soup-xmlrpc-message.sgml:See_Also ##### -->
<para>
</para>
- msg:
-<!-- ##### FUNCTION soup_message_got_body ##### -->
+<!-- ##### SECTION ./tmpl/soup-xmlrpc-message.sgml:Short_Description ##### -->
+An XML-RPC Message
+
+
+<!-- ##### SECTION ./tmpl/soup-xmlrpc-message.sgml:Stability_Level ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/soup-xmlrpc-message.sgml:Title ##### -->
+SoupXmlrpcMessage
+
+
+<!-- ##### SECTION ./tmpl/soup-xmlrpc-response.sgml:Long_Description ##### -->
<para>
</para>
- msg:
-<!-- ##### FUNCTION soup_message_got_chunk ##### -->
+<!-- ##### SECTION ./tmpl/soup-xmlrpc-response.sgml:See_Also ##### -->
<para>
</para>
- msg:
-<!-- ##### FUNCTION soup_message_got_headers ##### -->
+<!-- ##### SECTION ./tmpl/soup-xmlrpc-response.sgml:Short_Description ##### -->
+An XML-RPC response
+
+
+<!-- ##### SECTION ./tmpl/soup-xmlrpc-response.sgml:Stability_Level ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/soup-xmlrpc-response.sgml:Title ##### -->
+SoupXmlrpcResponse
+
+
+<!-- ##### MACRO SOUP_CONNECTION_ASYNC_CONTEXT ##### -->
<para>
+An alias for the "async-context" property.
+</para>
+
+<!-- ##### MACRO SOUP_CONNECTION_MESSAGE_FILTER ##### -->
+<para>
+An alias for the "message-filter" property.
</para>
- msg:
-<!-- ##### FUNCTION soup_message_got_informational ##### -->
+<!-- ##### 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>
- msg:
-<!-- ##### FUNCTION soup_message_io_client ##### -->
+<!-- ##### MACRO SOUP_CONNECTION_SSL_CREDENTIALS ##### -->
<para>
+An alias for the "ssl-creds" property.
+</para>
+
+<!-- ##### MACRO SOUP_CONNECTION_TIMEOUT ##### -->
+<para>
+An alias for the "timeout" property.
</para>
- msg:
- sock:
- get_headers_cb:
- parse_headers_cb:
- user_data:
-<!-- ##### FUNCTION soup_message_io_server ##### -->
+<!-- ##### MACRO SOUP_MESSAGE_IS_STARTING ##### -->
+
<para>
</para>
@msg:
- sock:
- get_headers_cb:
- parse_headers_cb:
- user_data:
+ Returns:
-<!-- ##### FUNCTION soup_message_queue_append ##### -->
+<!-- ##### MACRO SOUP_PROTOCOL_HTTP ##### -->
<para>
</para>
- queue:
- msg:
-<!-- ##### FUNCTION soup_message_queue_destroy ##### -->
+<!-- ##### MACRO SOUP_PROTOCOL_HTTPS ##### -->
<para>
</para>
- queue:
-<!-- ##### FUNCTION soup_message_queue_first ##### -->
+<!-- ##### MACRO SOUP_SOCKET_FLAG_CLOEXEC ##### -->
<para>
-
+An alias for the "cloexec" property.
</para>
- queue:
- iter:
- Returns:
-<!-- ##### FUNCTION soup_message_queue_free_iter ##### -->
+<!-- ##### 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>
- queue:
- iter:
-<!-- ##### FUNCTION soup_message_queue_new ##### -->
+<!-- ##### STRUCT SoupAuthBasic ##### -->
<para>
+An object representing Basic HTTP authentication.
+</para>
+
+ parent:
+<!-- ##### STRUCT SoupAuthDigest ##### -->
+<para>
+An object representing Digest HTTP authentication.
</para>
- Returns:
+ parent:
-<!-- ##### FUNCTION soup_message_queue_next ##### -->
+<!-- ##### ENUM SoupAuthType ##### -->
<para>
</para>
- queue:
- iter:
- Returns:
+ SOUP_AUTH_TYPE_BASIC:
+ SOUP_AUTH_TYPE_DIGEST:
-<!-- ##### FUNCTION soup_message_queue_remove ##### -->
+<!-- ##### STRUCT SoupConnection ##### -->
<para>
</para>
- queue:
- iter:
- Returns:
+ parent:
-<!-- ##### FUNCTION soup_message_queue_remove_message ##### -->
+<!-- ##### SIGNAL SoupConnection::authenticate ##### -->
<para>
</para>
- queue:
+ conn:
@msg:
+ auth_type:
+ auth_realm:
+ username:
+ password:
-<!-- ##### FUNCTION soup_message_restarted ##### -->
+<!-- ##### SIGNAL SoupConnection::connect-result ##### -->
<para>
</para>
- msg:
+ conn:
+ status:
-<!-- ##### FUNCTION soup_message_run_handlers ##### -->
+<!-- ##### SIGNAL SoupConnection::disconnected ##### -->
<para>
</para>
- msg:
- phase:
+ conn:
-<!-- ##### FUNCTION soup_message_wrote_body ##### -->
+<!-- ##### SIGNAL SoupConnection::reauthenticate ##### -->
<para>
</para>
+ conn:
@msg:
+ auth_type:
+ auth_realm:
+ username:
+ password:
-<!-- ##### FUNCTION soup_message_wrote_chunk ##### -->
+<!-- ##### ARG SoupConnection:async-context ##### -->
<para>
</para>
- msg:
-<!-- ##### FUNCTION soup_message_wrote_headers ##### -->
+<!-- ##### ARG SoupConnection:message-filter ##### -->
<para>
</para>
- msg:
-<!-- ##### FUNCTION soup_message_wrote_informational ##### -->
+<!-- ##### ARG SoupConnection:origin-uri ##### -->
<para>
</para>
- msg:
-<!-- ##### FUNCTION soup_server_auth_check_passwd ##### -->
+<!-- ##### ARG SoupConnection:proxy-uri ##### -->
<para>
</para>
- auth:
- passwd:
- Returns:
-<!-- ##### FUNCTION soup_server_auth_context_challenge ##### -->
+<!-- ##### ARG SoupConnection:ssl-creds ##### -->
<para>
</para>
- auth_ctx:
- msg:
- header_name:
-<!-- ##### FUNCTION soup_server_auth_free ##### -->
+<!-- ##### ARG SoupConnection:timeout ##### -->
<para>
</para>
- auth:
-<!-- ##### FUNCTION soup_server_auth_get_user ##### -->
+<!-- ##### USER_FUNCTION SoupConnectionCallback ##### -->
<para>
</para>
- auth:
- Returns:
+ conn:
+ status:
+ data:
-<!-- ##### FUNCTION soup_server_auth_new ##### -->
+<!-- ##### STRUCT SoupConnectionNTLM ##### -->
+<para>
+
+</para>
+
+ parent:
+
+<!-- ##### USER_FUNCTION SoupDNSCallback ##### -->
+<para>
+
+</para>
+
+ lookup:
+ success:
+ user_data:
+
+<!-- ##### TYPEDEF SoupDNSLookup ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### STRUCT SoupDataBuffer ##### -->
+<para>
+
+</para>
+
+ owner:
+ body:
+ length:
+
+<!-- ##### ENUM SoupDigestAlgorithm ##### -->
+<para>
+
+</para>
+
+ SOUP_ALGORITHM_MD5:
+ SOUP_ALGORITHM_MD5_SESS:
+
+<!-- ##### ENUM SoupHandlerPhase ##### -->
+<para>
+
+</para>
+
+ SOUP_HANDLER_POST_REQUEST:
+ SOUP_HANDLER_PRE_BODY:
+ SOUP_HANDLER_BODY_CHUNK:
+ SOUP_HANDLER_POST_BODY:
+
+<!-- ##### ENUM SoupHttpVersion ##### -->
+<para>
+
+</para>
+
+ SOUP_HTTP_1_0:
+ SOUP_HTTP_1_1:
+
+<!-- ##### STRUCT SoupMD5Context ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### USER_FUNCTION SoupMessageCallbackFn ##### -->
+<para>
+
+</para>
+
+ req:
+ user_data:
+
+<!-- ##### USER_FUNCTION SoupMessageGetHeadersFn ##### -->
+<para>
+
+</para>
+
+ msg:
+ headers:
+ encoding:
+ user_data:
+
+<!-- ##### USER_FUNCTION SoupMessageParseHeadersFn ##### -->
+<para>
+
+</para>
+
+ msg:
+ headers:
+ header_len:
+ encoding:
+ content_len:
+ user_data:
+ Returns:
+
+<!-- ##### TYPEDEF SoupMessageQueue ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### STRUCT SoupMessageQueueIter ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ENUM SoupMessageStatus ##### -->
+<para>
+
+</para>
+
+ SOUP_MESSAGE_STATUS_IDLE:
+ SOUP_MESSAGE_STATUS_QUEUED:
+ SOUP_MESSAGE_STATUS_CONNECTING:
+ SOUP_MESSAGE_STATUS_RUNNING:
+ SOUP_MESSAGE_STATUS_FINISHED:
+
+<!-- ##### ENUM SoupOwnership ##### -->
+<para>
+
+</para>
+
+ SOUP_BUFFER_SYSTEM_OWNED:
+ SOUP_BUFFER_USER_OWNED:
+ SOUP_BUFFER_STATIC:
+
+<!-- ##### TYPEDEF SoupProtocol ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### TYPEDEF SoupSSLCredentials ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ENUM SoupSSLType ##### -->
+<para>
+
+</para>
+
+ SOUP_SSL_TYPE_CLIENT:
+ SOUP_SSL_TYPE_SERVER:
+
+<!-- ##### STRUCT SoupServerAuthBasic ##### -->
+<para>
+
+</para>
+
+ type:
+ user:
+ passwd:
+
+<!-- ##### USER_FUNCTION SoupServerAuthCallbackFn ##### -->
<para>
</para>
@auth_ctx:
- auth_hdrs:
+ auth:
+ msg:
+ data:
+ Returns:
+
+<!-- ##### STRUCT SoupServerAuthContext ##### -->
+<para>
+
+</para>
+
+ types:
+ callback:
+ user_data:
+
+<!-- ##### STRUCT SoupServerAuthDigest ##### -->
+<para>
+
+</para>
+
+ type:
+ algorithm:
+ integrity:
+ realm:
+ user:
+ nonce:
+ nonce_count:
+ cnonce:
+ digest_uri:
+ digest_response:
+ request_method:
+
+<!-- ##### USER_FUNCTION SoupServerCallbackFn ##### -->
+<para>
+
+</para>
+
+ context:
+ msg:
+ user_data:
+
+<!-- ##### STRUCT SoupServerContext ##### -->
+<para>
+
+</para>
+
+ msg:
+ path:
+ method_id:
+ auth:
+ server:
+ handler:
+ sock:
+
+<!-- ##### TYPEDEF SoupServerHandler ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### STRUCT SoupServerMessage ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### USER_FUNCTION SoupServerUnregisterFn ##### -->
+<para>
+
+</para>
+
+ server:
+ handler:
+ user_data:
+
+<!-- ##### SIGNAL SoupSession::reauthenticate ##### -->
+<para>
+
+</para>
+
+ session:
@msg:
+ auth_type:
+ auth_realm:
+ username:
+ password:
+
+<!-- ##### STRUCT SoupSoapMessage ##### -->
+<para>
+
+</para>
+
+ parent:
+
+<!-- ##### TYPEDEF SoupSoapParameter ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### STRUCT SoupSoapResponse ##### -->
+<para>
+
+</para>
+
+ parent:
+
+<!-- ##### SIGNAL SoupSocket::connect-result ##### -->
+<para>
+
+</para>
+
+ sock:
+ status:
+
+<!-- ##### ARG SoupSocket:cloexec ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ARG SoupSocket:nodelay ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ARG SoupSocket:reuseaddr ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ENUM SoupSocketError ##### -->
+<para>
+
+</para>
+
+ SOUP_SSL_ERROR_HANDSHAKE_NEEDS_READ:
+ SOUP_SSL_ERROR_HANDSHAKE_NEEDS_WRITE:
+ SOUP_SSL_ERROR_CERTIFICATE:
+
+<!-- ##### USER_FUNCTION SoupSocketListenerCallback ##### -->
+<para>
+
+</para>
+
+ listener:
+ sock:
+ user_data:
+
+<!-- ##### ENUM SoupStatusClass ##### -->
+<para>
+
+</para>
+
+ 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:
+
+<!-- ##### ENUM SoupTransferEncoding ##### -->
+<para>
+
+</para>
+
+ SOUP_TRANSFER_UNKNOWN:
+ SOUP_TRANSFER_CHUNKED:
+ SOUP_TRANSFER_CONTENT_LENGTH:
+ SOUP_TRANSFER_BYTERANGES:
+ SOUP_TRANSFER_NONE:
+ SOUP_TRANSFER_EOF:
+
+<!-- ##### STRUCT SoupUri ##### -->
+<para>
+Note that the <structfield>user</structfield> and
+<structfield>passwd</structfield> fields are <emphasis>not</emphasis>
+the standard mechanism for authentication in
+<application>libsoup</application>. Client-side authentication should
+normally use the <type>SoupSession</type> <link
+linkend="SoupSession-authenticate">authenticate</link> signal
+(although the <type>SoupUri</type> fields are also supported).
+Server-side authentication uses <type>SoupServer</type>'s
+authentication mechanisms and never makes use of the
+<type>SoupUri</type> fields.
+</para>
+
+<para>
+The <structfield>path</structfield> field is never empty or %NULL; if
+a stringified URI is given with no path, the <type>SoupUri</type> form
+has <literal>"/"</literal> as its path. Likewise,
+<structfield>port</structfield> is always filled in, even if it wasn't
+filled in in the stringified URI.
+</para>
+
+<para>
+The <structfield>path</structfield>, <structfield>query</structfield>,
+and <structfield>fragment</structfield> fields may have
+<literal>%</literal>-encoded characters in them; this is because only
+the server that the URI belongs to can say for sure whether
+<literal>"%%2F"</literal> means the same thing as
+<literal>"/"</literal>, or something different. Servers can use
+soup_uri_normalize() to decode characters from the "reserved" set that
+they are not using for reserved purposes.
+</para>
+
+ protocol: the URI's protocol, either %SOUP_PROTOCOL_HTTP or %SOUP_PROTOCOL_HTTPS
+ user: the username, or %NULL
+ passwd: the password, or %NULL
+ host: the hostname
+ port: the port
+ path: the path, possibly "%%-encoded"
+ query: the query string, possibly "%%-encoded", or %NULL
+ fragment: the fragment identifier, possibly "%%-encoded", or %NULL
+
+<!-- ##### STRUCT SoupXmlrpcMessage ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### STRUCT SoupXmlrpcResponse ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### TYPEDEF SoupXmlrpcValue ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### TYPEDEF SoupXmlrpcValueArrayIterator ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ENUM SoupXmlrpcValueType ##### -->
+<para>
+
+</para>
+
+ SOUP_XMLRPC_VALUE_TYPE_BAD:
+ SOUP_XMLRPC_VALUE_TYPE_INT:
+ SOUP_XMLRPC_VALUE_TYPE_BOOLEAN:
+ SOUP_XMLRPC_VALUE_TYPE_STRING:
+ SOUP_XMLRPC_VALUE_TYPE_DOUBLE:
+ SOUP_XMLRPC_VALUE_TYPE_DATETIME:
+ SOUP_XMLRPC_VALUE_TYPE_BASE64:
+ SOUP_XMLRPC_VALUE_TYPE_STRUCT:
+ SOUP_XMLRPC_VALUE_TYPE_ARRAY:
+
+<!-- ##### FUNCTION soup_address_resolve_async_full ##### -->
+<para>
+
+</para>
+
+ addr:
+ async_context:
+ callback:
+ user_data:
+
+<!-- ##### FUNCTION soup_auth_new_from_header_list ##### -->
+<para>
+
+</para>
+
+ vals:
+ Returns:
+
+<!-- ##### FUNCTION soup_base64_decode ##### -->
+<para>
+
+</para>
+
+ text:
+ out_len:
+ Returns:
+
+<!-- ##### FUNCTION soup_base64_decode_step ##### -->
+<para>
+
+</para>
+
+ in:
+ len:
+ out:
+ state:
+ save:
+ Returns:
+
+<!-- ##### FUNCTION soup_base64_encode ##### -->
+<para>
+
+</para>
+
+ text:
+ len:
+ Returns:
+
+<!-- ##### FUNCTION soup_base64_encode_close ##### -->
+<para>
+
+</para>
+
+ in:
+ inlen:
+ break_lines:
+ out:
+ state:
+ save:
+ Returns:
+
+<!-- ##### FUNCTION soup_base64_encode_step ##### -->
+<para>
+
+</para>
+
+ in:
+ len:
+ break_lines:
+ out:
+ state:
+ save:
+ Returns:
+
+<!-- ##### FUNCTION soup_connection_authenticate ##### -->
+<para>
+
+</para>
+
+ conn:
+ msg:
+ auth:
+ retrying:
+
+<!-- ##### FUNCTION soup_connection_connect_async ##### -->
+<para>
+
+</para>
+
+ conn:
+ callback:
+ user_data:
+
+<!-- ##### FUNCTION soup_connection_connect_sync ##### -->
+<para>
+
+</para>
+
+ conn:
+ Returns:
+
+<!-- ##### FUNCTION soup_connection_disconnect ##### -->
+<para>
+
+</para>
+
+ conn:
+
+<!-- ##### FUNCTION soup_connection_is_in_use ##### -->
+<para>
+
+</para>
+
+ conn:
+ Returns:
+
+<!-- ##### FUNCTION soup_connection_last_used ##### -->
+<para>
+
+</para>
+
+ conn:
+ Returns:
+
+<!-- ##### FUNCTION soup_connection_new ##### -->
+<para>
+
+</para>
+
+ propname1:
+ Varargs:
+ Returns:
+
+<!-- ##### FUNCTION soup_connection_reauthenticate ##### -->
+<para>
+
+</para>
+
+ conn:
+ msg:
+ auth_type:
+ auth_realm:
+ username:
+ password:
+
+<!-- ##### FUNCTION soup_connection_release ##### -->
+<para>
+
+</para>
+
+ conn:
+
+<!-- ##### FUNCTION soup_connection_reserve ##### -->
+<para>
+
+</para>
+
+ conn:
+
+<!-- ##### FUNCTION soup_connection_send_request ##### -->
+<para>
+
+</para>
+
+ conn:
+ req:
+
+<!-- ##### FUNCTION soup_date_generate ##### -->
+<para>
+
+</para>
+
+ when:
+ Returns:
+
+<!-- ##### FUNCTION soup_date_iso8601_parse ##### -->
+<para>
+
+</para>
+
+ timestamp:
+ Returns:
+
+<!-- ##### FUNCTION soup_date_parse ##### -->
+<para>
+
+</para>
+
+ timestamp:
+ Returns:
+
+<!-- ##### FUNCTION soup_dns_init ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION soup_dns_lookup_address ##### -->
+<para>
+
+</para>
+
+ sockaddr:
+ Returns:
+
+<!-- ##### FUNCTION soup_dns_lookup_cancel ##### -->
+<para>
+
+</para>
+
+ lookup:
+
+<!-- ##### FUNCTION soup_dns_lookup_free ##### -->
+<para>
+
+</para>
+
+ lookup:
+
+<!-- ##### FUNCTION soup_dns_lookup_get_address ##### -->
+<para>
+
+</para>
+
+ lookup:
+ Returns:
+
+<!-- ##### FUNCTION soup_dns_lookup_get_hostname ##### -->
+<para>
+
+</para>
+
+ lookup:
+ Returns:
+
+<!-- ##### FUNCTION soup_dns_lookup_name ##### -->
+<para>
+
+</para>
+
+ name:
+ Returns:
+
+<!-- ##### FUNCTION soup_dns_lookup_resolve ##### -->
+<para>
+
+</para>
+
+ lookup:
+ Returns:
+
+<!-- ##### FUNCTION soup_dns_lookup_resolve_async ##### -->
+<para>
+
+</para>
+
+ lookup:
+ async_context:
+ callback:
+ user_data:
+
+<!-- ##### FUNCTION soup_dns_ntop ##### -->
+<para>
+
+</para>
+
+ sa:
+ Returns:
+
+<!-- ##### FUNCTION soup_gmtime ##### -->
+<para>
+
+</para>
+
+ when:
+ tm:
+
+<!-- ##### FUNCTION soup_header_param_copy_token ##### -->
+<para>
+
+</para>
+
+ tokens:
+ t:
+ Returns:
+
+<!-- ##### FUNCTION soup_header_param_decode_token ##### -->
+<para>
+
+</para>
+
+ in:
+ Returns:
+
+<!-- ##### FUNCTION soup_header_param_destroy_hash ##### -->
+<para>
+
+</para>
+
+ table:
+
+<!-- ##### FUNCTION soup_header_param_parse_list ##### -->
+<para>
+
+</para>
+
+ header:
+ Returns:
+
+<!-- ##### FUNCTION soup_md5_final ##### -->
+<para>
+
+</para>
+
+ ctx:
+ digest:
+
+<!-- ##### FUNCTION soup_md5_final_hex ##### -->
+<para>
+
+</para>
+
+ ctx:
+ digest:
+
+<!-- ##### FUNCTION soup_md5_init ##### -->
+<para>
+
+</para>
+
+ ctx:
+
+<!-- ##### FUNCTION soup_md5_update ##### -->
+<para>
+
+</para>
+
+ ctx:
+ buf:
+ len:
+
+<!-- ##### FUNCTION soup_message_add_chunk ##### -->
+<para>
+
+</para>
+
+ msg:
+ owner:
+ body:
+ length:
+
+<!-- ##### FUNCTION soup_message_add_final_chunk ##### -->
+<para>
+
+</para>
+
+ msg:
+
+<!-- ##### FUNCTION soup_message_add_handler ##### -->
+<para>
+
+</para>
+
+ msg:
+ phase:
+ handler_cb:
+ user_data:
+
+<!-- ##### FUNCTION soup_message_add_header ##### -->
+<para>
+
+</para>
+
+ hash:
+ name:
+ value:
+
+<!-- ##### FUNCTION soup_message_add_status_class_handler ##### -->
+<para>
+
+</para>
+
+ msg:
+ status_class:
+ phase:
+ handler_cb:
+ user_data:
+
+<!-- ##### FUNCTION soup_message_cleanup_response ##### -->
+<para>
+
+</para>
+
+ req:
+
+<!-- ##### FUNCTION soup_message_clear_headers ##### -->
+<para>
+
+</para>
+
+ hash:
+
+<!-- ##### FUNCTION soup_message_filter_setup_message ##### -->
+<para>
+
+</para>
+
+ filter:
+ msg:
+
+<!-- ##### FUNCTION soup_message_finished ##### -->
+<para>
+
+</para>
+
+ msg:
+
+<!-- ##### FUNCTION soup_message_foreach_header ##### -->
+<para>
+
+</para>
+
+ hash:
+ func:
+ user_data:
+
+<!-- ##### FUNCTION soup_message_get_header ##### -->
+<para>
+
+</para>
+
+ hash:
+ name:
+ Returns:
+
+<!-- ##### FUNCTION soup_message_get_header_list ##### -->
+<para>
+
+</para>
+
+ hash:
+ name:
+ Returns:
+
+<!-- ##### FUNCTION soup_message_get_request_encoding ##### -->
+<para>
+
+</para>
+
+ msg:
+ content_length:
+ Returns:
+
+<!-- ##### FUNCTION soup_message_get_response_encoding ##### -->
+<para>
+
+</para>
+
+ msg:
+ content_length:
+ Returns:
+
+<!-- ##### 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_message_io_client ##### -->
+<para>
+
+</para>
+
+ msg:
+ sock:
+ get_headers_cb:
+ parse_headers_cb:
+ user_data:
+
+<!-- ##### FUNCTION soup_message_io_pause ##### -->
+<para>
+
+</para>
+
+ msg:
+
+<!-- ##### FUNCTION soup_message_io_server ##### -->
+<para>
+
+</para>
+
+ msg:
+ sock:
+ get_headers_cb:
+ parse_headers_cb:
+ user_data:
+
+<!-- ##### FUNCTION soup_message_io_stop ##### -->
+<para>
+
+</para>
+
+ msg:
+
+<!-- ##### FUNCTION soup_message_io_unpause ##### -->
+<para>
+
+</para>
+
+ msg:
+
+<!-- ##### FUNCTION soup_message_pop_chunk ##### -->
+<para>
+
+</para>
+
+ msg:
+ Returns:
+
+<!-- ##### 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_read_request ##### -->
+<para>
+
+</para>
+
+ req:
+ sock:
+
+<!-- ##### FUNCTION soup_message_remove_handler ##### -->
+<para>
+
+</para>
+
+ msg:
+ phase:
+ handler_cb:
+ user_data:
+
+<!-- ##### FUNCTION soup_message_remove_header ##### -->
+<para>
+
+</para>
+
+ hash:
+ name:
+
+<!-- ##### FUNCTION soup_message_restarted ##### -->
+<para>
+
+</para>
+
+ msg:
+
+<!-- ##### FUNCTION soup_message_run_handlers ##### -->
+<para>
+
+</para>
+
+ msg:
+ phase:
+
+<!-- ##### FUNCTION soup_message_send_request ##### -->
+<para>
+
+</para>
+
+ req:
+ sock:
+ conn:
+ via_proxy:
+
+<!-- ##### 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_mktime_utc ##### -->
+<para>
+
+</para>
+
+ tm:
+ Returns:
+
+<!-- ##### 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_server_context_get_client_address ##### -->
+<para>
+
+</para>
+
+ ctx:
+ Returns:
+
+<!-- ##### FUNCTION soup_server_context_get_client_host ##### -->
+<para>
+
+</para>
+
+ ctx:
+ Returns:
+
+<!-- ##### FUNCTION soup_server_get_handler ##### -->
+<para>
+
+</para>
+
+ serv:
+ path:
+ Returns:
+
+<!-- ##### FUNCTION soup_server_get_protocol ##### -->
+<para>
+
+</para>
+
+ serv:
+ Returns:
+
+<!-- ##### FUNCTION soup_server_list_handlers ##### -->
+<para>
+
+</para>
+
+ serv:
+ Returns:
+
+<!-- ##### FUNCTION soup_server_message_finish ##### -->
+<para>
+
+</para>
+
+ smsg:
+
+<!-- ##### FUNCTION soup_server_message_get_encoding ##### -->
+<para>
+
+</para>
+
+ smsg:
+ Returns:
+
+<!-- ##### FUNCTION soup_server_message_get_server ##### -->
+<para>
+
+</para>
+
+ smsg:
+ Returns:
+
+<!-- ##### FUNCTION soup_server_message_is_finished ##### -->
+<para>
+
+</para>
+
+ smsg:
+ Returns:
+
+<!-- ##### FUNCTION soup_server_message_is_started ##### -->
+<para>
+
+</para>
+
+ smsg:
+ Returns:
+
+<!-- ##### FUNCTION soup_server_message_new ##### -->
+<para>
+
+</para>
+
+ server:
+ Returns:
+
+<!-- ##### FUNCTION soup_server_message_set_encoding ##### -->
+<para>
+
+</para>
+
+ smsg:
+ encoding:
+
+<!-- ##### FUNCTION soup_server_message_start ##### -->
+<para>
+
+</para>
+
+ smsg:
+
+<!-- ##### FUNCTION soup_session_add_filter ##### -->
+<para>
+
+</para>
+
+ session:
+ filter:
+
+<!-- ##### 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:
+
+<!-- ##### FUNCTION soup_signal_connect_once ##### -->
+<para>
+
+</para>
+
+ instance:
+ detailed_signal:
+ c_handler:
+ data:
+ Returns:
+
+<!-- ##### FUNCTION soup_soap_message_add_attribute ##### -->
+<para>
+
+</para>
+
+ msg:
+ name:
+ value:
+ prefix:
+ ns_uri:
+
+<!-- ##### FUNCTION soup_soap_message_add_namespace ##### -->
+<para>
+
+</para>
+
+ msg:
+ prefix:
+ ns_uri:
+
+<!-- ##### FUNCTION soup_soap_message_end_body ##### -->
+<para>
+
+</para>
+
+ msg:
+
+<!-- ##### FUNCTION soup_soap_message_end_element ##### -->
+<para>
+
+</para>
+
+ msg:
+
+<!-- ##### FUNCTION soup_soap_message_end_envelope ##### -->
+<para>
+
+</para>
+
+ msg:
+
+<!-- ##### FUNCTION soup_soap_message_end_fault ##### -->
+<para>
+
+</para>
+
+ msg:
+
+<!-- ##### FUNCTION soup_soap_message_end_fault_detail ##### -->
+<para>
+
+</para>
+
+ msg:
+
+<!-- ##### FUNCTION soup_soap_message_end_header ##### -->
+<para>
+
+</para>
+
+ msg:
+
+<!-- ##### FUNCTION soup_soap_message_end_header_element ##### -->
+<para>
+
+</para>
+
+ msg:
+
+<!-- ##### FUNCTION soup_soap_message_get_namespace_prefix ##### -->
+<para>
+
+</para>
+
+ msg:
+ ns_uri:
+ Returns:
+
+<!-- ##### FUNCTION soup_soap_message_get_xml_doc ##### -->
+<para>
+
+</para>
+
+ msg:
+ Returns:
+
+<!-- ##### FUNCTION soup_soap_message_new ##### -->
+<para>
+
+</para>
+
+ method:
+ uri_string:
+ standalone:
+ xml_encoding:
+ env_prefix:
+ env_uri:
+ Returns:
+
+<!-- ##### FUNCTION soup_soap_message_new_from_uri ##### -->
+<para>
+
+</para>
+
+ method:
+ uri:
+ standalone:
+ xml_encoding:
+ env_prefix:
+ env_uri:
+ Returns:
+
+<!-- ##### FUNCTION soup_soap_message_parse_response ##### -->
+<para>
+
+</para>
+
+ msg:
+ Returns:
+
+<!-- ##### FUNCTION soup_soap_message_persist ##### -->
+<para>
+
+</para>
+
+ msg:
+
+<!-- ##### FUNCTION soup_soap_message_reset ##### -->
+<para>
+
+</para>
+
+ msg:
+
+<!-- ##### FUNCTION soup_soap_message_set_default_namespace ##### -->
+<para>
+
+</para>
+
+ msg:
+ ns_uri:
+
+<!-- ##### FUNCTION soup_soap_message_set_element_type ##### -->
+<para>
+
+</para>
+
+ msg:
+ xsi_type:
+
+<!-- ##### FUNCTION soup_soap_message_set_encoding_style ##### -->
+<para>
+
+</para>
+
+ msg:
+ enc_style:
+
+<!-- ##### FUNCTION soup_soap_message_set_null ##### -->
+<para>
+
+</para>
+
+ msg:
+
+<!-- ##### FUNCTION soup_soap_message_start_body ##### -->
+<para>
+
+</para>
+
+ msg:
+
+<!-- ##### FUNCTION soup_soap_message_start_element ##### -->
+<para>
+
+</para>
+
+ msg:
+ name:
+ prefix:
+ ns_uri:
+
+<!-- ##### FUNCTION soup_soap_message_start_envelope ##### -->
+<para>
+
+</para>
+
+ msg:
+
+<!-- ##### FUNCTION soup_soap_message_start_fault ##### -->
+<para>
+
+</para>
+
+ msg:
+ faultcode:
+ faultstring:
+ faultfactor:
+
+<!-- ##### FUNCTION soup_soap_message_start_fault_detail ##### -->
+<para>
+
+</para>
+
+ msg:
+
+<!-- ##### FUNCTION soup_soap_message_start_header ##### -->
+<para>
+
+</para>
+
+ msg:
+
+<!-- ##### FUNCTION soup_soap_message_start_header_element ##### -->
+<para>
+
+</para>
+
+ msg:
+ name:
+ must_understand:
+ actor_uri:
+ prefix:
+ ns_uri:
+
+<!-- ##### FUNCTION soup_soap_message_write_base64 ##### -->
+<para>
+
+</para>
+
+ msg:
+ string:
+ len:
+
+<!-- ##### FUNCTION soup_soap_message_write_buffer ##### -->
+<para>
+
+</para>
+
+ msg:
+ buffer:
+ len:
+
+<!-- ##### FUNCTION soup_soap_message_write_double ##### -->
+<para>
+
+</para>
+
+ msg:
+ d:
+
+<!-- ##### FUNCTION soup_soap_message_write_int ##### -->
+<para>
+
+</para>
+
+ msg:
+ i:
+
+<!-- ##### FUNCTION soup_soap_message_write_string ##### -->
+<para>
+
+</para>
+
+ msg:
+ string:
+
+<!-- ##### FUNCTION soup_soap_message_write_time ##### -->
+<para>
+
+</para>
+
+ msg:
+ timeval:
+
+<!-- ##### 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:
+
+<!-- ##### 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_socket_client_new_async ##### -->
+<para>
+
+</para>
+
+ hostname:
+ port:
+ ssl_creds:
+ callback:
+ user_data:
+ Returns:
+
+<!-- ##### FUNCTION soup_socket_client_new_sync ##### -->
+<para>
+
+</para>
+
+ hostname:
+ port:
+ ssl_creds:
+ status_ret:
+ Returns:
+
+<!-- ##### FUNCTION soup_socket_connect ##### -->
+<para>
+
+</para>
+
+ sock:
+ remote_addr:
+ Returns:
+
+<!-- ##### FUNCTION soup_socket_server_new ##### -->
+<para>
+
+</para>
+
+ local_addr:
+ ssl_creds:
+ callback:
+ user_data:
+ Returns:
+
+<!-- ##### FUNCTION soup_ssl_error_quark ##### -->
+<para>
+
+</para>
+
+ Returns:
+
+<!-- ##### FUNCTION soup_ssl_free_client_credentials ##### -->
+<para>
+
+</para>
+
+ creds:
+
+<!-- ##### FUNCTION soup_ssl_free_server_credentials ##### -->
+<para>
+
+</para>
+
+ creds:
+
+<!-- ##### FUNCTION soup_ssl_get_client_credentials ##### -->
+<para>
+
+</para>
+
+ ca_file:
+ Returns:
+
+<!-- ##### FUNCTION soup_ssl_get_server_credentials ##### -->
+<para>
+
+</para>
+
+ cert_file:
+ key_file:
+ Returns:
+
+<!-- ##### FUNCTION soup_ssl_wrap_iochannel ##### -->
+<para>
+
+</para>
+
+ sock:
+ type:
+ remote_host:
+ creds:
+ Returns:
+
+<!-- ##### FUNCTION soup_uri_copy_root ##### -->
+<para>
+
+</para>
+
+ uri:
+ Returns:
+
+<!-- ##### FUNCTION soup_xml_real_node ##### -->
+<para>
+
+</para>
+
+ node:
+ Returns:
+
+<!-- ##### FUNCTION soup_xmlrpc_message_end_array ##### -->
+<para>
+
+</para>
+
+ msg:
+
+<!-- ##### FUNCTION soup_xmlrpc_message_end_call ##### -->
+<para>
+
+</para>
+
+ msg:
+
+<!-- ##### FUNCTION soup_xmlrpc_message_end_member ##### -->
+<para>
+
+</para>
+
+ msg:
+
+<!-- ##### FUNCTION soup_xmlrpc_message_end_param ##### -->
+<para>
+
+</para>
+
+ msg:
+
+<!-- ##### FUNCTION soup_xmlrpc_message_end_struct ##### -->
+<para>
+
+</para>
+
+ msg:
+
+<!-- ##### FUNCTION soup_xmlrpc_message_from_string ##### -->
+<para>
+
+</para>
+
+ message:
+ xmlstr:
+ Returns:
+
+<!-- ##### FUNCTION soup_xmlrpc_message_new ##### -->
+<para>
+
+</para>
+
+ uri_string:
+ Returns:
+
+<!-- ##### FUNCTION soup_xmlrpc_message_new_from_uri ##### -->
+<para>
+
+</para>
+
+ uri:
+ Returns:
+
+<!-- ##### FUNCTION soup_xmlrpc_message_parse_response ##### -->
+<para>
+
+</para>
+
+ msg:
+ Returns:
+
+<!-- ##### FUNCTION soup_xmlrpc_message_persist ##### -->
+<para>
+
+</para>
+
+ msg:
+
+<!-- ##### FUNCTION soup_xmlrpc_message_start_array ##### -->
+<para>
+
+</para>
+
+ msg:
+
+<!-- ##### FUNCTION soup_xmlrpc_message_start_call ##### -->
+<para>
+
+</para>
+
+ msg:
+ method_name:
+
+<!-- ##### FUNCTION soup_xmlrpc_message_start_member ##### -->
+<para>
+
+</para>
+
+ msg:
+ name:
+
+<!-- ##### FUNCTION soup_xmlrpc_message_start_param ##### -->
+<para>
+
+</para>
+
+ msg:
+
+<!-- ##### FUNCTION soup_xmlrpc_message_start_struct ##### -->
+<para>
+
+</para>
+
+ msg:
+
+<!-- ##### FUNCTION soup_xmlrpc_message_to_string ##### -->
+<para>
+
+</para>
+
+ msg:
+ Returns:
+
+<!-- ##### FUNCTION soup_xmlrpc_message_write_base64 ##### -->
+<para>
+
+</para>
+
+ msg:
+ buf:
+ len:
+
+<!-- ##### FUNCTION soup_xmlrpc_message_write_boolean ##### -->
+<para>
+
+</para>
+
+ msg:
+ b:
+
+<!-- ##### FUNCTION soup_xmlrpc_message_write_datetime ##### -->
+<para>
+
+</para>
+
+ msg:
+ timeval:
+
+<!-- ##### FUNCTION soup_xmlrpc_message_write_double ##### -->
+<para>
+
+</para>
+
+ msg:
+ d:
+
+<!-- ##### FUNCTION soup_xmlrpc_message_write_int ##### -->
+<para>
+
+</para>
+
+ msg:
+ Param2:
+
+<!-- ##### FUNCTION soup_xmlrpc_message_write_string ##### -->
+<para>
+
+</para>
+
+ msg:
+ str:
+
+<!-- ##### FUNCTION soup_xmlrpc_response_from_string ##### -->
+<para>
+
+</para>
+
+ response:
+ xmlstr:
+ Returns:
+
+<!-- ##### FUNCTION soup_xmlrpc_response_get_value ##### -->
+<para>
+
+</para>
+
+ response:
+ Returns:
+
+<!-- ##### FUNCTION soup_xmlrpc_response_is_fault ##### -->
+<para>
+
+</para>
+
+ response:
+ Returns:
+
+<!-- ##### FUNCTION soup_xmlrpc_response_new ##### -->
+<para>
+
+</para>
+
+ Returns:
+
+<!-- ##### FUNCTION soup_xmlrpc_response_new_from_string ##### -->
+<para>
+
+</para>
+
+ xmlstr:
+ Returns:
+
+<!-- ##### FUNCTION soup_xmlrpc_response_to_string ##### -->
+<para>
+
+</para>
+
+ response:
+ Returns:
+
+<!-- ##### FUNCTION soup_xmlrpc_value_array_get_iterator ##### -->
+<para>
+
+</para>
+
+ value:
+ iter:
+ Returns:
+
+<!-- ##### FUNCTION soup_xmlrpc_value_array_iterator_get_value ##### -->
+<para>
+
+</para>
+
+ iter:
+ value:
+ Returns:
+
+<!-- ##### FUNCTION soup_xmlrpc_value_array_iterator_next ##### -->
+<para>
+
+</para>
+
+ iter:
+ Returns:
+
+<!-- ##### FUNCTION soup_xmlrpc_value_array_iterator_prev ##### -->
+<para>
+
+</para>
+
+ iter:
+ Returns:
+
+<!-- ##### FUNCTION soup_xmlrpc_value_dump ##### -->
+<para>
+
+</para>
+
+ value:
+
+<!-- ##### FUNCTION soup_xmlrpc_value_get_base64 ##### -->
+<para>
+
+</para>
+
+ value:
+ data:
+ Returns:
+
+<!-- ##### FUNCTION soup_xmlrpc_value_get_boolean ##### -->
+<para>
+
+</para>
+
+ value:
+ b:
+ Returns:
+
+<!-- ##### FUNCTION soup_xmlrpc_value_get_datetime ##### -->
+<para>
+
+</para>
+
+ value:
+ timeval:
+ Returns:
+
+<!-- ##### FUNCTION soup_xmlrpc_value_get_double ##### -->
+<para>
+
+</para>
+
+ value:
+ b:
+ Returns:
+
+<!-- ##### FUNCTION soup_xmlrpc_value_get_int ##### -->
+<para>
+
+</para>
+
+ value:
+ i:
+ Returns:
+
+<!-- ##### FUNCTION soup_xmlrpc_value_get_string ##### -->
+<para>
+
+</para>
+
+ value:
+ str:
+ Returns:
+
+<!-- ##### FUNCTION soup_xmlrpc_value_get_struct ##### -->
+<para>
+
+</para>
+
+ value:
+ table:
+ Returns:
+
+<!-- ##### FUNCTION soup_xmlrpc_value_get_type ##### -->
+<para>
+
+</para>
+
+ value:
@Returns:
Modified: branches/libsoup-2.4/docs/reference/tmpl/soup-address.sgml
==============================================================================
--- branches/libsoup-2.4/docs/reference/tmpl/soup-address.sgml (original)
+++ branches/libsoup-2.4/docs/reference/tmpl/soup-address.sgml Sun Jan 6 15:52:42 2008
@@ -2,13 +2,13 @@
SoupAddress
<!-- ##### SECTION Short_Description ##### -->
-Higher-level IP address object
+DNS support
<!-- ##### SECTION Long_Description ##### -->
<para>
#SoupAddress represents the address of a TCP connection endpoint; both
the IP address and the port. (It is somewhat like an object-oriented
-version of struct #sockaddr.)
+version of <literal>struct sockaddr</literal>.)
</para>
<para>
@@ -99,16 +99,6 @@
</para>
@addr:
- callback:
- user_data:
-
-
-<!-- ##### FUNCTION soup_address_resolve_async_full ##### -->
-<para>
-
-</para>
-
- addr:
@async_context:
@callback:
@user_data:
Added: branches/libsoup-2.4/docs/reference/tmpl/soup-auth-domain-basic.sgml
==============================================================================
--- (empty file)
+++ branches/libsoup-2.4/docs/reference/tmpl/soup-auth-domain-basic.sgml Sun Jan 6 15:52:42 2008
@@ -0,0 +1,84 @@
+<!-- ##### SECTION Title ##### -->
+SoupAuthDomainBasic
+
+<!-- ##### SECTION Short_Description ##### -->
+Server-side "Basic" authentication
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+#SoupAuthDomainBasic handles the server side of HTTP "Basic" (ie,
+cleartext password) authentication.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT SoupAuthDomainBasic ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ARG SoupAuthDomainBasic:auth-callback ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG SoupAuthDomainBasic:auth-data ##### -->
+<para>
+
+</para>
+
+<!-- ##### FUNCTION soup_auth_domain_basic_new ##### -->
+<para>
+
+</para>
+
+ optname1:
+ Varargs:
+ Returns:
+
+
+<!-- ##### USER_FUNCTION SoupAuthDomainBasicAuthCallback ##### -->
+<para>
+
+</para>
+
+ domain:
+ msg:
+ username:
+ password:
+ user_data:
+ Returns:
+
+
+<!-- ##### FUNCTION soup_auth_domain_basic_set_auth_callback ##### -->
+<para>
+
+</para>
+
+ domain:
+ callback:
+ user_data:
+ dnotify:
+
+
+<!-- ##### MACRO SOUP_AUTH_DOMAIN_BASIC_AUTH_CALLBACK ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO SOUP_AUTH_DOMAIN_BASIC_AUTH_DATA ##### -->
+<para>
+
+</para>
+
+
+
Added: branches/libsoup-2.4/docs/reference/tmpl/soup-auth-domain-digest.sgml
==============================================================================
--- (empty file)
+++ branches/libsoup-2.4/docs/reference/tmpl/soup-auth-domain-digest.sgml Sun Jan 6 15:52:42 2008
@@ -0,0 +1,105 @@
+<!-- ##### SECTION Title ##### -->
+SoupAuthDomainDigest
+
+<!-- ##### SECTION Short_Description ##### -->
+Server-side "Digest" authentication
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+#SoupAuthDomainDigest handles the server side of HTTP "Digest" authentication.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT SoupAuthDomainDigest ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ARG SoupAuthDomainDigest:auth-callback ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG SoupAuthDomainDigest:auth-data ##### -->
+<para>
+
+</para>
+
+<!-- ##### FUNCTION soup_auth_domain_digest_new ##### -->
+<para>
+
+</para>
+
+ optname1:
+ Varargs:
+ Returns:
+
+
+<!-- ##### USER_FUNCTION SoupAuthDomainDigestAuthCallback ##### -->
+<para>
+
+</para>
+
+ domain:
+ msg:
+ username:
+ user_data:
+ Returns:
+
+
+<!-- ##### FUNCTION soup_auth_domain_digest_set_auth_callback ##### -->
+<para>
+
+</para>
+
+ domain:
+ callback:
+ user_data:
+ dnotify:
+
+
+<!-- ##### FUNCTION soup_auth_domain_digest_encode_password ##### -->
+<para>
+
+</para>
+
+ username:
+ realm:
+ password:
+ Returns:
+
+
+<!-- ##### FUNCTION soup_auth_domain_digest_evil_check_password ##### -->
+<para>
+
+</para>
+
+ domain:
+ msg:
+ username:
+ password:
+ Returns:
+
+
+<!-- ##### MACRO SOUP_AUTH_DOMAIN_DIGEST_AUTH_CALLBACK ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO SOUP_AUTH_DOMAIN_DIGEST_AUTH_DATA ##### -->
+<para>
+
+</para>
+
+
+
Added: branches/libsoup-2.4/docs/reference/tmpl/soup-auth-domain.sgml
==============================================================================
--- (empty file)
+++ branches/libsoup-2.4/docs/reference/tmpl/soup-auth-domain.sgml Sun Jan 6 15:52:42 2008
@@ -0,0 +1,182 @@
+<!-- ##### SECTION Title ##### -->
+SoupAuthDomain
+
+<!-- ##### SECTION Short_Description ##### -->
+Server-side authentication
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+A #SoupAuthDomain manages authentication for all or part of a
+#SoupServer. To make a server require authentication, first create an
+appropriate subclass of #SoupAuthDomain, and then add it to the server
+with soup_server_add_auth_domain().
+</para>
+
+<para>
+In order for an auth domain to have any effect, you must add one or
+more paths to it (via soup_auth_domain_add_path() or the
+%SOUP_AUTH_DOMAIN_ADD_PATH property). To require authentication for
+all requests, add the path "/".
+</para>
+
+<para>
+If you need greater control over which requests should and shouldn't
+be authenticated, add paths covering everything you
+<emphasis>might</emphasis> want authenticated, and then use a filter
+(soup_auth_domain_set_filter()) to bypass authentication for those
+requests that don't need it.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT SoupAuthDomain ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ARG SoupAuthDomain:add-path ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG SoupAuthDomain:filter ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG SoupAuthDomain:filter-data ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG SoupAuthDomain:proxy ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG SoupAuthDomain:realm ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG SoupAuthDomain:remove-path ##### -->
+<para>
+
+</para>
+
+<!-- ##### FUNCTION soup_auth_domain_add_path ##### -->
+<para>
+
+</para>
+
+ domain:
+ path:
+
+
+<!-- ##### FUNCTION soup_auth_domain_remove_path ##### -->
+<para>
+
+</para>
+
+ domain:
+ path:
+
+
+<!-- ##### FUNCTION soup_auth_domain_set_filter ##### -->
+<para>
+
+</para>
+
+ domain:
+ filter:
+ filter_data:
+ dnotify:
+
+
+<!-- ##### FUNCTION soup_auth_domain_get_realm ##### -->
+<para>
+
+</para>
+
+ domain:
+ Returns:
+
+
+<!-- ##### FUNCTION soup_auth_domain_covers ##### -->
+<para>
+
+</para>
+
+ domain:
+ msg:
+ Returns:
+
+
+<!-- ##### FUNCTION soup_auth_domain_accepts ##### -->
+<para>
+
+</para>
+
+ domain:
+ msg:
+ Returns:
+
+
+<!-- ##### FUNCTION soup_auth_domain_challenge ##### -->
+<para>
+
+</para>
+
+ domain:
+ msg:
+
+
+<!-- ##### MACRO SOUP_AUTH_DOMAIN_REALM ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO SOUP_AUTH_DOMAIN_PROXY ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO SOUP_AUTH_DOMAIN_ADD_PATH ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO SOUP_AUTH_DOMAIN_REMOVE_PATH ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO SOUP_AUTH_DOMAIN_FILTER ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO SOUP_AUTH_DOMAIN_FILTER_DATA ##### -->
+<para>
+
+</para>
+
+
+
Modified: branches/libsoup-2.4/docs/reference/tmpl/soup-auth.sgml
==============================================================================
--- branches/libsoup-2.4/docs/reference/tmpl/soup-auth.sgml (original)
+++ branches/libsoup-2.4/docs/reference/tmpl/soup-auth.sgml Sun Jan 6 15:52:42 2008
@@ -7,13 +7,13 @@
<!-- ##### SECTION Long_Description ##### -->
<para>
#SoupAuth objects store the authentication data associated with a
-given bit of webspace. They are created and maintained automatically
+given bit of webspace. They are created automatically
by #SoupSession.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
-#SoupSession, #SoupConnectionNTLM
+#SoupSession
</para>
<!-- ##### SECTION Stability_Level ##### -->
@@ -22,30 +22,65 @@
<!-- ##### STRUCT SoupAuth ##### -->
<para>
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.)
+Authentication mechanisms are implemented by its subclasses, but
+applications never need to be aware of the specific subclasses being
+used.
</para>
-<!-- ##### STRUCT SoupAuthBasic ##### -->
+<!-- ##### ARG SoupAuth:host ##### -->
<para>
-An object representing Basic HTTP authentication.
+
+</para>
+
+<!-- ##### ARG SoupAuth:is-authenticated ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG SoupAuth:is-for-proxy ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG SoupAuth:realm ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG SoupAuth:scheme-name ##### -->
+<para>
+
+</para>
+
+<!-- ##### FUNCTION soup_auth_new ##### -->
+<para>
+
</para>
+ type:
+ msg:
+ auth_header:
+ Returns:
+
-<!-- ##### STRUCT SoupAuthDigest ##### -->
+<!-- ##### FUNCTION soup_auth_update ##### -->
<para>
-An object representing Digest HTTP authentication.
+
</para>
+ auth:
+ msg:
+ auth_header:
+ Returns:
+
-<!-- ##### FUNCTION soup_auth_new_from_header_list ##### -->
+<!-- ##### FUNCTION soup_auth_is_for_proxy ##### -->
<para>
</para>
- vals:
+ auth:
@Returns:
@@ -58,6 +93,15 @@
@Returns:
+<!-- ##### FUNCTION soup_auth_get_host ##### -->
+<para>
+
+</para>
+
+ auth:
+ Returns:
+
+
<!-- ##### FUNCTION soup_auth_get_realm ##### -->
<para>
@@ -67,6 +111,15 @@
@Returns:
+<!-- ##### FUNCTION soup_auth_get_info ##### -->
+<para>
+
+</para>
+
+ auth:
+ Returns:
+
+
<!-- ##### FUNCTION soup_auth_authenticate ##### -->
<para>
@@ -115,3 +168,38 @@
@space:
+<!-- ##### MACRO SOUP_AUTH_SCHEME_NAME ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO SOUP_AUTH_REALM ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO SOUP_AUTH_HOST ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO SOUP_AUTH_IS_FOR_PROXY ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO SOUP_AUTH_IS_AUTHENTICATED ##### -->
+<para>
+
+</para>
+
+
+
Added: branches/libsoup-2.4/docs/reference/tmpl/soup-message-body.sgml
==============================================================================
--- (empty file)
+++ branches/libsoup-2.4/docs/reference/tmpl/soup-message-body.sgml Sun Jan 6 15:52:42 2008
@@ -0,0 +1,164 @@
+<!-- ##### SECTION Title ##### -->
+SoupMessageBody
+
+<!-- ##### SECTION Short_Description ##### -->
+HTTP Message Body
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+#SoupMessageBody represents the request or response body of a
+#SoupMessage.
+</para>
+
+<para>
+In addition to #SoupMessageBody, libsoup also defines a "smaller" data
+buffer type, #SoupBuffer, which is primarily used as a component of
+#SoupMessageBody. In particular, when using chunked encoding to
+transmit or receive a message, each chunk is represented as a
+#SoupBuffer.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+#SoupMessage
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT SoupBuffer ##### -->
+<para>
+
+</para>
+
+ data:
+ length:
+
+<!-- ##### ENUM SoupMemoryUse ##### -->
+<para>
+
+</para>
+
+ SOUP_MEMORY_STATIC:
+ SOUP_MEMORY_TAKE:
+ SOUP_MEMORY_COPY:
+ SOUP_MEMORY_TEMPORARY:
+
+<!-- ##### FUNCTION soup_buffer_new ##### -->
+<para>
+
+</para>
+
+ use:
+ data:
+ length:
+ Returns:
+
+
+<!-- ##### FUNCTION soup_buffer_new_subbuffer ##### -->
+<para>
+
+</para>
+
+ parent:
+ offset:
+ length:
+ Returns:
+
+
+<!-- ##### FUNCTION soup_buffer_copy ##### -->
+<para>
+
+</para>
+
+ buffer:
+ Returns:
+
+
+<!-- ##### FUNCTION soup_buffer_free ##### -->
+<para>
+
+</para>
+
+ buffer:
+
+
+<!-- ##### STRUCT SoupMessageBody ##### -->
+<para>
+
+</para>
+
+ data:
+ length:
+
+<!-- ##### FUNCTION soup_message_body_new ##### -->
+<para>
+
+</para>
+
+ Returns:
+
+
+<!-- ##### FUNCTION soup_message_body_free ##### -->
+<para>
+
+</para>
+
+ body:
+
+
+<!-- ##### FUNCTION soup_message_body_append ##### -->
+<para>
+
+</para>
+
+ body:
+ use:
+ data:
+ length:
+
+
+<!-- ##### FUNCTION soup_message_body_append_buffer ##### -->
+<para>
+
+</para>
+
+ body:
+ buffer:
+
+
+<!-- ##### FUNCTION soup_message_body_truncate ##### -->
+<para>
+
+</para>
+
+ body:
+
+
+<!-- ##### FUNCTION soup_message_body_complete ##### -->
+<para>
+
+</para>
+
+ body:
+
+
+<!-- ##### FUNCTION soup_message_body_flatten ##### -->
+<para>
+
+</para>
+
+ body:
+ Returns:
+
+
+<!-- ##### FUNCTION soup_message_body_get_chunk ##### -->
+<para>
+
+</para>
+
+ body:
+ offset:
+ Returns:
+
+
Added: branches/libsoup-2.4/docs/reference/tmpl/soup-message-headers.sgml
==============================================================================
--- (empty file)
+++ branches/libsoup-2.4/docs/reference/tmpl/soup-message-headers.sgml Sun Jan 6 15:52:42 2008
@@ -0,0 +1,192 @@
+<!-- ##### SECTION Title ##### -->
+SoupMessageHeaders
+
+<!-- ##### SECTION Short_Description ##### -->
+HTTP Message Headers
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+#SoupMessageHeaders represents the HTTP message headers associated
+with a request or response.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+#SoupMessage
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### TYPEDEF SoupMessageHeaders ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ENUM SoupMessageHeadersType ##### -->
+<para>
+
+</para>
+
+ SOUP_MESSAGE_HEADERS_REQUEST:
+ SOUP_MESSAGE_HEADERS_RESPONSE:
+
+<!-- ##### FUNCTION soup_message_headers_new ##### -->
+<para>
+
+</para>
+
+ type:
+ Returns:
+
+
+<!-- ##### FUNCTION soup_message_headers_free ##### -->
+<para>
+
+</para>
+
+ hdrs:
+
+
+<!-- ##### FUNCTION soup_message_headers_append ##### -->
+<para>
+
+</para>
+
+ hdrs:
+ name:
+ value:
+
+
+<!-- ##### FUNCTION soup_message_headers_replace ##### -->
+<para>
+
+</para>
+
+ hdrs:
+ name:
+ value:
+
+
+<!-- ##### FUNCTION soup_message_headers_remove ##### -->
+<para>
+
+</para>
+
+ hdrs:
+ name:
+
+
+<!-- ##### FUNCTION soup_message_headers_clear ##### -->
+<para>
+
+</para>
+
+ hdrs:
+
+
+<!-- ##### FUNCTION soup_message_headers_get ##### -->
+<para>
+
+</para>
+
+ hdrs:
+ name:
+ Returns:
+
+
+<!-- ##### USER_FUNCTION SoupMessageHeadersForeachFunc ##### -->
+<para>
+
+</para>
+
+ name:
+ value:
+ user_data:
+
+
+<!-- ##### FUNCTION soup_message_headers_foreach ##### -->
+<para>
+
+</para>
+
+ hdrs:
+ func:
+ user_data:
+
+
+<!-- ##### ENUM SoupEncoding ##### -->
+<para>
+
+</para>
+
+ SOUP_ENCODING_UNRECOGNIZED:
+ SOUP_ENCODING_NONE:
+ SOUP_ENCODING_CONTENT_LENGTH:
+ SOUP_ENCODING_EOF:
+ SOUP_ENCODING_CHUNKED:
+ SOUP_ENCODING_BYTERANGES:
+
+<!-- ##### FUNCTION soup_message_headers_get_encoding ##### -->
+<para>
+
+</para>
+
+ hdrs:
+ Returns:
+
+
+<!-- ##### FUNCTION soup_message_headers_set_encoding ##### -->
+<para>
+
+</para>
+
+ hdrs:
+ encoding:
+
+
+<!-- ##### FUNCTION soup_message_headers_get_content_length ##### -->
+<para>
+
+</para>
+
+ hdrs:
+ Returns:
+
+
+<!-- ##### FUNCTION soup_message_headers_set_content_length ##### -->
+<para>
+
+</para>
+
+ hdrs:
+ content_length:
+
+
+<!-- ##### ENUM SoupExpectation ##### -->
+<para>
+
+</para>
+
+ SOUP_EXPECTATION_UNRECOGNIZED:
+ SOUP_EXPECTATION_CONTINUE:
+
+<!-- ##### FUNCTION soup_message_headers_get_expectations ##### -->
+<para>
+
+</para>
+
+ hdrs:
+ Returns:
+
+
+<!-- ##### FUNCTION soup_message_headers_set_expectations ##### -->
+<para>
+
+</para>
+
+ hdrs:
+ expectations:
+
+
Modified: branches/libsoup-2.4/docs/reference/tmpl/soup-message.sgml
==============================================================================
--- branches/libsoup-2.4/docs/reference/tmpl/soup-message.sgml (original)
+++ branches/libsoup-2.4/docs/reference/tmpl/soup-message.sgml Sun Jan 6 15:52:42 2008
@@ -25,11 +25,10 @@
@method:
@status_code:
@reason_phrase:
- request:
+ request_body:
@request_headers:
- response:
+ response_body:
@response_headers:
- status:
<!-- ##### SIGNAL SoupMessage::finished ##### -->
<para>
@@ -51,6 +50,7 @@
</para>
@msg:
+ Param2:
<!-- ##### SIGNAL SoupMessage::got-headers ##### -->
<para>
@@ -101,66 +101,36 @@
@msg:
-<!-- ##### ENUM SoupMessageStatus ##### -->
+<!-- ##### ARG SoupMessage:flags ##### -->
<para>
</para>
- 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 ##### -->
-
+<!-- ##### ARG SoupMessage:http-version ##### -->
<para>
</para>
- msg:
- Returns:
-
-
-<!-- ##### ENUM SoupTransferEncoding ##### -->
+<!-- ##### ARG SoupMessage:method ##### -->
<para>
</para>
- SOUP_TRANSFER_UNKNOWN:
- SOUP_TRANSFER_CHUNKED:
- SOUP_TRANSFER_CONTENT_LENGTH:
- SOUP_TRANSFER_BYTERANGES:
- SOUP_TRANSFER_NONE:
- SOUP_TRANSFER_EOF:
-
-<!-- ##### ENUM SoupOwnership ##### -->
+<!-- ##### ARG SoupMessage:reason-phrase ##### -->
<para>
</para>
- SOUP_BUFFER_SYSTEM_OWNED:
- SOUP_BUFFER_USER_OWNED:
- SOUP_BUFFER_STATIC:
-
-<!-- ##### STRUCT SoupDataBuffer ##### -->
+<!-- ##### ARG SoupMessage:status-code ##### -->
<para>
</para>
- owner:
- body:
- length:
-
-<!-- ##### USER_FUNCTION SoupMessageCallbackFn ##### -->
+<!-- ##### ARG SoupMessage:uri ##### -->
<para>
</para>
- req:
- user_data:
-
-
<!-- ##### FUNCTION soup_message_new ##### -->
<para>
@@ -188,7 +158,7 @@
@msg:
@content_type:
- req_owner:
+ req_use:
@req_body:
@req_length:
@@ -200,69 +170,12 @@
@msg:
@content_type:
- resp_owner:
+ resp_use:
@resp_body:
@resp_length:
-<!-- ##### FUNCTION soup_message_add_header ##### -->
-<para>
-
-</para>
-
- hash:
- name:
- value:
-
-
-<!-- ##### FUNCTION soup_message_get_header ##### -->
-<para>
-
-</para>
-
- hash:
- name:
- Returns:
-
-
-<!-- ##### FUNCTION soup_message_get_header_list ##### -->
-<para>
-
-</para>
-
- hash:
- name:
- Returns:
-
-
-<!-- ##### FUNCTION soup_message_foreach_header ##### -->
-<para>
-
-</para>
-
- hash:
- func:
- user_data:
-
-
-<!-- ##### FUNCTION soup_message_remove_header ##### -->
-<para>
-
-</para>
-
- hash:
- name:
-
-
-<!-- ##### FUNCTION soup_message_clear_headers ##### -->
-<para>
-
-</para>
-
- hash:
-
-
-<!-- ##### ENUM SoupHttpVersion ##### -->
+<!-- ##### ENUM SoupHTTPVersion ##### -->
<para>
</para>
@@ -313,7 +226,6 @@
@SOUP_MESSAGE_NO_REDIRECT:
@SOUP_MESSAGE_OVERWRITE_CHUNKS:
- SOUP_MESSAGE_EXPECT_CONTINUE:
<!-- ##### FUNCTION soup_message_set_flags ##### -->
<para>
@@ -352,34 +264,6 @@
@reason_phrase:
-<!-- ##### FUNCTION soup_message_add_chunk ##### -->
-<para>
-
-</para>
-
- msg:
- owner:
- body:
- length:
-
-
-<!-- ##### FUNCTION soup_message_add_final_chunk ##### -->
-<para>
-
-</para>
-
- msg:
-
-
-<!-- ##### FUNCTION soup_message_pop_chunk ##### -->
-<para>
-
-</para>
-
- msg:
- Returns:
-
-
<!-- ##### FUNCTION soup_message_is_keepalive ##### -->
<para>
@@ -389,57 +273,17 @@
@Returns:
-<!-- ##### FUNCTION soup_message_get_request_encoding ##### -->
-<para>
-
-</para>
-
- msg:
- content_length:
- Returns:
-
-
-<!-- ##### FUNCTION soup_message_get_response_encoding ##### -->
-<para>
-
-</para>
-
- msg:
- content_length:
- Returns:
-
-
-<!-- ##### ENUM SoupHandlerPhase ##### -->
-<para>
-
-</para>
-
- SOUP_HANDLER_POST_REQUEST:
- SOUP_HANDLER_PRE_BODY:
- SOUP_HANDLER_BODY_CHUNK:
- SOUP_HANDLER_POST_BODY:
-
-<!-- ##### FUNCTION soup_message_add_handler ##### -->
-<para>
-
-</para>
-
- msg:
- phase:
- handler_cb:
- user_data:
-
-
<!-- ##### FUNCTION soup_message_add_header_handler ##### -->
<para>
</para>
@msg:
+ signal:
@header:
- phase:
- handler_cb:
+ callback:
@user_data:
+ Returns:
<!-- ##### FUNCTION soup_message_add_status_code_handler ##### -->
@@ -448,75 +292,52 @@
</para>
@msg:
+ signal:
@status_code:
- phase:
- handler_cb:
- user_data:
-
-
-<!-- ##### FUNCTION soup_message_add_status_class_handler ##### -->
-<para>
-
-</para>
-
- msg:
- status_class:
- phase:
- handler_cb:
+ callback:
@user_data:
+ Returns:
-<!-- ##### FUNCTION soup_message_remove_handler ##### -->
+<!-- ##### MACRO SOUP_MESSAGE_METHOD ##### -->
<para>
</para>
- msg:
- phase:
- handler_cb:
- user_data:
-<!-- ##### FUNCTION soup_message_send_request ##### -->
+<!-- ##### MACRO SOUP_MESSAGE_URI ##### -->
<para>
</para>
- req:
- sock:
- is_via_proxy:
-<!-- ##### FUNCTION soup_message_read_request ##### -->
+<!-- ##### MACRO SOUP_MESSAGE_HTTP_VERSION ##### -->
<para>
</para>
- req:
- sock:
-<!-- ##### FUNCTION soup_message_io_pause ##### -->
+<!-- ##### MACRO SOUP_MESSAGE_FLAGS ##### -->
<para>
</para>
- msg:
-<!-- ##### FUNCTION soup_message_io_unpause ##### -->
+<!-- ##### MACRO SOUP_MESSAGE_STATUS_CODE ##### -->
<para>
</para>
- msg:
-<!-- ##### FUNCTION soup_message_io_stop ##### -->
+<!-- ##### MACRO SOUP_MESSAGE_REASON_PHRASE ##### -->
<para>
</para>
- msg:
Added: branches/libsoup-2.4/docs/reference/tmpl/soup-method.sgml
==============================================================================
--- (empty file)
+++ branches/libsoup-2.4/docs/reference/tmpl/soup-method.sgml Sun Jan 6 15:52:42 2008
@@ -0,0 +1,149 @@
+<!-- ##### SECTION Title ##### -->
+soup-method
+
+<!-- ##### SECTION Short_Description ##### -->
+HTTP method definitions
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+soup-method.h contains a number of defines for standard HTTP and
+WebDAV headers. You do not need to use these defines; you can pass
+arbitrary strings to soup_message_new() if you prefer.
+</para>
+
+<para>
+The thing that these defines <emphasis>are</emphasis> useful for is
+performing quick comparisons against #SoupMessage's %method field;
+because that field always contains an interned string, and these
+macros return interned strings, you can compare %method directly
+against these macros rather than needing to use strcmp(). This is most
+useful in SoupServer handlers. Eg:
+</para>
+
+<informalexample><programlisting>
+ if (msg->method != SOUP_METHOD_GET && msg->method != SOUP_METHOD_HEAD) {
+ soup_message_set_status (msg, SOUP_METHOD_NOT_IMPLEMENTED);
+ return;
+ }
+</programlisting></informalexample>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+g_intern_string()
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### MACRO SOUP_METHOD_OPTIONS ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO SOUP_METHOD_GET ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO SOUP_METHOD_HEAD ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO SOUP_METHOD_PUT ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO SOUP_METHOD_POST ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO SOUP_METHOD_DELETE ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO SOUP_METHOD_TRACE ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO SOUP_METHOD_CONNECT ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO SOUP_METHOD_PROPFIND ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO SOUP_METHOD_PROPPATCH ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO SOUP_METHOD_MKCOL ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO SOUP_METHOD_COPY ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO SOUP_METHOD_MOVE ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO SOUP_METHOD_LOCK ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO SOUP_METHOD_UNLOCK ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO SOUP_METHOD_PATCH ##### -->
+<para>
+
+</para>
+
+
+
Modified: branches/libsoup-2.4/docs/reference/tmpl/soup-misc.sgml
==============================================================================
--- branches/libsoup-2.4/docs/reference/tmpl/soup-misc.sgml (original)
+++ branches/libsoup-2.4/docs/reference/tmpl/soup-misc.sgml Sun Jan 6 15:52:42 2008
@@ -17,188 +17,188 @@
<!-- ##### SECTION Stability_Level ##### -->
-<!-- ##### FUNCTION soup_base64_decode ##### -->
+<!-- ##### STRUCT SoupDate ##### -->
<para>
</para>
- text:
- out_len:
- Returns:
-
+ year:
+ month:
+ day:
+ hour:
+ minute:
+ second:
+ utc:
+ offset:
-<!-- ##### FUNCTION soup_base64_encode ##### -->
+<!-- ##### ENUM SoupDateFormat ##### -->
<para>
</para>
- text:
- len:
- Returns:
+ SOUP_DATE_HTTP:
+ SOUP_DATE_COOKIE:
+ SOUP_DATE_RFC2822:
+ SOUP_DATE_ISO8601_COMPACT:
+ SOUP_DATE_ISO8601_FULL:
+ SOUP_DATE_ISO8601:
+ SOUP_DATE_ISO8601_XMLRPC:
-
-<!-- ##### FUNCTION soup_base64_decode_step ##### -->
+<!-- ##### FUNCTION soup_date_new ##### -->
<para>
</para>
- in:
- len:
- out:
- state:
- save:
+ year:
+ month:
+ day:
+ hour:
+ minute:
+ second:
@Returns:
-<!-- ##### FUNCTION soup_base64_encode_step ##### -->
+<!-- ##### FUNCTION soup_date_new_from_string ##### -->
<para>
</para>
- in:
- len:
- break_lines:
- out:
- state:
- save:
+ date_string:
@Returns:
-<!-- ##### FUNCTION soup_base64_encode_close ##### -->
+<!-- ##### FUNCTION soup_date_new_from_time_t ##### -->
<para>
</para>
- in:
- inlen:
- break_lines:
- out:
- state:
- save:
+ when:
@Returns:
-<!-- ##### FUNCTION soup_add_idle ##### -->
+<!-- ##### FUNCTION soup_date_to_string ##### -->
<para>
</para>
- async_context:
- function:
- data:
+ date:
+ format:
@Returns:
-<!-- ##### FUNCTION soup_add_io_watch ##### -->
+<!-- ##### FUNCTION soup_date_free ##### -->
<para>
</para>
- async_context:
- chan:
- condition:
- function:
- data:
- Returns:
+ date:
-<!-- ##### FUNCTION soup_add_timeout ##### -->
+<!-- ##### FUNCTION soup_form_decode_urlencoded ##### -->
<para>
</para>
- async_context:
- interval:
- function:
- data:
+ encoded_form:
@Returns:
-<!-- ##### FUNCTION soup_signal_connect_once ##### -->
+<!-- ##### FUNCTION soup_form_encode_urlencoded ##### -->
<para>
</para>
- instance:
- detailed_signal:
- c_handler:
- data:
+ form_data_set:
@Returns:
-<!-- ##### FUNCTION soup_date_parse ##### -->
+<!-- ##### FUNCTION soup_form_encode_urlencoded_list ##### -->
<para>
</para>
- timestamp:
+ form_data_set:
@Returns:
-<!-- ##### FUNCTION soup_date_iso8601_parse ##### -->
+<!-- ##### FUNCTION soup_headers_parse_request ##### -->
<para>
</para>
- timestamp:
+ str:
+ len:
+ req_headers:
+ req_method:
+ req_path:
+ ver:
@Returns:
-<!-- ##### FUNCTION soup_date_generate ##### -->
+<!-- ##### FUNCTION soup_headers_parse_response ##### -->
<para>
</para>
- when:
+ str:
+ len:
+ headers:
+ ver:
+ status_code:
+ reason_phrase:
@Returns:
-<!-- ##### FUNCTION soup_gmtime ##### -->
+<!-- ##### FUNCTION soup_headers_parse_status_line ##### -->
<para>
</para>
- when:
- tm:
+ status_line:
+ ver:
+ status_code:
+ reason_phrase:
+ Returns:
-<!-- ##### FUNCTION soup_mktime_utc ##### -->
+<!-- ##### FUNCTION soup_header_parse_list ##### -->
<para>
</para>
- tm:
+ header:
@Returns:
-<!-- ##### FUNCTION soup_header_param_copy_token ##### -->
+<!-- ##### FUNCTION soup_header_parse_quality_list ##### -->
<para>
</para>
- tokens:
- t:
+ header:
+ unacceptable:
@Returns:
-<!-- ##### FUNCTION soup_header_param_decode_token ##### -->
+<!-- ##### FUNCTION soup_header_free_list ##### -->
<para>
</para>
- in:
- Returns:
+ list:
-<!-- ##### FUNCTION soup_header_param_destroy_hash ##### -->
+<!-- ##### FUNCTION soup_header_contains ##### -->
<para>
</para>
- table:
+ header:
+ token:
+ Returns:
-<!-- ##### FUNCTION soup_header_param_parse_list ##### -->
+<!-- ##### FUNCTION soup_header_parse_param_list ##### -->
<para>
</para>
@@ -207,71 +207,72 @@
@Returns:
-<!-- ##### FUNCTION soup_headers_parse_request ##### -->
+<!-- ##### FUNCTION soup_header_free_param_list ##### -->
<para>
</para>
- str:
- len:
- dest:
- req_method:
- req_path:
- ver:
- Returns:
+ param_list:
-<!-- ##### FUNCTION soup_headers_parse_response ##### -->
+<!-- ##### FUNCTION soup_str_case_equal ##### -->
<para>
</para>
- str:
- len:
- dest:
- ver:
- status_code:
- reason_phrase:
+ v1:
+ v2:
@Returns:
-<!-- ##### FUNCTION soup_headers_parse_status_line ##### -->
+<!-- ##### FUNCTION soup_str_case_hash ##### -->
<para>
</para>
- status_line:
- ver:
- status_code:
- reason_phrase:
+ key:
@Returns:
-<!-- ##### FUNCTION soup_str_case_equal ##### -->
+<!-- ##### FUNCTION soup_add_idle ##### -->
<para>
</para>
- v1:
- v2:
+ async_context:
+ function:
+ data:
@Returns:
-<!-- ##### FUNCTION soup_str_case_hash ##### -->
+<!-- ##### FUNCTION soup_add_io_watch ##### -->
<para>
</para>
- key:
+ async_context:
+ chan:
+ condition:
+ function:
+ data:
@Returns:
-<!-- ##### FUNCTION soup_xml_real_node ##### -->
+<!-- ##### FUNCTION soup_add_timeout ##### -->
<para>
</para>
- node:
+ async_context:
+ interval:
+ function:
+ data:
@Returns:
+<!-- ##### VARIABLE soup_ssl_supported ##### -->
+<para>
+
+</para>
+
+
Modified: branches/libsoup-2.4/docs/reference/tmpl/soup-server.sgml
==============================================================================
--- branches/libsoup-2.4/docs/reference/tmpl/soup-server.sgml (original)
+++ branches/libsoup-2.4/docs/reference/tmpl/soup-server.sgml Sun Jan 6 15:52:42 2008
@@ -10,8 +10,36 @@
</para>
<para>
-This API is less stable than the soup client API, and will most likely
-change in the next release.
+To begin, create a server using soup_server_new(). Add at least one
+handler by calling soup_server_add_handler(); the handler will be
+called to process any requests underneath the path passed to
+soup_server_add_handler(). (If you want all requests to go to the same
+handler, just pass "/" (or %NULL) for the path.) Any request that does
+not match any handler will automatically be returned to the client
+with a 404 (Not Found) status.
+</para>
+
+<para>
+To add authentication to some or all paths, create an appropriate
+#SoupAuthDomain (qv), and add it to the server via
+soup_server_add_auth_domain.
+</para>
+
+<para>
+Additional processing options are available via #SoupServer's signals;
+Connect to #SoupServer::request-started to be notified every time a
+new request is being processed. (This gives you a chance to connect to
+the #SoupMessage "got-" signals in case you want to do processing
+before the body has been fully read.)
+</para>
+
+<para>
+Once the server is set up, start it processing connections by calling
+soup_server_run_async() or soup_server_run(). #SoupServer runs via
+the glib main loop; if you need to have a server that runs in another
+thread (or merely isn't bound to the default main loop), create a
+#GMainContext for it to use, and set that via the
+#SOUP_SERVER_ASYNC_CONTEXT property.
</para>
<!-- ##### SECTION See_Also ##### -->
@@ -28,63 +56,66 @@
</para>
-<!-- ##### ARG SoupServer:async-context ##### -->
+<!-- ##### SIGNAL SoupServer::request-aborted ##### -->
<para>
</para>
-<!-- ##### ARG SoupServer:interface ##### -->
+ soupserver: the object which received the signal.
+ arg1:
+ arg2:
+
+<!-- ##### SIGNAL SoupServer::request-finished ##### -->
<para>
</para>
-<!-- ##### ARG SoupServer:port ##### -->
+ soupserver: the object which received the signal.
+ arg1:
+ arg2:
+
+<!-- ##### SIGNAL SoupServer::request-read ##### -->
<para>
</para>
-<!-- ##### ARG SoupServer:ssl-cert-file ##### -->
+ soupserver: the object which received the signal.
+ arg1:
+ arg2:
+
+<!-- ##### SIGNAL SoupServer::request-started ##### -->
<para>
</para>
-<!-- ##### ARG SoupServer:ssl-key-file ##### -->
+ soupserver: the object which received the signal.
+ arg1:
+ arg2:
+
+<!-- ##### ARG SoupServer:async-context ##### -->
<para>
</para>
-<!-- ##### STRUCT SoupServerContext ##### -->
+<!-- ##### ARG SoupServer:interface ##### -->
<para>
</para>
- msg:
- path:
- method_id:
- auth:
- server:
- handler:
- sock:
-
-<!-- ##### USER_FUNCTION SoupServerCallbackFn ##### -->
+<!-- ##### ARG SoupServer:port ##### -->
<para>
</para>
- context:
- msg:
- user_data:
-
-
-<!-- ##### USER_FUNCTION SoupServerUnregisterFn ##### -->
+<!-- ##### ARG SoupServer:ssl-cert-file ##### -->
<para>
</para>
- server:
- handler:
- user_data:
+<!-- ##### ARG SoupServer:ssl-key-file ##### -->
+<para>
+</para>
<!-- ##### FUNCTION soup_server_new ##### -->
<para>
@@ -96,12 +127,12 @@
@Returns:
-<!-- ##### FUNCTION soup_server_get_protocol ##### -->
+<!-- ##### FUNCTION soup_server_is_https ##### -->
<para>
</para>
- serv:
+ server:
@Returns:
@@ -110,7 +141,7 @@
</para>
- serv:
+ server:
@Returns:
@@ -119,7 +150,7 @@
</para>
- serv:
+ server:
@Returns:
@@ -128,7 +159,7 @@
</para>
- serv:
+ server:
<!-- ##### FUNCTION soup_server_run_async ##### -->
@@ -136,7 +167,7 @@
</para>
- serv:
+ server:
<!-- ##### FUNCTION soup_server_quit ##### -->
@@ -144,25 +175,40 @@
</para>
- serv:
+ server:
+
+
+<!-- ##### FUNCTION soup_server_get_async_context ##### -->
+<para>
+
+</para>
+
+ server:
+ Returns:
-<!-- ##### TYPEDEF SoupServerHandler ##### -->
+<!-- ##### USER_FUNCTION SoupServerCallback ##### -->
<para>
</para>
+ server:
+ msg:
+ path:
+ query:
+ context:
+ user_data:
+
<!-- ##### FUNCTION soup_server_add_handler ##### -->
<para>
</para>
- serv:
+ server:
@path:
- auth_ctx:
@callback:
- unreg:
+ destroy:
@data:
@@ -171,30 +217,29 @@
</para>
- serv:
+ server:
@path:
-<!-- ##### FUNCTION soup_server_get_handler ##### -->
+<!-- ##### STRUCT SoupClientContext ##### -->
<para>
</para>
- serv:
- path:
- Returns:
-
+ sock:
+ auth_user:
+ auth_realm:
-<!-- ##### FUNCTION soup_server_list_handlers ##### -->
+<!-- ##### FUNCTION soup_client_context_get_address ##### -->
<para>
</para>
- serv:
+ ctx:
@Returns:
-<!-- ##### FUNCTION soup_server_context_get_client_address ##### -->
+<!-- ##### FUNCTION soup_client_context_get_host ##### -->
<para>
</para>
@@ -203,13 +248,40 @@
@Returns:
-<!-- ##### FUNCTION soup_server_context_get_client_host ##### -->
+<!-- ##### FUNCTION soup_server_add_auth_domain ##### -->
<para>
</para>
- ctx:
- Returns:
+ server:
+ auth_domain:
+
+
+<!-- ##### FUNCTION soup_server_remove_auth_domain ##### -->
+<para>
+
+</para>
+
+ server:
+ auth_domain:
+
+
+<!-- ##### FUNCTION soup_server_pause_message ##### -->
+<para>
+
+</para>
+
+ server:
+ msg:
+
+
+<!-- ##### FUNCTION soup_server_unpause_message ##### -->
+<para>
+
+</para>
+
+ server:
+ msg:
<!-- ##### MACRO SOUP_SERVER_PORT ##### -->
Modified: branches/libsoup-2.4/docs/reference/tmpl/soup-session.sgml
==============================================================================
--- branches/libsoup-2.4/docs/reference/tmpl/soup-session.sgml (original)
+++ branches/libsoup-2.4/docs/reference/tmpl/soup-session.sgml Sun Jan 6 15:52:42 2008
@@ -32,20 +32,14 @@
@msg:
@auth_type:
@auth_realm:
- username:
- password:
-<!-- ##### SIGNAL SoupSession::reauthenticate ##### -->
+<!-- ##### SIGNAL SoupSession::request-started ##### -->
<para>
</para>
- session:
- msg:
- auth_type:
- auth_realm:
- username:
- password:
+ soupsession: the object which received the signal.
+ arg1:
<!-- ##### ARG SoupSession:async-context ##### -->
<para>
@@ -82,84 +76,65 @@
</para>
-<!-- ##### FUNCTION soup_session_queue_message ##### -->
+<!-- ##### USER_FUNCTION SoupSessionCallback ##### -->
<para>
</para>
@session:
@msg:
- callback:
@user_data:
-<!-- ##### FUNCTION soup_session_requeue_message ##### -->
+<!-- ##### FUNCTION soup_session_queue_message ##### -->
<para>
</para>
@session:
@msg:
+ callback:
+ user_data:
-<!-- ##### FUNCTION soup_session_send_message ##### -->
+<!-- ##### FUNCTION soup_session_requeue_message ##### -->
<para>
</para>
@session:
@msg:
- Returns:
-
-
-<!-- ##### FUNCTION soup_session_abort ##### -->
-<para>
-</para>
-
- session:
-
-<!-- ##### FUNCTION soup_session_add_filter ##### -->
-<para>
-
-</para>
-
- session:
- filter:
-
-
-<!-- ##### FUNCTION soup_session_cancel_message ##### -->
+<!-- ##### FUNCTION soup_session_send_message ##### -->
<para>
</para>
@session:
@msg:
+ Returns:
-<!-- ##### FUNCTION soup_session_get_connection ##### -->
+<!-- ##### FUNCTION soup_session_cancel_message ##### -->
<para>
</para>
@session:
@msg:
- try_pruning:
- is_new:
- Returns:
+ status_code:
-<!-- ##### FUNCTION soup_session_remove_filter ##### -->
+<!-- ##### FUNCTION soup_session_abort ##### -->
<para>
</para>
@session:
- filter:
-<!-- ##### FUNCTION soup_session_try_prune_connection ##### -->
+<!-- ##### FUNCTION soup_session_get_async_context ##### -->
<para>
</para>
Modified: branches/libsoup-2.4/docs/reference/tmpl/soup-socket.sgml
==============================================================================
--- branches/libsoup-2.4/docs/reference/tmpl/soup-socket.sgml (original)
+++ branches/libsoup-2.4/docs/reference/tmpl/soup-socket.sgml Sun Jan 6 15:52:42 2008
@@ -23,14 +23,6 @@
</para>
-<!-- ##### SIGNAL SoupSocket::connect-result ##### -->
-<para>
-
-</para>
-
- sock:
- status:
-
<!-- ##### SIGNAL SoupSocket::disconnected ##### -->
<para>
@@ -65,17 +57,12 @@
</para>
-<!-- ##### ARG SoupSocket:cloexec ##### -->
-<para>
-
-</para>
-
<!-- ##### ARG SoupSocket:is-server ##### -->
<para>
</para>
-<!-- ##### ARG SoupSocket:nodelay ##### -->
+<!-- ##### ARG SoupSocket:local-address ##### -->
<para>
</para>
@@ -85,7 +72,7 @@
</para>
-<!-- ##### ARG SoupSocket:reuseaddr ##### -->
+<!-- ##### ARG SoupSocket:remote-address ##### -->
<para>
</para>
@@ -110,27 +97,27 @@
@Returns:
-<!-- ##### FUNCTION soup_socket_connect ##### -->
+<!-- ##### USER_FUNCTION SoupSocketCallback ##### -->
<para>
</para>
@sock:
- remote_addr:
- Returns:
+ status:
+ user_data:
-<!-- ##### FUNCTION soup_socket_listen ##### -->
+<!-- ##### FUNCTION soup_socket_connect_async ##### -->
<para>
</para>
@sock:
- local_addr:
- Returns:
+ callback:
+ user_data:
-<!-- ##### FUNCTION soup_socket_start_ssl ##### -->
+<!-- ##### FUNCTION soup_socket_connect_sync ##### -->
<para>
</para>
@@ -139,87 +126,48 @@
@Returns:
-<!-- ##### FUNCTION soup_socket_start_proxy_ssl ##### -->
+<!-- ##### FUNCTION soup_socket_listen ##### -->
<para>
</para>
@sock:
- ssl_host:
@Returns:
-<!-- ##### FUNCTION soup_socket_disconnect ##### -->
+<!-- ##### FUNCTION soup_socket_start_ssl ##### -->
<para>
</para>
@sock:
+ Returns:
-<!-- ##### FUNCTION soup_socket_is_connected ##### -->
+<!-- ##### FUNCTION soup_socket_start_proxy_ssl ##### -->
<para>
</para>
@sock:
+ ssl_host:
@Returns:
-<!-- ##### USER_FUNCTION SoupSocketCallback ##### -->
+<!-- ##### FUNCTION soup_socket_disconnect ##### -->
<para>
</para>
@sock:
- status:
- user_data:
-<!-- ##### USER_FUNCTION SoupSocketListenerCallback ##### -->
+<!-- ##### FUNCTION soup_socket_is_connected ##### -->
<para>
</para>
- listener:
@sock:
- user_data:
-
-
-<!-- ##### FUNCTION soup_socket_client_new_async ##### -->
-<para>
-
-</para>
-
- hostname:
- port:
- ssl_creds:
- callback:
- user_data:
- Returns:
-
-
-<!-- ##### FUNCTION soup_socket_client_new_sync ##### -->
-<para>
-
-</para>
-
- hostname:
- port:
- ssl_creds:
- status_ret:
- Returns:
-
-
-<!-- ##### FUNCTION soup_socket_server_new ##### -->
-<para>
-
-</para>
-
- local_addr:
- ssl_creds:
- callback:
- user_data:
@Returns:
@@ -260,6 +208,7 @@
@buffer:
@len:
@nread:
+ error:
@Returns:
@@ -275,6 +224,7 @@
@boundary_len:
@nread:
@got_boundary:
+ error:
@Returns:
@@ -287,40 +237,43 @@
@buffer:
@len:
@nwrote:
+ error:
@Returns:
-<!-- ##### MACRO SOUP_SOCKET_FLAG_NONBLOCKING ##### -->
+<!-- ##### MACRO SOUP_SSL_ERROR ##### -->
<para>
-An alias for the "non-blocking" property.
+
</para>
-<!-- ##### MACRO SOUP_SOCKET_FLAG_NODELAY ##### -->
+<!-- ##### ENUM SoupSSLError ##### -->
<para>
-An alias for the "nodelay" property.
-</para>
+</para>
+ SOUP_SSL_ERROR_HANDSHAKE_NEEDS_READ:
+ SOUP_SSL_ERROR_HANDSHAKE_NEEDS_WRITE:
+ SOUP_SSL_ERROR_CERTIFICATE:
-<!-- ##### MACRO SOUP_SOCKET_FLAG_REUSEADDR ##### -->
+<!-- ##### MACRO SOUP_SOCKET_LOCAL_ADDRESS ##### -->
<para>
-An alias for the "reuseaddr" property.
+
</para>
-<!-- ##### MACRO SOUP_SOCKET_FLAG_CLOEXEC ##### -->
+<!-- ##### MACRO SOUP_SOCKET_REMOTE_ADDRESS ##### -->
<para>
-An alias for the "cloexec" property.
+
</para>
-<!-- ##### MACRO SOUP_SOCKET_TIMEOUT ##### -->
+<!-- ##### MACRO SOUP_SOCKET_FLAG_NONBLOCKING ##### -->
<para>
-An alias for the "timeout" property.
+An alias for the "non-blocking" property.
</para>
@@ -346,3 +299,10 @@
+<!-- ##### MACRO SOUP_SOCKET_TIMEOUT ##### -->
+<para>
+An alias for the "timeout" property.
+</para>
+
+
+
Modified: branches/libsoup-2.4/docs/reference/tmpl/soup-status.sgml
==============================================================================
--- branches/libsoup-2.4/docs/reference/tmpl/soup-status.sgml (original)
+++ branches/libsoup-2.4/docs/reference/tmpl/soup-status.sgml Sun Jan 6 15:52:42 2008
@@ -17,17 +17,13 @@
<!-- ##### SECTION Stability_Level ##### -->
-<!-- ##### ENUM SoupStatusClass ##### -->
+<!-- ##### MACRO SOUP_STATUS_IS_TRANSPORT_ERROR ##### -->
<para>
</para>
- 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:
+ status:
+
<!-- ##### MACRO SOUP_STATUS_IS_INFORMATIONAL ##### -->
<para>
@@ -150,3 +146,10 @@
@Returns:
+<!-- ##### MACRO SOUP_HTTP_ERROR ##### -->
+<para>
+
+</para>
+
+
+
Modified: branches/libsoup-2.4/docs/reference/tmpl/soup-uri.sgml
==============================================================================
--- branches/libsoup-2.4/docs/reference/tmpl/soup-uri.sgml (original)
+++ branches/libsoup-2.4/docs/reference/tmpl/soup-uri.sgml Sun Jan 6 15:52:42 2008
@@ -20,67 +20,19 @@
<!-- ##### SECTION Stability_Level ##### -->
-<!-- ##### STRUCT SoupUri ##### -->
-<para>
-Note that the <structfield>user</structfield> and
-<structfield>passwd</structfield> fields are <emphasis>not</emphasis>
-the standard mechanism for authentication in
-<application>libsoup</application>. Client-side authentication should
-normally use the <type>SoupSession</type> <link
-linkend="SoupSession-authenticate">authenticate</link> signal
-(although the <type>SoupUri</type> fields are also supported).
-Server-side authentication uses <type>SoupServer</type>'s
-authentication mechanisms and never makes use of the
-<type>SoupUri</type> fields.
-</para>
-
-<para>
-The <structfield>path</structfield> field is never empty or %NULL; if
-a stringified URI is given with no path, the <type>SoupUri</type> form
-has <literal>"/"</literal> as its path. Likewise,
-<structfield>port</structfield> is always filled in, even if it wasn't
-filled in in the stringified URI.
-</para>
-
-<para>
-The <structfield>path</structfield>, <structfield>query</structfield>,
-and <structfield>fragment</structfield> fields may have
-<literal>%</literal>-encoded characters in them; this is because only
-the server that the URI belongs to can say for sure whether
-<literal>"%%2F"</literal> means the same thing as
-<literal>"/"</literal>, or something different. Servers can use
-soup_uri_normalize() to decode characters from the "reserved" set that
-they are not using for reserved purposes.
-</para>
-
- protocol: the URI's protocol, either %SOUP_PROTOCOL_HTTP or %SOUP_PROTOCOL_HTTPS
- user: the username, or %NULL
- passwd: the password, or %NULL
- host: the hostname
- port: the port
- path: the path, possibly "%%-encoded"
- query: the query string, possibly "%%-encoded", or %NULL
- fragment: the fragment identifier, possibly "%%-encoded", or %NULL
-
-<!-- ##### TYPEDEF SoupProtocol ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO SOUP_PROTOCOL_HTTP ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO SOUP_PROTOCOL_HTTPS ##### -->
+<!-- ##### STRUCT SoupURI ##### -->
<para>
</para>
-
+ scheme:
+ user:
+ password:
+ host:
+ port:
+ path:
+ query:
+ fragment:
<!-- ##### FUNCTION soup_uri_new_with_base ##### -->
<para>
@@ -120,15 +72,6 @@
@Returns:
-<!-- ##### FUNCTION soup_uri_copy_root ##### -->
-<para>
-
-</para>
-
- uri:
- Returns:
-
-
<!-- ##### FUNCTION soup_uri_equal ##### -->
<para>
@@ -185,3 +128,12 @@
@Returns:
+<!-- ##### FUNCTION soup_uri_is_https ##### -->
+<para>
+
+</para>
+
+ uri:
+ Returns:
+
+
Added: branches/libsoup-2.4/docs/reference/tmpl/soup-value-utils.sgml
==============================================================================
--- (empty file)
+++ branches/libsoup-2.4/docs/reference/tmpl/soup-value-utils.sgml Sun Jan 6 15:52:42 2008
@@ -0,0 +1,139 @@
+<!-- ##### SECTION Title ##### -->
+GValue Support
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### FUNCTION soup_value_hash_new ##### -->
+<para>
+
+</para>
+
+ Returns:
+
+
+<!-- ##### FUNCTION soup_value_hash_insert_value ##### -->
+<para>
+
+</para>
+
+ hash:
+ key:
+ value:
+
+
+<!-- ##### FUNCTION soup_value_hash_insert ##### -->
+<para>
+
+</para>
+
+ hash:
+ key:
+ type:
+ Varargs:
+
+
+<!-- ##### FUNCTION soup_value_hash_lookup ##### -->
+<para>
+
+</para>
+
+ hash:
+ key:
+ type:
+ Varargs:
+ Returns:
+
+
+<!-- ##### FUNCTION soup_value_array_from_args ##### -->
+<para>
+
+</para>
+
+ args:
+ Returns:
+
+
+<!-- ##### FUNCTION soup_value_array_to_args ##### -->
+<para>
+
+</para>
+
+ array:
+ args:
+ Returns:
+
+
+<!-- ##### FUNCTION soup_value_array_insert ##### -->
+<para>
+
+</para>
+
+ array:
+ index_:
+ type:
+ Varargs:
+
+
+<!-- ##### FUNCTION soup_value_array_append ##### -->
+<para>
+
+</para>
+
+ array:
+ type:
+ Varargs:
+
+
+<!-- ##### FUNCTION soup_value_array_get_nth ##### -->
+<para>
+
+</para>
+
+ array:
+ index_:
+ type:
+ Varargs:
+ Returns:
+
+
+<!-- ##### MACRO SOUP_VALUE_SETV ##### -->
+<para>
+
+</para>
+
+ val:
+ type:
+ args:
+
+
+<!-- ##### MACRO SOUP_VALUE_GETV ##### -->
+<para>
+
+</para>
+
+ val:
+ type:
+ args:
+
+
+<!-- ##### MACRO SOUP_TYPE_BYTE_ARRAY ##### -->
+<para>
+
+</para>
+
+
+
Added: branches/libsoup-2.4/docs/reference/tmpl/soup-xmlrpc.sgml
==============================================================================
--- (empty file)
+++ branches/libsoup-2.4/docs/reference/tmpl/soup-xmlrpc.sgml Sun Jan 6 15:52:42 2008
@@ -0,0 +1,140 @@
+<!-- ##### SECTION Title ##### -->
+XMLRPC Support
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### FUNCTION soup_xmlrpc_build_method_call ##### -->
+<para>
+
+</para>
+
+ method_name:
+ params:
+ n_params:
+ Returns:
+
+
+<!-- ##### FUNCTION soup_xmlrpc_request_new ##### -->
+<para>
+
+</para>
+
+ uri:
+ method_name:
+ Varargs:
+ Returns:
+
+
+<!-- ##### FUNCTION soup_xmlrpc_parse_method_response ##### -->
+<para>
+
+</para>
+
+ method_response:
+ length:
+ value:
+ error:
+ Returns:
+
+
+<!-- ##### FUNCTION soup_xmlrpc_parse_method_call ##### -->
+<para>
+
+</para>
+
+ method_call:
+ length:
+ method_name:
+ params:
+ Returns:
+
+
+<!-- ##### FUNCTION soup_xmlrpc_extract_method_call ##### -->
+<para>
+
+</para>
+
+ method_call:
+ length:
+ method_name:
+ Varargs:
+ Returns:
+
+
+<!-- ##### FUNCTION soup_xmlrpc_build_method_response ##### -->
+<para>
+
+</para>
+
+ value:
+ Returns:
+
+
+<!-- ##### FUNCTION soup_xmlrpc_build_fault ##### -->
+<para>
+
+</para>
+
+ fault_code:
+ fault_format:
+ Varargs:
+ Returns:
+
+
+<!-- ##### FUNCTION soup_xmlrpc_set_response ##### -->
+<para>
+
+</para>
+
+ msg:
+ type:
+ Varargs:
+
+
+<!-- ##### FUNCTION soup_xmlrpc_set_fault ##### -->
+<para>
+
+</para>
+
+ msg:
+ fault_code:
+ fault_format:
+ Varargs:
+
+
+<!-- ##### MACRO SOUP_XMLRPC_ERROR ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### ENUM SoupXMLRPCError ##### -->
+<para>
+
+</para>
+
+ SOUP_XMLRPC_ERROR_ARGUMENTS:
+ SOUP_XMLRPC_ERROR_RETVAL:
+
+<!-- ##### MACRO SOUP_XMLRPC_FAULT ##### -->
+<para>
+
+</para>
+
+
+
Modified: branches/libsoup-2.4/libsoup/soup-auth-domain-basic.c
==============================================================================
--- branches/libsoup-2.4/libsoup/soup-auth-domain-basic.c (original)
+++ branches/libsoup-2.4/libsoup/soup-auth-domain-basic.c Sun Jan 6 15:52:42 2008
@@ -139,7 +139,10 @@
* @optname1: name of first option, or %NULL
* @...: option name/value pairs
*
- * Creates a #SoupAuthDomainBasic
+ * Creates a #SoupAuthDomainBasic. You must set the
+ * %SOUP_AUTH_DOMAIN_REALM parameter, to indicate the realm name to be
+ * returned with the authentication challenge to the client. Other
+ * parameters are optional.
*
* Return value: the new #SoupAuthDomain
**/
@@ -188,7 +191,7 @@
/**
* soup_auth_domain_basic_set_auth_callback:
* @domain: the domain
- * @auth_callback: the callback
+ * @callback: the callback
* @user_data: data to pass to @auth_callback
* @dnotify: destroy notifier to free @user_data when @domain
* is destroyed
@@ -196,7 +199,7 @@
* Sets the callback that @domain will use to authenticate incoming
* requests. For each request containing authorization, @domain will
* invoke the callback, and then either accept or reject the request
- * based on @auth_callback's return value.
+ * based on @callback's return value.
*
* You can also set the auth callback by setting the
* %SOUP_AUTH_DOMAIN_BASIC_AUTH_CALLBACK and
@@ -205,7 +208,7 @@
**/
void
soup_auth_domain_basic_set_auth_callback (SoupAuthDomain *domain,
- SoupAuthDomainBasicAuthCallback auth_callback,
+ SoupAuthDomainBasicAuthCallback callback,
gpointer user_data,
GDestroyNotify dnotify)
{
@@ -215,7 +218,7 @@
if (priv->auth_dnotify)
priv->auth_dnotify (priv->auth_data);
- priv->auth_callback = auth_callback;
+ priv->auth_callback = callback;
priv->auth_data = user_data;
priv->auth_dnotify = dnotify;
}
Modified: branches/libsoup-2.4/libsoup/soup-auth-domain-digest.c
==============================================================================
--- branches/libsoup-2.4/libsoup/soup-auth-domain-digest.c (original)
+++ branches/libsoup-2.4/libsoup/soup-auth-domain-digest.c Sun Jan 6 15:52:42 2008
@@ -139,6 +139,18 @@
}
}
+/**
+ * soup_auth_domain_digest_new:
+ * @optname1: name of first option, or %NULL
+ * @...: option name/value pairs
+ *
+ * Creates a #SoupAuthDomainDigest. You must set the
+ * %SOUP_AUTH_DOMAIN_REALM parameter, to indicate the realm name to be
+ * returned with the authentication challenge to the client. Other
+ * parameters are optional.
+ *
+ * Return value: the new #SoupAuthDomain
+ **/
SoupAuthDomain *
soup_auth_domain_digest_new (const char *optname1, ...)
{
@@ -174,7 +186,7 @@
/**
* soup_auth_domain_digest_set_auth_callback:
* @domain: the domain
- * @auth_callback: the callback
+ * @callback: the callback
* @user_data: data to pass to @auth_callback
* @dnotify: destroy notifier to free @user_data when @domain
* is destroyed
@@ -182,7 +194,7 @@
* Sets the callback that @domain will use to authenticate incoming
* requests. For each request containing authorization, @domain will
* invoke the callback, and then either accept or reject the request
- * based on @auth_callback's return value.
+ * based on @callback's return value.
*
* You can also set the auth callback by setting the
* %SOUP_AUTH_DOMAIN_DIGEST_AUTH_CALLBACK and
@@ -191,7 +203,7 @@
**/
void
soup_auth_domain_digest_set_auth_callback (SoupAuthDomain *domain,
- SoupAuthDomainDigestAuthCallback auth_callback,
+ SoupAuthDomainDigestAuthCallback callback,
gpointer user_data,
GDestroyNotify dnotify)
{
Modified: branches/libsoup-2.4/libsoup/soup-auth.c
==============================================================================
--- branches/libsoup-2.4/libsoup/soup-auth.c (original)
+++ branches/libsoup-2.4/libsoup/soup-auth.c Sun Jan 6 15:52:42 2008
@@ -168,6 +168,9 @@
* Creates a new #SoupAuth of type @type with the information from
* @msg and @auth_header.
*
+ * This is called by #SoupSession; you will normally not create auths
+ * yourself.
+ *
* Return value: the new #SoupAuth, or %NULL if it could not be
* created
**/
@@ -223,7 +226,8 @@
* @auth_header: the WWW-Authenticate/Proxy-Authenticate header
*
* Updates @auth with the information from @msg and @auth_header,
- * possibly un-authenticating it.
+ * possibly un-authenticating it. As with soup_auth_new(), this is
+ * normally only used by #SoupSession.
*
* Return value: %TRUE if @auth is still a valid (but potentially
* unauthenticated) #SoupAuth. %FALSE if something about @auth_params
@@ -306,7 +310,7 @@
* soup_auth_get_scheme_name:
* @auth: a #SoupAuth
*
- * Returns @auth's scheme name. (Eg, "Basic")
+ * Returns @auth's scheme name. (Eg, "Basic", "Digest", or "NTLM")
*
* Return value: the scheme name
**/
@@ -339,7 +343,10 @@
* soup_auth_get_realm:
* @auth: a #SoupAuth
*
- * Returns @auth's realm.
+ * Returns @auth's realm. This is an identifier that distinguishes
+ * separate authentication spaces on a given server, and may be some
+ * string that is meaningful to the user. (Although it is probably not
+ * localized.)
*
* Return value: the realm name
**/
@@ -355,10 +362,10 @@
* soup_auth_get_info:
* @auth: a #SoupAuth
*
- * Gets an identifier for @auth. #SoupAuth objects from the same
- * server with the same identifier refer to the same authentication
- * domain (eg, the URLs associated with them take the same usernames
- * and passwords).
+ * Gets an opaque identifier for @auth, for use as a hash key or the
+ * like. #SoupAuth objects from the same server with the same
+ * identifier refer to the same authentication domain (eg, the URLs
+ * associated with them take the same usernames and passwords).
*
* Return value: the identifier
**/
Modified: branches/libsoup-2.4/libsoup/soup-message-headers.c
==============================================================================
--- branches/libsoup-2.4/libsoup/soup-message-headers.c (original)
+++ branches/libsoup-2.4/libsoup/soup-message-headers.c Sun Jan 6 15:52:42 2008
@@ -30,7 +30,9 @@
* soup_message_headers_new:
* @type: the type of headers
*
- * Creates a #SoupMessageHeaders
+ * Creates a #SoupMessageHeaders. (#SoupMessage does this
+ * automatically for its own headers. You would only need to use this
+ * method if you are manually parsing or generating message headers.)
*
* Return value: a new #SoupMessageHeaders
**/
@@ -215,6 +217,15 @@
}
/**
+ * SoupMessageHeadersForeachFunc:
+ * @name: the header name
+ * @value: the header value
+ * @user_data: the data passed to soup_message_headers_foreach()
+ *
+ * The callback passed to soup_message_headers_foreach().
+ **/
+
+/**
* soup_message_headers_foreach:
* @hdrs: a #SoupMessageHeaders
* @func: callback function to run for each header
@@ -480,8 +491,15 @@
* @hdrs: a #SoupMessageHeaders
* @expectations: the expectations to set
*
- * Sets @hdrs's "Expect" header according to @expectations. Currently
- * %SOUP_EXPECTATION_CONTINUE is the only known expectation value.
+ * Sets @hdrs's "Expect" header according to @expectations.
+ *
+ * Currently %SOUP_EXPECTATION_CONTINUE is the only known expectation
+ * value. You should set this value on a request if you are sending a
+ * large message body (eg, via POST or PUT), and want to give the
+ * server a chance to reject the request after seeing just the headers
+ * (eg, because it will require authentication before allowing you to
+ * post). This saves you from having to transmit the large request
+ * body when the server is just going to ignore it anyway.
**/
void
soup_message_headers_set_expectations (SoupMessageHeaders *hdrs,
Modified: branches/libsoup-2.4/libsoup/soup-message.c
==============================================================================
--- branches/libsoup-2.4/libsoup/soup-message.c (original)
+++ branches/libsoup-2.4/libsoup/soup-message.c Sun Jan 6 15:52:42 2008
@@ -234,9 +234,9 @@
* the signal emission will be stopped, and @msg's connection
* will be closed. (If you need to requeue a message--eg,
* after handling authentication or redirection--it is usually
- * better to requeue it from a ::got-body handler rather than
- * a ::got-header handler, so that the existing HTTP
- * connection can be reused.)
+ * better to requeue it from a #SoupMessage::got_body handler
+ * rather than a #SoupMessage::got_header handler, so that the
+ * existing HTTP connection can be reused.)
**/
signals[GOT_HEADERS] =
g_signal_new ("got_headers",
@@ -323,8 +323,8 @@
* @msg: the message
*
* Emitted when all HTTP processing is finished for a message.
- * (After ::got-body for client-side messages, or after
- * ::wrote-body for server-side messages.)
+ * (After #SoupMessage::got_body for client-side messages, or
+ * after #SoupMessage::wrote_body for server-side messages.)
**/
signals[FINISHED] =
g_signal_new ("finished",
@@ -503,8 +503,8 @@
* @req_body: a data buffer containing the body of the message request.
* @req_length: the byte length of @req_body.
*
- * Convenience function to set the request body of a #SoupMessage.
- * If @content_type is %NULL, the request body will be cleared.
+ * Convenience function to set the request body of a #SoupMessage. If
+ * @content_type is %NULL, the request body must be empty as well.
*/
void
soup_message_set_request (SoupMessage *msg,
@@ -536,8 +536,8 @@
* @resp_body: a data buffer containing the body of the message response.
* @resp_length: the byte length of @resp_body.
*
- * Convenience function to set the response body of a #SoupMessage.
- * If @content_type is %NULL, the response body will be cleared.
+ * Convenience function to set the response body of a #SoupMessage. If
+ * @content_type is %NULL, the response body must be empty as well.
*/
void
soup_message_set_response (SoupMessage *msg,
@@ -798,7 +798,7 @@
* g_signal_connect(). However, @callback will only be run if @msg has
* a header named @header.
*
- * If @signal is one of the "got" signals (eg, "got_headers"),
+ * If @signal is one of the "got" signals (eg, "got_headers"), or
* "finished" or "restarted", then @header is matched against the
* incoming message headers (that is, the #request_headers for a
* client #SoupMessage, or the #response_headers for a server
@@ -1090,7 +1090,8 @@
* @msg: a #SoupMessage
*
* Determines whether or not @msg's connection can be kept alive for
- * further requests after processing @msg.
+ * further requests after processing @msg, based on the HTTP version,
+ * Connection header, etc.
*
* Return value: %TRUE or %FALSE.
**/
Modified: branches/libsoup-2.4/libsoup/soup-message.h
==============================================================================
--- branches/libsoup-2.4/libsoup/soup-message.h (original)
+++ branches/libsoup-2.4/libsoup/soup-message.h Sun Jan 6 15:52:42 2008
@@ -25,13 +25,29 @@
* @method: the HTTP method
* @status_code: the HTTP status code
* @reason_phrase: the status phrase associated with @status_code
- * @request: the request buffer
+ * @request_body: the request body
* @request_headers: the request headers
- * @response: the response buffer
+ * @response_body: the response body
* @response_headers: the response headers
- * @status: the processing status of the message
*
* Represents an HTTP message being sent or received.
+ *
+ * As described in the #SoupMessageBody documentation, the
+ * @request_body and @response_body %data fields will not necessarily
+ * be filled in at all times. When they are filled in, they will be
+ * terminated with a '\0' byte (which is not included in the %length),
+ * so you can use them as ordinary C strings (assuming that you know
+ * that the body doesn't have any other '\0' bytes).
+ *
+ * For a client-side #SoupMessage, @request_body's %data is usually
+ * filled in right before libsoup writes the request to the network,
+ * but you should not count on this; use soup_message_body_flatten()
+ * if you want to ensure that %data is filled in. @response_body's
+ * %data will be filled in before #SoupMessage::finished is emitted,
+ * unless you set the %SOUP_MESSAGE_OVERWRITE_CHUNKS flag.
+ *
+ * For a server-side #SoupMessage, @request_body's %data will be
+ * filled in before #SoupMessage::got_body is emitted.
**/
struct SoupMessage {
GObject parent;
Modified: branches/libsoup-2.4/libsoup/soup-misc.h
==============================================================================
--- branches/libsoup-2.4/libsoup/soup-misc.h (original)
+++ branches/libsoup-2.4/libsoup/soup-misc.h Sun Jan 6 15:52:42 2008
@@ -45,6 +45,16 @@
**/
extern gboolean soup_ssl_supported;
+#define SOUP_SSL_ERROR soup_ssl_error_quark()
+
+GQuark soup_ssl_error_quark (void);
+
+typedef enum {
+ SOUP_SSL_ERROR_HANDSHAKE_NEEDS_READ,
+ SOUP_SSL_ERROR_HANDSHAKE_NEEDS_WRITE,
+ SOUP_SSL_ERROR_CERTIFICATE,
+} SoupSSLError;
+
G_END_DECLS
#endif /* SOUP_MISC_H */
Modified: branches/libsoup-2.4/libsoup/soup-server.c
==============================================================================
--- branches/libsoup-2.4/libsoup/soup-server.c (original)
+++ branches/libsoup-2.4/libsoup/soup-server.c Sun Jan 6 15:52:42 2008
@@ -5,10 +5,6 @@
* Copyright (C) 2001-2003, Ximian, Inc.
*/
-/*
- * FIXME: Split into SoupServerTCP and SoupServerCGI subclasses
- */
-
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
@@ -412,6 +408,13 @@
}
}
+/**
+ * soup_server_new:
+ * @optname1: name of first property to set
+ * @...: value of @optname1, followed by additional property/value pairs
+ *
+ * Creates a new #SoupServer.
+ **/
SoupServer *
soup_server_new (const char *optname1, ...)
{
@@ -426,6 +429,16 @@
return server;
}
+/**
+ * soup_server_get_port:
+ * @server: a #SoupServer
+ *
+ * Gets the TCP port that @server is listening on. This is most useful
+ * when you did not request a specific port (or explicitly requested
+ * %SOUP_ADDRESS_ANY_PORT).
+ *
+ * Return value: the port @server is listening on.
+ **/
guint
soup_server_get_port (SoupServer *server)
{
@@ -434,6 +447,18 @@
return SOUP_SERVER_GET_PRIVATE (server)->port;
}
+/**
+ * soup_server_is_https:
+ * @server: a #SoupServer
+ *
+ * Checks whether @server is running plain http or https.
+ *
+ * In order for a server to run https, you must set the
+ * %SOUP_SERVER_SSL_CERT_FILE and %SOUP_SERVER_SSL_KEY_FILE properties
+ * to provide it with an SSL certificate to use.
+ *
+ * Return value: %TRUE if @server is serving https.
+ **/
gboolean
soup_server_is_https (SoupServer *server)
{
@@ -445,6 +470,16 @@
return (priv->ssl_cert_file && priv->ssl_key_file);
}
+/**
+ * soup_server_get_listener:
+ * @server: a #SoupServer
+ *
+ * Gets @server's listening socket. You should treat this as
+ * read-only; writing to it or modifiying it may cause @server to
+ * malfunction.
+ *
+ * Return value: the listening socket.
+ **/
SoupSocket *
soup_server_get_listener (SoupServer *server)
{
@@ -634,6 +669,22 @@
start_request (server, sock);
}
+/**
+ * soup_server_run_async:
+ * @server: a #SoupServer
+ *
+ * Starts @server, causing it to listen for and process incoming
+ * connections.
+ *
+ * The server actually runs in @server's #GMainContext. It will not
+ * actually perform any processing unless the appropriate main loop is
+ * running. In the simple case where you did not set the server's
+ * %SOUP_SERVER_ASYNC_CONTEXT property, this means the server will run
+ * whenever the glib main loop is running.
+ *
+ * soup_server_run_async() refs @server, so you should run
+ * soup_server_quit() to unref it when you are done.
+ **/
void
soup_server_run_async (SoupServer *server)
{
@@ -658,6 +709,15 @@
}
+/**
+ * soup_server_run:
+ * @server: a #SoupServer
+ *
+ * Starts @server, causing it to listen for and process incoming
+ * connections. Unlike soup_server_run_async(), this creates a
+ * #GMainLoop and runs it, and it will not return until someone calls
+ * soup_server_quit() to stop the server.
+ **/
void
soup_server_run (SoupServer *server)
{
@@ -675,6 +735,16 @@
g_main_loop_run (priv->loop);
}
+/**
+ * soup_server_quit:
+ * @server: a #SoupServer
+ *
+ * Stops processing for @server. Call this to clean up after
+ * soup_server_run_async(), or to terminate a call to soup_server_run().
+ *
+ * @server is still in a working state after this call; you can start
+ * and stop a server as many times as you want.
+ **/
void
soup_server_quit (SoupServer *server)
{
@@ -713,6 +783,16 @@
return priv->async_context;
}
+/**
+ * soup_client_context_get_address:
+ * @context: a #SoupClientContext
+ *
+ * Retrieves the #SoupAddress associated with the remote end
+ * of a connection.
+ *
+ * Return value: the #SoupAddress associated with the remote end of a
+ * connection.
+ **/
SoupAddress *
soup_client_context_get_address (SoupClientContext *context)
{
@@ -721,6 +801,18 @@
return soup_socket_get_remote_address (context->sock);
}
+/**
+ * soup_client_context_get_host:
+ * @context: a #SoupClientContext
+ *
+ * Retrieves the IP address associated with the remote end of a
+ * connection. (If you want the actual hostname, you'll have to call
+ * soup_client_context_get_address() and then call the appropriate
+ * #SoupAddress method to resolve it.)
+ *
+ * Return value: the IP address associated with the remote end of a
+ * connection.
+ **/
const char *
soup_client_context_get_host (SoupClientContext *context)
{
@@ -730,6 +822,69 @@
return soup_address_get_physical (address);
}
+/**
+ * SoupServerCallback:
+ * @server: the #SoupServer
+ * @msg: the message being processed
+ * @path: the path component of @msg's Request-URI
+ * @query: the parsed query component of @msg's Request-URI
+ * @context: additional contextual information about the client
+ * @user_data: the data passed to @soup_server_add_handler
+ *
+ * A callback used to handle requests to a #SoupServer. The callback
+ * will be invoked after receiving the request body; @msg's %method,
+ * %request_headers, and %request_body fields will be filled in.
+ *
+ * @path contains the request path, and @query contains the "query"
+ * component of the Request-URI, parsed according to the rules for
+ * HTML form handling. (Although this is the only commonly-used query
+ * format in HTTP, there is nothing that actually requires that HTTP
+ * request queries use this format; if your server needs to use some
+ * other format, you can just ignore @query, and call
+ * soup_message_get_uri() and parse the uri's query field yourself.)
+ *
+ * At a minimum, the callback must call soup_message_set_status() (or
+ * soup_message_set_status_full()) on @msg to set the response status
+ * code. Additionally, the handler may need to set response headers
+ * and/or fill in the response body.
+ *
+ * If the callback cannot fully fill in the response before returning
+ * (eg, if it needs to wait for information from a database, or
+ * another network server), it should call soup_server_pause_message()
+ * to tell #SoupServer to not send the response right away. When the
+ * response is ready, call soup_server_unpause_message() to cause it
+ * to be sent.
+ *
+ * To send the response body a bit at a time using "chunked" encoding,
+ * first call soup_message_headers_set_encoding() to set
+ * %SOUP_ENCODING_CHUNKED on the %response_headers. Then call
+ * soup_message_body_append() (or soup_message_body_append_buffer())
+ * to append each chunk as it becomes ready, and
+ * soup_server_unpause_message() to make sure it's running. (The
+ * server will automatically pause the message if it is using chunked
+ * encoding but no more chunks are available.) When you are done, call
+ * soup_message_body_complete() to indicate that no more chunks are
+ * coming.
+ **/
+typedef void (*SoupServerCallback) (SoupServer *server,
+ SoupMessage *msg,
+ const char *path,
+ GHashTable *query,
+ SoupClientContext *context,
+ gpointer user_data);
+
+/**
+ * soup_server_add_handler:
+ * @server: a #SoupServer
+ * @path: the toplevel path for the handler
+ * @callback: callback to invoke for requests under @path
+ * @destroy: destroy notifier to free @user_data
+ * @user_data: data for @callback
+ *
+ * Adds a handler to @server for requests under @path. See the
+ * documentation for #SoupServerCallback for information about
+ * how callbacks should behave.
+ **/
void
soup_server_add_handler (SoupServer *server,
const char *path,
@@ -764,6 +919,13 @@
handler->destroy (handler->user_data);
}
+/**
+ * soup_server_remove_handler:
+ * @server: a #SoupServer
+ * @path: the toplevel path for the handler
+ *
+ * Removes the handler registered at @path.
+ **/
void
soup_server_remove_handler (SoupServer *server, const char *path)
{
@@ -789,6 +951,23 @@
}
}
+/**
+ * soup_server_add_auth_domain:
+ * @server: a #SoupServer
+ * @auth_domain: a #SoupAuthDomain
+ *
+ * Adds an authentication domain to @server. Each auth domain will
+ * have the chance to require authentication for each request that
+ * comes in; normally auth domains will require authentication for
+ * requests on certain paths that they have been set up to watch, or
+ * that meet other criteria set by the caller. If an auth domain
+ * determines that a request requires authentication (and the request
+ * doesn't contain authentication), @server will automatically reject
+ * the request with an appropriate status (401 Unauthorized or 407
+ * Proxy Authentication Required). If the request used the
+ * "100-continue" Expectation, @server will reject it before the
+ * request body is sent.
+ **/
void
soup_server_add_auth_domain (SoupServer *server, SoupAuthDomain *auth_domain)
{
@@ -800,6 +979,13 @@
priv->auth_domains = g_slist_prepend (priv->auth_domains, auth_domain);
}
+/**
+ * soup_server_remove_auth_domain:
+ * @server: a #SoupServer
+ * @auth_domain: a #SoupAuthDomain
+ *
+ * Removes @auth_domain from @server.
+ **/
void
soup_server_remove_auth_domain (SoupServer *server, SoupAuthDomain *auth_domain)
{
Modified: branches/libsoup-2.4/libsoup/soup-server.h
==============================================================================
--- branches/libsoup-2.4/libsoup/soup-server.h (original)
+++ branches/libsoup-2.4/libsoup/soup-server.h Sun Jan 6 15:52:42 2008
@@ -59,16 +59,16 @@
SoupServer *soup_server_new (const char *optname1,
...) G_GNUC_NULL_TERMINATED;
-gboolean soup_server_is_https (SoupServer *serv);
-guint soup_server_get_port (SoupServer *serv);
+gboolean soup_server_is_https (SoupServer *server);
+guint soup_server_get_port (SoupServer *server);
-SoupSocket *soup_server_get_listener (SoupServer *serv);
+SoupSocket *soup_server_get_listener (SoupServer *server);
-void soup_server_run (SoupServer *serv);
-void soup_server_run_async (SoupServer *serv);
-void soup_server_quit (SoupServer *serv);
+void soup_server_run (SoupServer *server);
+void soup_server_run_async (SoupServer *server);
+void soup_server_quit (SoupServer *server);
-GMainContext *soup_server_get_async_context (SoupServer *serv);
+GMainContext *soup_server_get_async_context (SoupServer *server);
/* Handlers and auth */
Modified: branches/libsoup-2.4/libsoup/soup-ssl.h
==============================================================================
--- branches/libsoup-2.4/libsoup/soup-ssl.h (original)
+++ branches/libsoup-2.4/libsoup/soup-ssl.h Sun Jan 6 15:52:42 2008
@@ -8,13 +8,6 @@
#include <glib.h>
-/**
- * SoupSSLType:
- * @SOUP_SSL_TYPE_CLIENT: the client side of an SSL connection
- * @SOUP_SSL_TYPE_SERVER: the server side of an SSL connection
- *
- * What kind of SSL connection this is.
- **/
typedef enum {
SOUP_SSL_TYPE_CLIENT = 0,
SOUP_SSL_TYPE_SERVER
@@ -34,14 +27,4 @@
const char *remote_host,
SoupSSLCredentials *creds);
-#define SOUP_SSL_ERROR soup_ssl_error_quark()
-
-GQuark soup_ssl_error_quark (void);
-
-typedef enum {
- SOUP_SSL_ERROR_HANDSHAKE_NEEDS_READ,
- SOUP_SSL_ERROR_HANDSHAKE_NEEDS_WRITE,
- SOUP_SSL_ERROR_CERTIFICATE,
-} SoupSocketError;
-
#endif /* SOUP_SSL_H */
Modified: branches/libsoup-2.4/libsoup/soup-status.c
==============================================================================
--- branches/libsoup-2.4/libsoup/soup-status.c (original)
+++ branches/libsoup-2.4/libsoup/soup-status.c Sun Jan 6 15:52:42 2008
@@ -90,6 +90,10 @@
*
* Looks up the stock HTTP description of @status_code.
*
+ * You should not need to use this; if you are interested in the
+ * textual description for the %status_code of a given #SoupMessage,
+ * just look at the message's %reason_phrase.
+ *
* Return value: the (English) description of @status_code
**/
const char *
Modified: branches/libsoup-2.4/libsoup/soup-status.h
==============================================================================
--- branches/libsoup-2.4/libsoup/soup-status.h (original)
+++ branches/libsoup-2.4/libsoup/soup-status.h Sun Jan 6 15:52:42 2008
@@ -13,27 +13,6 @@
G_BEGIN_DECLS
/**
- * SoupStatusClass:
- * @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
- *
- * The classes of HTTP and Soup status codes
- **/
-typedef enum {
- SOUP_STATUS_CLASS_TRANSPORT_ERROR = 0,
- SOUP_STATUS_CLASS_INFORMATIONAL,
- SOUP_STATUS_CLASS_SUCCESS,
- SOUP_STATUS_CLASS_REDIRECT,
- SOUP_STATUS_CLASS_CLIENT_ERROR,
- SOUP_STATUS_CLASS_SERVER_ERROR
-} SoupStatusClass;
-
-/**
* SOUP_STATUS_IS_TRANSPORT_ERROR:
* @status: a status code
*
Modified: branches/libsoup-2.4/libsoup/soup-xmlrpc.c
==============================================================================
--- branches/libsoup-2.4/libsoup/soup-xmlrpc.c (original)
+++ branches/libsoup-2.4/libsoup/soup-xmlrpc.c Sun Jan 6 15:52:42 2008
@@ -115,11 +115,11 @@
/**
* soup_xmlrpc_build_method_call:
- * @method: the name of the XML-RPC method
+ * @method_name: the name of the XML-RPC method
* @params: arguments to @method
* @n_params: length of @params
*
- * This creates an XML-RPC <methodCall> and returns it as a string.
+ * This creates an XML-RPC methodCall and returns it as a string.
* This is the low-level method that soup_xmlrpc_request_new() and
* soup_xmlrpc_call() are built on.
*
@@ -141,7 +141,7 @@
* For structs, use a #GHashTable that maps strings to #GValue;
* soup_value_hash_new() and related methods can help with this.
*
- * Return value: the text of the <methodCall>, or %NULL on error
+ * Return value: the text of the methodCall, or %NULL on error
**/
char *
soup_xmlrpc_build_method_call (const char *method_name,
@@ -205,10 +205,10 @@
/**
* soup_xmlrpc_request_new:
* @uri: URI of the XML-RPC service
- * @method: the name of the XML-RPC method to invoke at @uri
+ * @method_name: the name of the XML-RPC method to invoke at @uri
* @...: parameters for @method
*
- * Creates an XML-RPC <methodCall> and returns a #SoupMessage, ready
+ * Creates an XML-RPC methodCall and returns a #SoupMessage, ready
* to send, for that method call.
*
* The parameters are passed as type/value pairs; ie, first a #GType,
@@ -234,14 +234,14 @@
* soup_xmlrpc_build_method_response:
* @value: the return value
*
- * This creates a (successful) XML-RPC <methodResponse> and returns it
- * as a string. To create a <fault> response, use
+ * This creates a (successful) XML-RPC methodResponse and returns it
+ * as a string. To create a fault response, use
* soup_xmlrpc_build_fault().
*
* The glib type to XML-RPC type mapping is as with
* soup_xmlrpc_build_method_call(), qv.
*
- * Return value: the text of the <methodResponse>, or %NULL on error
+ * Return value: the text of the methodResponse, or %NULL on error
**/
char *
soup_xmlrpc_build_method_response (GValue *value)
@@ -329,11 +329,11 @@
* @fault_format: a printf()-style format string
* @...: the parameters to @fault_format
*
- * This creates an XML-RPC <fault> response and returns it as a
- * string. (To create a successful response, use
+ * This creates an XML-RPC fault response and returns it as a string.
+ * (To create a successful response, use
* soup_xmlrpc_build_method_response().)
*
- * Return value: the text of the <fault>
+ * Return value: the text of the fault
**/
char *
soup_xmlrpc_build_fault (int fault_code, const char *fault_format, ...)
@@ -534,9 +534,9 @@
/**
* soup_xmlrpc_parse_method_call:
- * @method_call: the XML-RPC <methodCall> string
+ * @method_call: the XML-RPC methodCall string
* @length: the length of @method_call, or -1 if it is NUL-terminated
- * @method_name: on return, the <methodName> from @method_call
+ * @method_name: on return, the methodName from @method_call
* @params: on return, the parameters from @method_call
*
* Parses @method_call to get the name and parameters, and returns the
@@ -599,9 +599,9 @@
/**
* soup_xmlrpc_extract_method_call:
- * @method_call: the XML-RPC <methodCall> string
+ * @method_call: the XML-RPC methodCall string
* @length: the length of @method_call, or -1 if it is NUL-terminated
- * @method_name: on return, the <methodName> from @method_call
+ * @method_name: on return, the methodName from @method_call
* @...: return types and locations for parameters
*
* Parses @method_call to get the name and parameters, and puts
@@ -639,13 +639,13 @@
/**
* soup_xmlrpc_parse_method_response:
- * @method_response: the XML-RPC <methodResponse> string
+ * @method_response: the XML-RPC methodResponse string
* @length: the length of @method_response, or -1 if it is NUL-terminated
* @value: on return, the return value from @method_call
* @error: error return value
*
* Parses @method_response and returns the return value in @value. If
- * @method_response is a <fault>, @value will be unchanged, and @error
+ * @method_response is a fault, @value will be unchanged, and @error
* will be set to an error of type %SOUP_XMLRPC_FAULT, with the error
* #code containing the fault code, and the error #message containing
* the fault string. (If @method_response cannot be parsed at all,
@@ -653,7 +653,7 @@
* will be unset.)
*
* Return value: %TRUE if a return value was parsed, %FALSE if the
- * response could not be parsed, or contained a <fault>.
+ * response could not be parsed, or contained a fault.
**/
gboolean
soup_xmlrpc_parse_method_response (const char *method_response, int length,
@@ -720,7 +720,7 @@
/**
* soup_xmlrpc_extract_method_response:
- * @method_response: the XML-RPC <methodResponse> string
+ * @method_response: the XML-RPC methodResponse string
* @length: the length of @method_response, or -1 if it is NUL-terminated
* @error: error return value
* @type: the expected type of the return value
@@ -729,7 +729,7 @@
* Parses @method_response and extracts the return value into
* a variable of the correct type.
*
- * If @method_response is a <fault>, the return value will be unset,
+ * If @method_response is a fault, the return value will be unset,
* and @error will be set to an error of type %SOUP_XMLRPC_FAULT, with
* the error #code containing the fault code, and the error #message
* containing the fault string. (If @method_response cannot be parsed
@@ -737,7 +737,7 @@
* but @error will be unset.)
*
* Return value: %TRUE if a return value was parsed, %FALSE if the
- * response was of the wrong type, or contained a <fault>.
+ * response was of the wrong type, or contained a fault.
**/
gboolean
soup_xmlrpc_extract_method_response (const char *method_response, int length,
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
