diff options
| author | Dan Winship <danw@src.gnome.org> | 2003-11-18 20:15:22 +0000 |
|---|---|---|
| committer | Dan Winship <danw@src.gnome.org> | 2003-11-18 20:15:22 +0000 |
| commit | f5a7c02f466a26b78441b8fcbc216c9eaafbb774 (patch) | |
| tree | 8483603d7b4171fac773df068bf052ae969bafd5 | |
| parent | 588629232270b34680ef453c2c13392c9ccdd3d5 (diff) | |
| download | libsoup-f5a7c02f466a26b78441b8fcbc216c9eaafbb774.tar.gz libsoup-f5a7c02f466a26b78441b8fcbc216c9eaafbb774.tar.bz2 libsoup-f5a7c02f466a26b78441b8fcbc216c9eaafbb774.zip | |
Replace old gtk-doc test with GTK_DOC_CHECK() (AC_OUTPUT): add
* configure.in: Replace old gtk-doc test with GTK_DOC_CHECK()
(AC_OUTPUT): add docs/Makefile, docs/reference/Makefile
* autogen.sh (REQUIRED_AUTOMAKE_VERSION): 1.6, for gtk-doc.make
* Makefile.am: updates for gtk-doc
(SUBDIRS): add back "docs"
* docs/Makefile.am (EXTRA_DIST): remove, since those old docs
aren't around any more
* docs/reference/*: set up gtk-doc
* libsoup/Makefile.am (INCLUDES): Change G_LOG_DOMAIN to
"libsoup". Remove unused defines.
* libsoup/soup-connection.c: Fix doc comments
* libsoup/soup-message.c: Likewise
* libsoup/soup-misc.c: Likewise
* libsoup/soup-socket.c: Likewise
* libsoup/soup-uri.c: Likewise
* libsoup/soup-address.h: Fixes to please gtk-doc
* libsoup/soup-connection.h: Likewise
* libsoup/soup-message.h: Likewise
* libsoup/soup-message-private.h: Likewise
* libsoup/soup-misc.h: Likewise
* libsoup/soup-server-auth.h: Likewise
* libsoup/soup-socket.h: Likewise
* libsoup/soup-status.h: Likewise
39 files changed, 3885 insertions, 775 deletions
@@ -1,5 +1,18 @@ 2003-11-18 Dan Winship <danw@ximian.com> + * configure.in: Replace old gtk-doc test with GTK_DOC_CHECK() + (AC_OUTPUT): add docs/Makefile, docs/reference/Makefile + + * autogen.sh (REQUIRED_AUTOMAKE_VERSION): 1.6, for gtk-doc.make + + * Makefile.am: updates for gtk-doc + (SUBDIRS): add back "docs" + + * docs/Makefile.am (EXTRA_DIST): remove, since those old docs + aren't around any more + + * docs/reference/*: set up gtk-doc + * libsoup/Makefile.am (INCLUDES): Change G_LOG_DOMAIN to "libsoup". Remove unused defines. @@ -16,6 +29,7 @@ * libsoup/soup-misc.h: Likewise * libsoup/soup-server-auth.h: Likewise * libsoup/soup-socket.h: Likewise + * libsoup/soup-status.h: Likewise 2003-11-18 Dan Winship <danw@ximian.com> diff --git a/Makefile.am b/Makefile.am index f7fc3098..16e2fefc 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,8 +1,11 @@ ## Process this file with automake to produce Makefile.in +AUTOMAKE_OPTIONS = 1.6 -SUBDIRS = libsoup tests +SUBDIRS = libsoup tests docs -EXTRA_DIST = libsoup-$(SOUP_API_VERSION).pc.in +EXTRA_DIST = libsoup-$(SOUP_API_VERSION).pc.in gtk-doc.make + +DISTCHECK_CONFIGURE_FLAGS = --enable-gtk-doc pkgconfigdir = $(libdir)/pkgconfig pkgconfig_DATA = libsoup-$(SOUP_API_VERSION).pc @@ -5,6 +5,7 @@ srcdir=`dirname $0` test -z "$srcdir" && srcdir=. PKG_NAME="libsoup" +REQUIRED_AUTOMAKE_VERSION=1.6 (test -f $srcdir/configure.in \ && test -f $srcdir/ChangeLog \ diff --git a/configure.in b/configure.in index b9bc653d..b14cf0e7 100644 --- a/configure.in +++ b/configure.in @@ -240,44 +240,10 @@ fi AC_SUBST(GNUTLS_CFLAGS) AC_SUBST(GNUTLS_LIBS) -dnl ********************************************* -dnl *** Checks for gtk-doc (lifted from glib) *** -dnl ********************************************* - -AC_ARG_WITH(html-dir, [ --with-html-dir=PATH Path to installed docs ]) - -if test "x$with_html_dir" = "x" ; then - HTML_DIR='${datadir}/gtk-doc/html' -else - HTML_DIR=$with_html_dir -fi - -AC_SUBST(HTML_DIR) - -AC_CHECK_PROG(GTKDOC, gtkdoc-mkdb, true, false) -AM_CONDITIONAL(HAVE_GTK_DOC, $GTKDOC) -AC_SUBST(HAVE_GTK_DOC) - -AC_CHECK_PROG(DB2HTML, db2html, true, false) -AM_CONDITIONAL(HAVE_DOCBOOK, $DB2HTML) - -dnl Let people disable the gtk-doc stuff. -AC_ARG_ENABLE(gtk-doc, - [ --enable-gtk-doc Use gtk-doc to build documentation [default=auto]], - enable_gtk_doc="$enableval", - enable_gtk_doc=auto) - -if test x$enable_gtk_doc = xauto ; then - if test x$GTKDOC = xtrue ; then - enable_gtk_doc=yes - else - enable_gtk_doc=no - fi -fi - -dnl NOTE: We need to use a separate automake conditional for this -dnl to make this work with the tarballs. -AM_CONDITIONAL(ENABLE_GTK_DOC, test x$enable_gtk_doc = xyes) +dnl *************** +dnl *** gtk-doc *** +dnl *************** +GTK_DOC_CHECK([1.0]) dnl ************************************* @@ -306,16 +272,6 @@ AC_OUTPUT([ Makefile libsoup/Makefile tests/Makefile + docs/Makefile + docs/reference/Makefile ]) - -echo " - -Configuration: - - Source code location: ${srcdir} - Compiler: ${CC} - Build flags: ${CFLAGS} ${SOUP_DEBUG_FLAGS} - - SSL support: ${enable_ssl} - -" diff --git a/docs/Makefile.am b/docs/Makefile.am index c185ffea..f3ddc22d 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -1,3 +1 @@ SUBDIRS = reference - -EXTRA_DIST = soap-encoding.txt soap-envelope.txt wsdl-C-api
\ No newline at end of file diff --git a/docs/reference/.cvsignore b/docs/reference/.cvsignore index e3c36661..2a9165e3 100644 --- a/docs/reference/.cvsignore +++ b/docs/reference/.cvsignore @@ -1,11 +1,10 @@ Makefile Makefile.in -soup-decl-list.txt -soup-decl.txt -soup-unused.txt -soup-undocumented.txt -tmpl -sgml +libsoup-decl-list.txt +libsoup-decl.txt +libsoup-unused.txt +libsoup-undocumented.txt +xml html *.stamp diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am index 5e0c5a72..4e570295 100644 --- a/docs/reference/Makefile.am +++ b/docs/reference/Makefile.am @@ -1,153 +1,60 @@ ## Process this file with automake to produce Makefile.in +AUTOMAKE_OPTIONS = 1.6 -# This file mostly lifted from glib - -# The name of the module. -DOC_MODULE=soup +# The name of the module +DOC_MODULE=libsoup # The top-level SGML file. -DOC_MAIN_SGML_FILE=soup-docs.sgml +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml -# The directory containing the source code. Relative to $(srcdir) +# The directory containing the source code. Relative to $(srcdir). +# gtk-doc will search all .c & .h files beneath here for inline comments +# documenting functions and macros. DOC_SOURCE_DIR=../../libsoup -# Extra options to supply to gtkdoc-scan -SCAN_OPTIONS=--deprecated-guards="G_DISABLE_DEPRECATED" +# Extra options to supply to gtkdoc-scan. +SCAN_OPTIONS= -# Extra options to supply to gtkdoc-mkdb -MKDB_OPTIONS= +# Extra options to supply to gtkdoc-mkdb. +MKDB_OPTIONS=--sgml-mode --output-format=xml -# Extra options to supply to gtkdoc-fixxref +# Extra options to supply to gtkdoc-fixref. FIXXREF_OPTIONS= -# Used for dependencies -HFILE_GLOB=$(shell find $(top_srcdir) -name '*.h' -print) -CFILE_GLOB=$(shell find $(top_srcdir) -name '*.c' -print) +# Used for dependencies. +HFILE_GLOB= +CFILE_GLOB= + +# Header files to ignore when scanning. +IGNORE_HFILES= soup.h soup-marshal.h soup-types.h + +# Images to copy into HTML directory. +HTML_IMAGES = + +# Extra XML files that are included by $(DOC_MAIN_SGML_FILE). +content_files = + +# Other files to distribute. +extra_files = + + +# CFLAGS and LDFLAGS for compiling scan program. Only needed +# if $(DOC_MODULE).types is non-empty. +GTKDOC_CFLAGS = \ + -I$(top_srcdir) \ + $(GLIB_CFLAGS) \ + $(XML_CFLAGS) \ + $(GNUTLS_CFLAGS) + +GTKDOC_LIBS = $(top_builddir)/libsoup/libsoup-$(SOUP_API_VERSION).la + + +# If you need to override some of the declarations, place them in the +# $(DOC_MODULE)-overrides.txt file and uncomment the second line here. +DOC_OVERRIDES = +#DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt + + +# include common portion ... +include $(top_srcdir)/gtk-doc.make -# Headers to ignore -IGNORE_HFILES= \ - soup-private.h \ - # - -# Extra files to add when scanning -EXTRA_HFILES= - -# Images to copy into HTML directory -HTML_IMAGES = \ - # - -# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE) -content_files = \ - # - -# Other files to distribute -extra_files = \ - # - -#################################### -# Everything below here is generic # -#################################### - -TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) - -EXTRA_DIST = \ - $(content_files) \ - $(extra_files) \ - $(HTML_IMAGES) \ - $(DOC_MAIN_SGML_FILE) \ - $(DOC_MODULE)-sections.txt \ - # - -DOC_STAMPS= \ - scan-build.stamp \ - tmpl-build.stamp \ - sgml-build.stamp \ - html-build.stamp \ - $(srcdir)/tmpl.stamp \ - $(srcdir)/sgml.stamp \ - $(srcdir)/html.stamp \ - # - -if ENABLE_GTK_DOC -all-local: html-build.stamp - -#### scan #### - -scan-build.stamp: $(HFILE_GLOB) - @echo '*** Scanning header files ***' - cd $(srcdir) && \ - gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES) - touch scan-build.stamp - -$(srcdir)/$(DOC_MODULE)-decl.txt: scan-build.stamp - @true - -#### templates #### - -tmpl-build.stamp: $(srcdir)/$(DOC_MODULE)-decl.txt $(srcdir)/$(DOC_MODULE)-sections.txt - @echo '*** Rebuilding template files ***' - cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) - touch tmpl-build.stamp - -$(srcdir)/tmpl.stamp: tmpl-build.stamp - @true - -#### sgml #### - -sgml-build.stamp: $(srcdir)/tmpl.stamp $(CFILE_GLOB) - @echo '*** Building SGML ***' - cd $(srcdir) && \ - gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) $(MKDB_OPTIONS) - touch sgml-build.stamp - -$(srcdir)/sgml.stamp: sgml-build.stamp - @true - -#### html #### - -html-build.stamp: $(srcdir)/sgml.stamp $(srcdir)/$(DOC_MAIN_SGML_FILE) $(content_files) - @echo '*** Building HTML ***' - test -d $(srcdir)/html || mkdir $(srcdir)/html - cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) - test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html ) - @echo '-- Fixing Crossreferences' - cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) - touch html-build.stamp -endif - -############## - -clean-local: - rm -f *~ *.bak *-unused.txt $(DOC_STAMPS) - -maintainer-clean-local: clean - cd $(srcdir) && rm -rf tmpl sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt $(DOC_MODULE)-unused.txt $(DOC_MODULE)-undocumented.txt - -install-data-local: - $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) - (installfiles=`echo $(srcdir)/html/*.html`; \ - if test "$$installfiles" = '$(srcdir)/html/*.html'; \ - then echo '-- Nothing to install' ; \ - else \ - for i in $$installfiles; do \ - echo '-- Installing '$$i ; \ - $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \ - done; \ - echo '-- Installing $(srcdir)/html/index.sgml' ; \ - $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \ - fi) - -# -# Require gtk-doc when making dist -# -if ENABLE_GTK_DOC -dist-check-gtkdoc: -else -dist-check-gtkdoc: - @echo "*** gtk-doc must be installed and enabled in order to make dist" - @false -endif - -dist-hook: dist-check-gtkdoc dist-hook-local - -.PHONY : dist-hook-local diff --git a/docs/reference/libsoup-docs.sgml b/docs/reference/libsoup-docs.sgml new file mode 100644 index 00000000..99884f36 --- /dev/null +++ b/docs/reference/libsoup-docs.sgml @@ -0,0 +1,35 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> +<book id="index" xmlns:xi="http://www.w3.org/2001/XInclude"> + <bookinfo> + <title>libsoup Reference Manual</title> + </bookinfo> + + <chapter> + <title>libsoup</title> + <xi:include href="xml/soup-dns.xml"/> + <xi:include href="xml/soup-address.xml"/> + <xi:include href="xml/soup-auth.xml"/> + <xi:include href="xml/soup-auth-basic.xml"/> + <xi:include href="xml/soup-auth-digest.xml"/> + <xi:include href="xml/soup-connection.xml"/> + <xi:include href="xml/soup-connection-ntlm.xml"/> + <xi:include href="xml/soup-headers.xml"/> + <xi:include href="xml/soup-md5-utils.xml"/> + <xi:include href="xml/soup-message-private.xml"/> + <xi:include href="xml/soup-message-queue.xml"/> + <xi:include href="xml/soup-message.xml"/> + <xi:include href="xml/soup-method.xml"/> + <xi:include href="xml/soup-misc.xml"/> + <xi:include href="xml/soup-server-auth.xml"/> + <xi:include href="xml/soup-server-message.xml"/> + <xi:include href="xml/soup-server.xml"/> + <xi:include href="xml/soup-session.xml"/> + <xi:include href="xml/soup-soap-message.xml"/> + <xi:include href="xml/soup-socket.xml"/> + <xi:include href="xml/soup-ssl.xml"/> + <xi:include href="xml/soup-status.xml"/> + <xi:include href="xml/soup-uri.xml"/> + </chapter> +</book> diff --git a/docs/reference/libsoup-overrides.txt b/docs/reference/libsoup-overrides.txt new file mode 100644 index 00000000..e69de29b --- /dev/null +++ b/docs/reference/libsoup-overrides.txt diff --git a/docs/reference/libsoup-sections.txt b/docs/reference/libsoup-sections.txt new file mode 100644 index 00000000..3abb9186 --- /dev/null +++ b/docs/reference/libsoup-sections.txt @@ -0,0 +1,491 @@ +<SECTION> +<FILE>soup-message</FILE> +SoupMessageStatus +SOUP_MESSAGE_IS_STARTING +SoupTransferEncoding +SoupOwnership +SoupDataBuffer +<TITLE>SoupMessage</TITLE> +SoupMessageCallbackFn +soup_message_new +soup_message_new_from_uri +soup_message_set_request +soup_message_set_response +soup_message_cancel +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 +SoupHttpVersion +soup_message_set_http_version +soup_message_get_http_version +soup_message_is_keepalive +soup_message_get_uri +soup_message_set_uri +SoupMessageFlags +soup_message_set_flags +soup_message_get_flags +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 +soup_message_set_status +soup_message_set_status_full +soup_message_add_chunk +soup_message_add_final_chunk +soup_message_pop_chunk +soup_message_send_request +soup_message_read_request +soup_message_io_cancel +soup_message_io_pause +soup_message_io_unpause +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 +<SUBSECTION Standard> +SOUP_MESSAGE +SOUP_IS_MESSAGE +SOUP_TYPE_MESSAGE +soup_message_get_type +SOUP_MESSAGE_CLASS +SOUP_IS_MESSAGE_CLASS +SOUP_MESSAGE_GET_CLASS +SoupMessageClass +</SECTION> + +<SECTION> +<FILE>soup-auth-digest</FILE> +<TITLE>SoupAuthDigest</TITLE> +SoupAuthDigest +<SUBSECTION Standard> +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> +<FILE>soup-status</FILE> +SoupStatusClass +SOUP_STATUS_IS_INFORMATIONAL +SOUP_STATUS_IS_SUCCESSFUL +SOUP_STATUS_IS_REDIRECTION +SOUP_STATUS_IS_CLIENT_ERROR +SOUP_STATUS_IS_SERVER_ERROR +SoupKnownStatusCode +soup_status_get_phrase +<SUBSECTION Standard> +SOUP_STATUS_IS_TRANSPORT_ERROR +</SECTION> + +<SECTION> +<FILE>soup-server</FILE> +<TITLE>SoupServer</TITLE> +SoupServerContext +SoupServerCallbackFn +SoupServerUnregisterFn +SOUP_SERVER_PORT +SOUP_SERVER_INTERFACE +SOUP_SERVER_SSL_CERT_FILE +SOUP_SERVER_SSL_KEY_FILE +soup_server_new +soup_server_get_protocol +soup_server_get_port +soup_server_run +soup_server_run_async +soup_server_quit +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 +<SUBSECTION Standard> +SOUP_SERVER +SOUP_IS_SERVER +SOUP_TYPE_SERVER +soup_server_get_type +SOUP_SERVER_CLASS +SOUP_IS_SERVER_CLASS +SOUP_SERVER_GET_CLASS +SoupServerClass +</SECTION> + +<SECTION> +<FILE>soup-address</FILE> +<TITLE>SoupAddress</TITLE> +SoupAddressFamily +SOUP_ADDRESS_ANY_PORT +soup_address_new +soup_address_new_from_sockaddr +soup_address_new_any +SoupAddressCallback +soup_address_resolve_async +soup_address_resolve_sync +soup_address_get_name +soup_address_get_physical +soup_address_get_port +<SUBSECTION Standard> +SOUP_ADDRESS +SOUP_IS_ADDRESS +SOUP_TYPE_ADDRESS +soup_address_get_type +SOUP_ADDRESS_CLASS +SOUP_IS_ADDRESS_CLASS +SOUP_ADDRESS_GET_CLASS +SoupAddressClass +</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 +<SUBSECTION Standard> +SOUP_SOAP_MESSAGE +SOUP_IS_SOAP_MESSAGE +SOUP_TYPE_SOAP_MESSAGE +soup_soap_message_get_type +SOUP_SOAP_MESSAGE_CLASS +SOUP_IS_SOAP_MESSAGE_CLASS +SOUP_SOAP_MESSAGE_GET_CLASS +SoupSoapMessageClass +SoupSoapMessagePrivate +</SECTION> + +<SECTION> +<FILE>soup-session</FILE> +<TITLE>SoupSession</TITLE> +SOUP_SESSION_PROXY_URI +SOUP_SESSION_MAX_CONNS +SOUP_SESSION_MAX_CONNS_PER_HOST +SOUP_SESSION_USE_NTLM +SOUP_SESSION_SSL_CA_FILE +soup_session_new +soup_session_new_with_options +soup_session_queue_message +soup_session_requeue_message +soup_session_send_message +soup_session_abort +<SUBSECTION Standard> +SOUP_SESSION +SOUP_IS_SESSION +SOUP_TYPE_SESSION +soup_session_get_type +SOUP_SESSION_CLASS +SOUP_IS_SESSION_CLASS +SOUP_SESSION_GET_CLASS +SoupSessionClass +</SECTION> + +<SECTION> +<FILE>soup-auth</FILE> +<TITLE>SoupAuth</TITLE> +SoupAuth +soup_auth_new_from_header_list +soup_auth_get_scheme_name +soup_auth_get_realm +soup_auth_authenticate +soup_auth_is_authenticated +soup_auth_get_authorization +soup_auth_get_protection_space +soup_auth_free_protection_space +<SUBSECTION Standard> +SOUP_AUTH +SOUP_IS_AUTH +SOUP_TYPE_AUTH +soup_auth_get_type +SOUP_AUTH_CLASS +SOUP_IS_AUTH_CLASS +SOUP_AUTH_GET_CLASS +SoupAuthClass +</SECTION> + +<SECTION> +<FILE>soup-socket</FILE> +<TITLE>SoupSocket</TITLE> +SOUP_SOCKET_FLAG_NONBLOCKING +SOUP_SOCKET_FLAG_NODELAY +SOUP_SOCKET_FLAG_REUSEADDR +SOUP_SOCKET_IS_SERVER +SOUP_SOCKET_SSL_CREDENTIALS +soup_socket_new +soup_socket_connect +soup_socket_listen +soup_socket_start_ssl +soup_socket_disconnect +soup_socket_is_connected +SoupSocketCallback +SoupSocketListenerCallback +soup_socket_client_new_async +soup_socket_client_new_sync +soup_socket_server_new +soup_socket_get_local_address +soup_socket_get_remote_address +SoupSocketIOStatus +soup_socket_read +soup_socket_read_until +soup_socket_write +<SUBSECTION Standard> +SOUP_SOCKET +SOUP_IS_SOCKET +SOUP_TYPE_SOCKET +soup_socket_get_type +SOUP_SOCKET_CLASS +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-auth-basic</FILE> +<TITLE>SoupAuthBasic</TITLE> +SoupAuthBasic +<SUBSECTION Standard> +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 +</SECTION> + +<SECTION> +<FILE>soup-connection</FILE> +<TITLE>SoupConnection</TITLE> +SOUP_CONNECTION_ORIGIN_URI +SOUP_CONNECTION_PROXY_URI +SOUP_CONNECTION_SSL_CREDENTIALS +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 +<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> +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-message-queue</FILE> +SoupMessageQueueIter +soup_message_queue_new +soup_message_queue_append +soup_message_queue_first +soup_message_queue_next +soup_message_queue_remove +soup_message_queue_free_iter +soup_message_queue_destroy +soup_message_queue_remove_message +</SECTION> + +<SECTION> +<FILE>soup-md5-utils</FILE> +SoupMD5Context +soup_md5_init +soup_md5_update +soup_md5_final +</SECTION> + +<SECTION> +<FILE>soup-server-auth</FILE> +SoupServerAuthCallbackFn +soup_server_auth_context_challenge +SoupAuthType +SoupServerAuthBasic +SoupDigestAlgorithm +SoupServerAuthDigest +soup_server_auth_new +soup_server_auth_free +soup_server_auth_get_user +soup_server_auth_check_passwd +</SECTION> + +<SECTION> +<FILE>soup-dns</FILE> +soup_dns_entry_from_name +soup_dns_entry_from_addr +soup_dns_entry_check_lookup +soup_dns_entry_cancel_lookup +soup_dns_free_hostent +soup_dns_ntop +</SECTION> + +<SECTION> +<FILE>soup-headers</FILE> +soup_headers_parse_request +soup_headers_parse_status_line +soup_headers_parse_response +soup_header_param_decode_token +soup_header_param_parse_list +soup_header_param_copy_token +soup_header_param_destroy_hash +</SECTION> + +<SECTION> +<FILE>soup-ssl</FILE> +SoupSSLType +soup_ssl_get_client_credentials +soup_ssl_free_client_credentials +soup_ssl_get_server_credentials +soup_ssl_free_server_credentials +soup_ssl_wrap_iochannel +</SECTION> + +<SECTION> +<FILE>soup-uri</FILE> +SoupProtocol +SOUP_PROTOCOL_HTTP +SOUP_PROTOCOL_HTTPS +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_uses_default_port +</SECTION> + +<SECTION> +<FILE>soup-message-private</FILE> +soup_message_run_handlers +soup_message_cleanup +soup_message_cleanup_response +SoupMessageGetHeadersFn +SoupMessageParseHeadersFn +soup_message_io_client +soup_message_io_server +</SECTION> + +<SECTION> +<FILE>soup-method</FILE> +SOUP_METHOD_POST +SOUP_METHOD_GET +SOUP_METHOD_HEAD +SOUP_METHOD_OPTIONS +SOUP_METHOD_PUT +SOUP_METHOD_MOVE +SOUP_METHOD_COPY +SOUP_METHOD_DELETE +SOUP_METHOD_TRACE +SOUP_METHOD_CONNECT +SOUP_METHOD_MKCOL +SOUP_METHOD_PROPPATCH +SOUP_METHOD_PROPFIND +SOUP_METHOD_PATCH +SOUP_METHOD_LOCK +SOUP_METHOD_UNLOCK +SoupMethodId +soup_method_get_id +</SECTION> + +<SECTION> +<FILE>soup-misc</FILE> +soup_base64_encode +soup_base64_encode_close +soup_base64_encode_step +soup_base64_decode +soup_base64_decode_step +soup_signal_connect_once +soup_str_case_hash +soup_str_case_equal +soup_ssl_supported +</SECTION> diff --git a/docs/reference/libsoup.types b/docs/reference/libsoup.types new file mode 100644 index 00000000..87cf6080 --- /dev/null +++ b/docs/reference/libsoup.types @@ -0,0 +1,26 @@ +#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-server-message.h> +#include <libsoup/soup-server.h> +#include <libsoup/soup-session.h> +#include <libsoup/soup-soap-message.h> +#include <libsoup/soup-socket.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_message_get_type +soup_server_message_get_type +soup_server_get_type +soup_session_get_type +soup_soap_message_get_type +soup_socket_get_type + diff --git a/docs/reference/soup-docs.sgml b/docs/reference/soup-docs.sgml deleted file mode 100644 index c8ccf5a6..00000000 --- a/docs/reference/soup-docs.sgml +++ /dev/null @@ -1,79 +0,0 @@ -<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [ -<!entity soup-soup-context SYSTEM "sgml/soup-context.sgml"> -<!entity soup-soup-message SYSTEM "sgml/soup-message.sgml"> -<!entity soup-soup-misc SYSTEM "sgml/soup-misc.sgml"> -<!entity soup-soup-parser SYSTEM "sgml/soup-parser.sgml"> -<!entity soup-soup-serializer SYSTEM "sgml/soup-serializer.sgml"> -<!entity soup-soup-server SYSTEM "sgml/soup-server.sgml"> -<!entity soup-soup-socket SYSTEM "sgml/soup-socket.sgml"> -<!entity soup-soup-uri SYSTEM "sgml/soup-uri.sgml"> -<!entity soup-soup-fault SYSTEM "sgml/soup-fault.sgml"> -<!entity soup-soup-env SYSTEM "sgml/soup-env.sgml"> -<!entity soup-wsdl-describe SYSTEM "sgml/wsdl-describe.sgml"> -<!entity soup-wsdl-locate SYSTEM "sgml/wsdl-locate.sgml"> -<!entity soup-wsdl-memory SYSTEM "sgml/wsdl-memory.sgml"> -<!entity soup-wsdl-parse SYSTEM "sgml/wsdl-parse.sgml"> -<!entity soup-wsdl-soap-common SYSTEM "sgml/wsdl-soap-common.sgml"> -<!entity soup-wsdl-soap-emit SYSTEM "sgml/wsdl-soap-emit.sgml"> -<!entity soup-wsdl-soap-headers SYSTEM "sgml/wsdl-soap-headers.sgml"> -<!entity soup-wsdl-soap-skels SYSTEM "sgml/wsdl-soap-skels.sgml"> -<!entity soup-wsdl-soap-stubs SYSTEM "sgml/wsdl-soap-stubs.sgml"> -<!entity soup-wsdl-thread SYSTEM "sgml/wsdl-thread.sgml"> -<!entity soup-wsdl-trace SYSTEM "sgml/wsdl-trace.sgml"> -<!entity soup-wsdl SYSTEM "sgml/wsdl.sgml"> -<!entity soup-wsdl-param SYSTEM "sgml/wsdl-param.sgml"> -<!entity soup-wsdl-schema-glib SYSTEM "sgml/wsdl-schema-glib.sgml"> -<!entity soup-wsdl-schema SYSTEM "sgml/wsdl-schema.sgml"> -<!entity soup-wsdl-soap-marshal SYSTEM "sgml/wsdl-soap-marshal.sgml"> -<!entity soup-wsdl-soap-parse SYSTEM "sgml/wsdl-soap-parse.sgml"> -<!entity soup-wsdl-typecodes-c SYSTEM "sgml/wsdl-typecodes-c.sgml"> -<!entity soup-wsdl-typecodes SYSTEM "sgml/wsdl-typecodes.sgml"> -<!entity soup-wsdl-soap-memory SYSTEM "sgml/wsdl-soap-memory.sgml"> -]> -<book> - <bookinfo> - <title>SOUP Reference Manual</title> - </bookinfo> - - <chapter id="soup-core-chapter"> - <title>Soup Core</title> - &soup-soup-context; - &soup-soup-message; - &soup-soup-misc; - &soup-soup-parser; - &soup-soup-serializer; - &soup-soup-server; - &soup-soup-socket; - &soup-soup-uri; - &soup-soup-fault; - &soup-soup-env; - </chapter> - - <chapter id="soup-wsdl-chapter"> - <title>Soup WSDL</title> - &soup-wsdl-describe; - &soup-wsdl-locate; - &soup-wsdl-memory; - &soup-wsdl-parse; - &soup-wsdl-soap-common; - &soup-wsdl-soap-emit; - &soup-wsdl-soap-headers; - &soup-wsdl-soap-skels; - &soup-wsdl-soap-stubs; - &soup-wsdl-thread; - &soup-wsdl-trace; - </chapter> - - <chapter id="soup-wsdl-runtime-chapter"> - <title>Soup WSDL Runtime</title> - &soup-wsdl; - &soup-wsdl-param; - &soup-wsdl-schema-glib; - &soup-wsdl-schema; - &soup-wsdl-soap-marshal; - &soup-wsdl-soap-parse; - &soup-wsdl-typecodes-c; - &soup-wsdl-typecodes; - &soup-wsdl-soap-memory; - </chapter> -</book> diff --git a/docs/reference/soup-sections.txt b/docs/reference/soup-sections.txt deleted file mode 100644 index f53c4798..00000000 --- a/docs/reference/soup-sections.txt +++ /dev/null @@ -1,495 +0,0 @@ -<SECTION> -<FILE>md5-utils</FILE> -</SECTION> - -<SECTION> -<FILE>soup-context</FILE> -SoupContext -SoupConnection -SoupConnectErrorCode -SoupConnectCallbackFn -SoupConnectId -soup_context_get -soup_context_from_uri -soup_context_ref -soup_context_unref -soup_context_get_connection -soup_context_get_uri -soup_context_cancel_connect -soup_connection_get_iochannel -soup_connection_get_context -soup_connection_set_keep_alive -soup_connection_is_keep_alive -soup_connection_is_new -soup_connection_release -</SECTION> - -<SECTION> -<FILE>soup-headers</FILE> -soup_headers_parse_request -soup_headers_parse_response -</SECTION> - -<SECTION> -<FILE>soup-message</FILE> -SoupKnownErrorCode -SoupErrorClass -SoupTransferStatus -SoupOwnership -SoupDataBuffer -SoupMessage -SoupMessagePrivate -SoupCallbackFn -soup_message_new -soup_message_new_full -soup_message_free -soup_message_cancel -soup_message_send -soup_message_queue -soup_message_set_request_header -soup_message_get_request_header -soup_message_set_response_header -soup_message_get_response_header -SoupMessageFlags -soup_message_set_flags -soup_message_get_flags -</SECTION> - -<SECTION> -<FILE>soup-misc</FILE> -soup_load_config -soup_shutdown -soup_set_proxy -soup_get_proxy -soup_set_connection_limit -soup_get_connection_limit -SoupSecurityPolicy -soup_set_security_policy -soup_get_security_policy -soup_debug_print_headers -soup_debug_print_uri -</SECTION> - -<SECTION> -<FILE>soup-nss</FILE> -soup_nss_get_iochannel -soup_nss_set_security_policy -soup_nss_init -</SECTION> - -<SECTION> -<FILE>soup-openssl</FILE> -soup_openssl_get_iochannel -soup_openssl_set_security_policy -soup_openssl_init -</SECTION> - -<SECTION> -<FILE>soup-parser</FILE> -SoupParamType -SoupParam -SoupParamList -soup_param_new -soup_param_new_full -soup_param_get_name -soup_param_set_name -soup_param_get_type -soup_param_set_type -soup_param_get_data -soup_param_set_data -soup_param_free -SoupParamListFunc -soup_param_list_new -soup_param_list_add -soup_param_list_get_by_name -soup_param_list_foreach -soup_param_list_free -SoupParser -soup_parser_new_from_string -soup_parser_new_from_data_buffer -soup_parser_get_fault -soup_parser_get_method_name -soup_parser_get_param_list -soup_parser_get_param_by_name -soup_parser_free -</SECTION> - -<SECTION> -<FILE>soup-serializer</FILE> -SoupSerializer -soup_serializer_new -soup_serializer_new_full -soup_serializer_get_xml_doc -soup_serializer_free -soup_serializer_start_envelope -soup_serializer_end_envelope -soup_serializer_start_body -soup_serializer_end_body -soup_serializer_start_element -soup_serializer_end_element -soup_serializer_start_fault -soup_serializer_end_fault -soup_serializer_start_fault_detail -soup_serializer_end_fault_detail -soup_serializer_start_header -soup_serializer_end_header -soup_serializer_start_header_element -soup_serializer_end_header_element -soup_serializer_write_int -soup_serializer_write_double -soup_serializer_write_base64 -soup_serializer_write_time -soup_serializer_write_string -soup_serializer_write_buffer -soup_serializer_set_type -soup_serializer_set_null -soup_serializer_add_attribute -soup_serializer_add_namespace -soup_serializer_set_default_namespace -soup_serializer_set_encoding_style -soup_serializer_reset -soup_serializer_persist -</SECTION> - -<SECTION> -<FILE>soup-server</FILE> -SoupServerAuthType -SoupServerBasicToken -SoupServerDigestToken -SoupServerNTLMToken -SoupServerCallbackFn -soup_server_register -soup_server_register_default -soup_server_unregister -soup_server_main -soup_server_main_quit -soup_server_init -</SECTION> - -<SECTION> -<FILE>soup-socket</FILE> -SOUP_SERVER_ANY_PORT -SoupAddress -SoupAddressNewId -SoupAddressStatus -SoupAddressNewFn -soup_address_new -soup_address_new_cancel -soup_address_new_sync -soup_address_ref -soup_address_unref -SoupAddressGetNameId -SoupAddressGetNameFn -soup_address_get_name -soup_address_get_name_cancel -soup_address_get_canonical_name -soup_address_get_port -soup_address_set_port -soup_address_hash -soup_address_equal -soup_address_noport_equal -soup_address_gethostname -soup_address_gethostaddr -SoupSocket -SoupSocketConnectId -SoupSocketConnectStatus -SoupSocketConnectFn -soup_socket_connect -soup_socket_connect_cancel -soup_socket_connect_sync -SoupSocketNewId -SoupSocketNewStatus -SoupSocketNewFn -soup_socket_new -soup_socket_new_cancel -soup_socket_new_sync -soup_socket_ref -soup_socket_unref -soup_socket_get_iochannel -soup_socket_get_address -soup_socket_get_port -soup_socket_server_new -soup_socket_server_accept -soup_socket_server_try_accept -</SECTION> - -<SECTION> -<FILE>soup-socks</FILE> -soup_connect_socks_proxy -</SECTION> - -<SECTION> -<FILE>soup-ssl</FILE> -soup_ssl_get_iochannel -</SECTION> - -<SECTION> -<FILE>soup-uri</FILE> -SoupProtocol -SoupUri -soup_uri_new -soup_uri_to_string -soup_uri_copy -soup_uri_free -</SECTION> - -<SECTION> -<FILE>soup</FILE> -</SECTION> - -<SECTION> -<FILE>soup-fault</FILE> -SoupFault -soup_fault_new -soup_fault_get_code -soup_fault_get_string -soup_fault_get_actor -soup_fault_get_detail -soup_fault_set_code -soup_fault_set_string -soup_fault_set_actor -soup_fault_set_detail -soup_fault_free -</SECTION> - -<SECTION> -<FILE>soup-env</FILE> -SoupEnv -soup_env_new -soup_env_free -soup_env_set_address -soup_env_get_address -soup_env_set_request_header -soup_env_get_request_header -soup_env_get_request_header_list -soup_env_set_response_header -soup_env_get_response_header -soup_env_get_response_header_list -soup_env_get_fault -soup_env_set_fault -soup_env_clear_request_headers -soup_env_clear_response_headers -soup_env_clear_fault -soup_env_clear_all -</SECTION> - -<SECTION> -<FILE>wsdl-describe</FILE> -wsdl_describe_iof_t -wsdl_describe_types -wsdl_describe_message_part -wsdl_describe_message -wsdl_describe_porttype_operation_iof -wsdl_describe_porttype_operation -wsdl_describe_porttype -wsdl_describe_soap_operation -wsdl_describe_soap_body -wsdl_describe_soap_header -wsdl_describe_soap_fault -wsdl_describe_binding_operation_iof -wsdl_describe_binding_operation -wsdl_describe_soap_binding -wsdl_describe_binding -wsdl_describe_soap_address -wsdl_describe_service_port -wsdl_describe_service -wsdl_describe_definitions -</SECTION> - -<SECTION> -<FILE>wsdl-locate</FILE> -wsdl_locate_porttype_operation -wsdl_locate_message_part -wsdl_locate_message -wsdl_locate_porttype -wsdl_locate_binding -</SECTION> - -<SECTION> -<FILE>wsdl-memory</FILE> -wsdl_free_types -wsdl_free_message_part -wsdl_free_message -wsdl_free_porttype_operation_iof -wsdl_free_porttype_operation -wsdl_free_porttype -wsdl_free_soap_binding -wsdl_free_soap_operation -wsdl_free_soap_body -wsdl_free_soap_header -wsdl_free_soap_fault -wsdl_free_binding_operation_iof -wsdl_free_binding_operation -wsdl_free_binding -wsdl_free_soap_address -wsdl_free_service_port -wsdl_free_service -wsdl_free_definitions -</SECTION> - -<SECTION> -<FILE>wsdl-parse</FILE> -wsdl_parse -</SECTION> - -<SECTION> -<FILE>wsdl-soap-common</FILE> -wsdl_emit_soap_common -</SECTION> - -<SECTION> -<FILE>wsdl-soap-emit</FILE> -wsdl_emit_part_list -</SECTION> - -<SECTION> -<FILE>wsdl-soap-headers</FILE> -wsdl_emit_soap_headers -</SECTION> - -<SECTION> -<FILE>wsdl-soap-skels</FILE> -wsdl_emit_soap_skels -</SECTION> - -<SECTION> -<FILE>wsdl-soap-stubs</FILE> -wsdl_emit_soap_stubs -</SECTION> - -<SECTION> -<FILE>wsdl-thread</FILE> -wsdl_thread -</SECTION> - -<SECTION> -<FILE>wsdl-trace</FILE> -WSDL_LOG_DOMAIN_STUBS -WSDL_LOG_DOMAIN_SKELS -WSDL_LOG_DOMAIN_HEADERS -WSDL_LOG_DOMAIN_COMMON -WSDL_LOG_DOMAIN_PARSER -WSDL_LOG_DOMAIN_THREAD -WSDL_LOG_DOMAIN_MAIN -wsdl_parse_debug_domain_string -wsdl_parse_debug_level_string -wsdl_debug -</SECTION> - -<SECTION> -<FILE>wsdl</FILE> -option_warnings_are_errors -option_show_doc -option_show_xml_tree -option_emit_stubs -option_emit_skels -option_emit_common -option_emit_headers -option_outdir -option_debug_level -option_debug_modules -</SECTION> - -<SECTION> -<FILE>wsdl-param</FILE> -wsdl_param -</SECTION> - -<SECTION> -<FILE>wsdl-schema-glib</FILE> -wsdl_schema_glib_start_element -wsdl_schema_glib_end_element -</SECTION> - -<SECTION> -<FILE>wsdl-schema</FILE> -WSDLNS -SOAPNS -XSDNS -GLIBNS -wsdl_qnamecmp -wsdl_attrnscmp -wsdl_prefix_to_namespace -wsdl_schema_init -wsdl_schema_start_element -wsdl_schema_end_element -</SECTION> - -<SECTION> -<FILE>wsdl-soap-marshal</FILE> -wsdl_soap_marshal -</SECTION> - -<SECTION> -<FILE>wsdl-soap-parse</FILE> -wsdl_soap_parse -</SECTION> - -<SECTION> -<FILE>wsdl-typecodes-c</FILE> -wsdl_typecode_write_c_definition -wsdl_typecode_write_c_declaration -wsdl_typecode_write_c_mm -wsdl_typecode_write_c_mm_decl -</SECTION> - -<SECTION> -<FILE>wsdl-typecodes</FILE> -wsdl_typecode_kind_t -wsdl_typecode -ALIGN_ADDRESS -WSDL_TC_glib_null_struct -WSDL_TC_glib_void_struct -WSDL_TC_glib_boolean_struct -WSDL_TC_glib_char_struct -WSDL_TC_glib_uchar_struct -WSDL_TC_glib_int_struct -WSDL_TC_glib_uint_struct -WSDL_TC_glib_short_struct -WSDL_TC_glib_ushort_struct -WSDL_TC_glib_long_struct -WSDL_TC_glib_ulong_struct -WSDL_TC_glib_int8_struct -WSDL_TC_glib_uint8_struct -WSDL_TC_glib_int16_struct -WSDL_TC_glib_uint16_struct -WSDL_TC_glib_int32_struct -WSDL_TC_glib_uint32_struct -WSDL_TC_glib_float_struct -WSDL_TC_glib_double_struct -WSDL_TC_glib_string_struct -wsdl_typecode_kind -wsdl_typecode_element_kind -wsdl_typecode_is_simple -wsdl_typecode_member_count -wsdl_typecode_member_name -wsdl_typecode_member_type -wsdl_typecode_content_type -wsdl_typecode_name -wsdl_typecode_ns -wsdl_typecode_nsuri -wsdl_typecode_type -wsdl_typecode_param_type -wsdl_typecode_print -wsdl_typecode_lookup -wsdl_typecode_register -wsdl_typecode_unregister -wsdl_typecode_free -wsdl_typecode_free_all -wsdl_typecode_foreach -wsdl_typecode_alloc -wsdl_typecode_find_alignment -wsdl_typecode_size -wsdl_typecode_offset -</SECTION> - -<SECTION> -<FILE>wsdl</FILE> -</SECTION> - -<SECTION> -<FILE>wsdl-soap-memory</FILE> -wsdl_soap_initialise -wsdl_soap_free -</SECTION> - diff --git a/docs/reference/tmpl/libsoup-unused.sgml b/docs/reference/tmpl/libsoup-unused.sgml new file mode 100644 index 00000000..76ad434f --- /dev/null +++ b/docs/reference/tmpl/libsoup-unused.sgml @@ -0,0 +1,151 @@ +<!-- ##### SECTION ./tmpl/soup-marshal.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/soup-marshal.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/soup-marshal.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/soup-marshal.sgml:Title ##### --> +soup-marshal + + +<!-- ##### SECTION ./tmpl/soup-socket-ssl.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/soup-socket-ssl.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/soup-socket-ssl.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/soup-socket-ssl.sgml:Title ##### --> +SoupSocketSSL + + +<!-- ##### SECTION ./tmpl/soup-types.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/soup-types.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/soup-types.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/soup-types.sgml:Title ##### --> +soup-types + + +<!-- ##### SECTION ./tmpl/soup.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/soup.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/soup.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/soup.sgml:Title ##### --> +soup + + +<!-- ##### MACRO SOUP_MAKE_TYPE ##### --> +<para> + +</para> + +@l: +@t: +@ci: +@i: +@parent: + +<!-- ##### STRUCT SoupSoapMessagePrivate ##### --> +<para> + +</para> + + +<!-- ##### MACRO soup_marshal_NONE__INT ##### --> +<para> + +</para> + + +<!-- ##### MACRO soup_marshal_NONE__NONE ##### --> +<para> + +</para> + + +<!-- ##### MACRO soup_marshal_NONE__OBJECT ##### --> +<para> + +</para> + + +<!-- ##### MACRO soup_marshal_NONE__OBJECT_STRING_STRING_POINTER_POINTER ##### --> +<para> + +</para> + + +<!-- ##### MACRO soup_marshal_VOID__INT ##### --> +<para> + +</para> + + +<!-- ##### MACRO soup_marshal_VOID__OBJECT ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION soup_marshal_VOID__OBJECT_STRING_STRING_POINTER_POINTER ##### --> +<para> + +</para> + +@closure: +@return_value: +@n_param_values: +@param_values: +@invocation_hint: +@marshal_data: + +<!-- ##### MACRO soup_marshal_VOID__VOID ##### --> +<para> + +</para> + + diff --git a/docs/reference/tmpl/soup-address.sgml b/docs/reference/tmpl/soup-address.sgml new file mode 100644 index 00000000..b4f7b8a5 --- /dev/null +++ b/docs/reference/tmpl/soup-address.sgml @@ -0,0 +1,120 @@ +<!-- ##### SECTION Title ##### --> +SoupAddress + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### ENUM SoupAddressFamily ##### --> +<para> + +</para> + +@SOUP_ADDRESS_FAMILY_IPV4: +@SOUP_ADDRESS_FAMILY_IPV6: + +<!-- ##### MACRO SOUP_ADDRESS_ANY_PORT ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION soup_address_new ##### --> +<para> + +</para> + +@name: +@port: +@Returns: + + +<!-- ##### FUNCTION soup_address_new_from_sockaddr ##### --> +<para> + +</para> + +@sa: +@len: +@Returns: + + +<!-- ##### FUNCTION soup_address_new_any ##### --> +<para> + +</para> + +@family: +@port: +@Returns: + + +<!-- ##### USER_FUNCTION SoupAddressCallback ##### --> +<para> + +</para> + +@addr: +@status: +@data: + + +<!-- ##### FUNCTION soup_address_resolve_async ##### --> +<para> + +</para> + +@addr: +@callback: +@user_data: +<!-- # Unused Parameters # --> +@cb: +@data: + + +<!-- ##### FUNCTION soup_address_resolve_sync ##### --> +<para> + +</para> + +@addr: +@Returns: + + +<!-- ##### FUNCTION soup_address_get_name ##### --> +<para> + +</para> + +@addr: +@Returns: + + +<!-- ##### FUNCTION soup_address_get_physical ##### --> +<para> + +</para> + +@addr: +@Returns: + + +<!-- ##### FUNCTION soup_address_get_port ##### --> +<para> + +</para> + +@addr: +@Returns: + + diff --git a/docs/reference/tmpl/soup-auth-basic.sgml b/docs/reference/tmpl/soup-auth-basic.sgml new file mode 100644 index 00000000..7dc91b10 --- /dev/null +++ b/docs/reference/tmpl/soup-auth-basic.sgml @@ -0,0 +1,22 @@ +<!-- ##### SECTION Title ##### --> +SoupAuthBasic + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### STRUCT SoupAuthBasic ##### --> +<para> + +</para> + + diff --git a/docs/reference/tmpl/soup-auth-digest.sgml b/docs/reference/tmpl/soup-auth-digest.sgml new file mode 100644 index 00000000..16cf820d --- /dev/null +++ b/docs/reference/tmpl/soup-auth-digest.sgml @@ -0,0 +1,22 @@ +<!-- ##### SECTION Title ##### --> +SoupAuthDigest + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### STRUCT SoupAuthDigest ##### --> +<para> + +</para> + + diff --git a/docs/reference/tmpl/soup-auth.sgml b/docs/reference/tmpl/soup-auth.sgml new file mode 100644 index 00000000..7283fe59 --- /dev/null +++ b/docs/reference/tmpl/soup-auth.sgml @@ -0,0 +1,97 @@ +<!-- ##### SECTION Title ##### --> +SoupAuth + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### STRUCT SoupAuth ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION soup_auth_new_from_header_list ##### --> +<para> + +</para> + +@header: +@Returns: + + +<!-- ##### FUNCTION soup_auth_get_scheme_name ##### --> +<para> + +</para> + +@auth: +@Returns: + + +<!-- ##### FUNCTION soup_auth_get_realm ##### --> +<para> + +</para> + +@auth: +@Returns: + + +<!-- ##### FUNCTION soup_auth_authenticate ##### --> +<para> + +</para> + +@auth: +@username: +@password: + + +<!-- ##### FUNCTION soup_auth_is_authenticated ##### --> +<para> + +</para> + +@auth: +@Returns: + + +<!-- ##### FUNCTION soup_auth_get_authorization ##### --> +<para> + +</para> + +@auth: +@msg: +@Returns: + + +<!-- ##### FUNCTION soup_auth_get_protection_space ##### --> +<para> + +</para> + +@auth: +@source_uri: +@Returns: + + +<!-- ##### FUNCTION soup_auth_free_protection_space ##### --> +<para> + +</para> + +@auth: +@space: + + diff --git a/docs/reference/tmpl/soup-connection-ntlm.sgml b/docs/reference/tmpl/soup-connection-ntlm.sgml new file mode 100644 index 00000000..b4e97945 --- /dev/null +++ b/docs/reference/tmpl/soup-connection-ntlm.sgml @@ -0,0 +1,22 @@ +<!-- ##### SECTION Title ##### --> +SoupConnectionNTLM + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### STRUCT SoupConnectionNTLM ##### --> +<para> + +</para> + + diff --git a/docs/reference/tmpl/soup-connection.sgml b/docs/reference/tmpl/soup-connection.sgml new file mode 100644 index 00000000..7c3b6eb9 --- /dev/null +++ b/docs/reference/tmpl/soup-connection.sgml @@ -0,0 +1,139 @@ +<!-- ##### SECTION Title ##### --> +SoupConnection + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### MACRO SOUP_CONNECTION_ORIGIN_URI ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SOUP_CONNECTION_PROXY_URI ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SOUP_CONNECTION_SSL_CREDENTIALS ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION soup_connection_new ##### --> +<para> + +</para> + +@propname1: +@Varargs: +@Returns: + + +<!-- ##### USER_FUNCTION SoupConnectionCallback ##### --> +<para> + +</para> + +@sock: +@status: +@data: + + +<!-- ##### FUNCTION soup_connection_connect_async ##### --> +<para> + +</para> + +@conn: +@callback: +@user_data: +<!-- # Unused Parameters # --> +@Param2: + + +<!-- ##### 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_send_request ##### --> +<para> + +</para> + +@conn: +@req: + + +<!-- ##### FUNCTION soup_connection_authenticate ##### --> +<para> + +</para> + +@conn: +@msg: +@auth_type: +@auth_realm: +@username: +@password: + + +<!-- ##### FUNCTION soup_connection_reauthenticate ##### --> +<para> + +</para> + +@conn: +@msg: +@auth_type: +@auth_realm: +@username: +@password: + + diff --git a/docs/reference/tmpl/soup-dns.sgml b/docs/reference/tmpl/soup-dns.sgml new file mode 100644 index 00000000..b98bc007 --- /dev/null +++ b/docs/reference/tmpl/soup-dns.sgml @@ -0,0 +1,70 @@ +<!-- ##### SECTION Title ##### --> +soup-dns + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### FUNCTION soup_dns_entry_from_name ##### --> +<para> + +</para> + +@name: +@Returns: + + +<!-- ##### FUNCTION soup_dns_entry_from_addr ##### --> +<para> + +</para> + +@addr: +@family: +@Returns: + + +<!-- ##### FUNCTION soup_dns_entry_check_lookup ##### --> +<para> + +</para> + +@entry: +@Returns: + + +<!-- ##### FUNCTION soup_dns_entry_cancel_lookup ##### --> +<para> + +</para> + +@entry: + + +<!-- ##### FUNCTION soup_dns_free_hostent ##### --> +<para> + +</para> + +@h: + + +<!-- ##### FUNCTION soup_dns_ntop ##### --> +<para> + +</para> + +@addr: +@family: +@Returns: + + diff --git a/docs/reference/tmpl/soup-headers.sgml b/docs/reference/tmpl/soup-headers.sgml new file mode 100644 index 00000000..cec103b4 --- /dev/null +++ b/docs/reference/tmpl/soup-headers.sgml @@ -0,0 +1,92 @@ +<!-- ##### SECTION Title ##### --> +soup-headers + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### FUNCTION soup_headers_parse_request ##### --> +<para> + +</para> + +@str: +@len: +@dest: +@req_method: +@req_path: +@ver: +@Returns: + + +<!-- ##### FUNCTION soup_headers_parse_status_line ##### --> +<para> + +</para> + +@status_line: +@ver: +@status_code: +@status_phrase: +@Returns: + + +<!-- ##### FUNCTION soup_headers_parse_response ##### --> +<para> + +</para> + +@str: +@len: +@dest: +@ver: +@status_code: +@status_phrase: +@Returns: + + +<!-- ##### FUNCTION soup_header_param_decode_token ##### --> +<para> + +</para> + +@in: +@Returns: + + +<!-- ##### FUNCTION soup_header_param_parse_list ##### --> +<para> + +</para> + +@header: +@Returns: + + +<!-- ##### FUNCTION soup_header_param_copy_token ##### --> +<para> + +</para> + +@tokens: +@t: +@Returns: + + +<!-- ##### FUNCTION soup_header_param_destroy_hash ##### --> +<para> + +</para> + +@table: + + diff --git a/docs/reference/tmpl/soup-marshal.sgml b/docs/reference/tmpl/soup-marshal.sgml new file mode 100644 index 00000000..ba764273 --- /dev/null +++ b/docs/reference/tmpl/soup-marshal.sgml @@ -0,0 +1,78 @@ +<!-- ##### SECTION Title ##### --> +soup-marshal + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### MACRO soup_marshal_VOID__VOID ##### --> +<para> + +</para> + + + +<!-- ##### MACRO soup_marshal_NONE__NONE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO soup_marshal_VOID__INT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO soup_marshal_NONE__INT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO soup_marshal_VOID__OBJECT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO soup_marshal_NONE__OBJECT ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION soup_marshal_VOID__OBJECT_STRING_STRING_POINTER_POINTER ##### --> +<para> + +</para> + +@closure: +@return_value: +@n_param_values: +@param_values: +@invocation_hint: +@marshal_data: + + +<!-- ##### MACRO soup_marshal_NONE__OBJECT_STRING_STRING_POINTER_POINTER ##### --> +<para> + +</para> + + + diff --git a/docs/reference/tmpl/soup-md5-utils.sgml b/docs/reference/tmpl/soup-md5-utils.sgml new file mode 100644 index 00000000..7fd75d0a --- /dev/null +++ b/docs/reference/tmpl/soup-md5-utils.sgml @@ -0,0 +1,53 @@ +<!-- ##### SECTION Title ##### --> +soup-md5-utils + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### STRUCT SoupMD5Context ##### --> +<para> + +</para> + +@buf: +@bits: +@in: +@doByteReverse: + +<!-- ##### FUNCTION soup_md5_init ##### --> +<para> + +</para> + +@ctx: + + +<!-- ##### FUNCTION soup_md5_update ##### --> +<para> + +</para> + +@ctx: +@buf: +@len: + + +<!-- ##### FUNCTION soup_md5_final ##### --> +<para> + +</para> + +@ctx: +@digest: + + diff --git a/docs/reference/tmpl/soup-message-private.sgml b/docs/reference/tmpl/soup-message-private.sgml new file mode 100644 index 00000000..04e16f8f --- /dev/null +++ b/docs/reference/tmpl/soup-message-private.sgml @@ -0,0 +1,90 @@ +<!-- ##### SECTION Title ##### --> +soup-message-private + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### FUNCTION soup_message_run_handlers ##### --> +<para> + +</para> + +@msg: +@phase: + + +<!-- ##### FUNCTION soup_message_cleanup ##### --> +<para> + +</para> + +@req: + + +<!-- ##### FUNCTION soup_message_cleanup_response ##### --> +<para> + +</para> + +@req: + + +<!-- ##### 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: + + +<!-- ##### FUNCTION soup_message_io_client ##### --> +<para> + +</para> + +@msg: +@sock: +@get_headers_cb: +@parse_headers_cb: +@user_data: + + +<!-- ##### FUNCTION soup_message_io_server ##### --> +<para> + +</para> + +@msg: +@sock: +@get_headers_cb: +@parse_headers_cb: +@user_data: + + diff --git a/docs/reference/tmpl/soup-message-queue.sgml b/docs/reference/tmpl/soup-message-queue.sgml new file mode 100644 index 00000000..7ff6122a --- /dev/null +++ b/docs/reference/tmpl/soup-message-queue.sgml @@ -0,0 +1,97 @@ +<!-- ##### SECTION Title ##### --> +soup-message-queue + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### STRUCT SoupMessageQueueIter ##### --> +<para> + +</para> + +@cur: +@next: + +<!-- ##### FUNCTION soup_message_queue_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION soup_message_queue_append ##### --> +<para> + +</para> + +@queue: +@msg: + + +<!-- ##### FUNCTION soup_message_queue_first ##### --> +<para> + +</para> + +@queue: +@iter: +@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_free_iter ##### --> +<para> + +</para> + +@queue: +@iter: + + +<!-- ##### FUNCTION soup_message_queue_destroy ##### --> +<para> + +</para> + +@queue: + + +<!-- ##### FUNCTION soup_message_queue_remove_message ##### --> +<para> + +</para> + +@queue: +@msg: + + diff --git a/docs/reference/tmpl/soup-message.sgml b/docs/reference/tmpl/soup-message.sgml new file mode 100644 index 00000000..ebb0c160 --- /dev/null +++ b/docs/reference/tmpl/soup-message.sgml @@ -0,0 +1,499 @@ +<!-- ##### SECTION Title ##### --> +SoupMessage + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<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: + +<!-- ##### MACRO SOUP_MESSAGE_IS_STARTING ##### --> +<para> + +</para> + +@msg: + + +<!-- ##### ENUM SoupTransferEncoding ##### --> +<para> + +</para> + +@SOUP_TRANSFER_UNKNOWN: +@SOUP_TRANSFER_CHUNKED: +@SOUP_TRANSFER_CONTENT_LENGTH: + +<!-- ##### ENUM SoupOwnership ##### --> +<para> + +</para> + +@SOUP_BUFFER_SYSTEM_OWNED: +@SOUP_BUFFER_USER_OWNED: +@SOUP_BUFFER_STATIC: + +<!-- ##### STRUCT SoupDataBuffer ##### --> +<para> + +</para> + +@owner: +@body: +@length: + +<!-- ##### USER_FUNCTION SoupMessageCallbackFn ##### --> +<para> + +</para> + +@req: +@user_data: + + +<!-- ##### FUNCTION soup_message_new ##### --> +<para> + +</para> + +@method: +@uri_string: +@Returns: +<!-- # Unused Parameters # --> +@uri: + + +<!-- ##### FUNCTION soup_message_new_from_uri ##### --> +<para> + +</para> + +@method: +@uri: +@Returns: + + +<!-- ##### FUNCTION soup_message_set_request ##### --> +<para> + +</para> + +@msg: +@content_type: +@req_owner: +@req_body: +@req_length: +<!-- # Unused Parameters # --> +@req_len: + + +<!-- ##### FUNCTION soup_message_set_response ##### --> +<para> + +</para> + +@msg: +@content_type: +@resp_owner: +@resp_body: +@resp_length: +<!-- # Unused Parameters # --> +@resp_len: + + +<!-- ##### FUNCTION soup_message_cancel ##### --> +<para> + +</para> + +@msg: +<!-- # Unused Parameters # --> +@req: + + +<!-- ##### 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 ##### --> +<para> + +</para> + +@SOUP_HTTP_1_0: +@SOUP_HTTP_1_1: + +<!-- ##### FUNCTION soup_message_set_http_version ##### --> +<para> + +</para> + +@msg: +@version: + + +<!-- ##### FUNCTION soup_message_get_http_version ##### --> +<para> + +</para> + +@msg: +@Returns: + + +<!-- ##### FUNCTION soup_message_is_keepalive ##### --> +<para> + +</para> + +@msg: +@Returns: + + +<!-- ##### FUNCTION soup_message_get_uri ##### --> +<para> + +</para> + +@msg: +@Returns: + + +<!-- ##### FUNCTION soup_message_set_uri ##### --> +<para> + +</para> + +@msg: +@uri: + + +<!-- ##### ENUM SoupMessageFlags ##### --> +<para> + +</para> + +@SOUP_MESSAGE_NO_PIPELINE: +@SOUP_MESSAGE_NO_REDIRECT: +@SOUP_MESSAGE_NO_COOKIE: +@SOUP_MESSAGE_OVERWRITE_CHUNKS: +@SOUP_MESSAGE_EXPECT_CONTINUE: + +<!-- ##### FUNCTION soup_message_set_flags ##### --> +<para> + +</para> + +@msg: +@flags: + + +<!-- ##### FUNCTION soup_message_get_flags ##### --> +<para> + +</para> + +@msg: +@Returns: + + +<!-- ##### ENUM SoupHandlerPhase ##### --> +<para> + +</para> + +@SOUP_HANDLER_PRE_BODY: +@SOUP_HANDLER_BODY_CHUNK: +@SOUP_HANDLER_POST_BODY: + +<!-- ##### FUNCTION soup_message_add_handler ##### --> +<para> + +</para> + +@msg: +@type: +@handler_cb: +@user_data: + + +<!-- ##### FUNCTION soup_message_add_header_handler ##### --> +<para> + +</para> + +@msg: +@header: +@type: +@Param4: +@user_data: + + +<!-- ##### FUNCTION soup_message_add_status_code_handler ##### --> +<para> + +</para> + +@msg: +@status_code: +@type: +@Param4: +@user_data: + + +<!-- ##### FUNCTION soup_message_add_status_class_handler ##### --> +<para> + +</para> + +@msg: +@status_class: +@type: +@Param4: +@user_data: + + +<!-- ##### FUNCTION soup_message_remove_handler ##### --> +<para> + +</para> + +@msg: +@type: +@Param3: +@user_data: + + +<!-- ##### FUNCTION soup_message_set_status ##### --> +<para> + +</para> + +@msg: +@status_code: + + +<!-- ##### FUNCTION soup_message_set_status_full ##### --> +<para> + +</para> + +@msg: +@status_code: +@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_send_request ##### --> +<para> + +</para> + +@req: +@sock: +@via_proxy: + + +<!-- ##### FUNCTION soup_message_read_request ##### --> +<para> + +</para> + +@req: +@sock: + + +<!-- ##### FUNCTION soup_message_io_cancel ##### --> +<para> + +</para> + +@msg: + + +<!-- ##### FUNCTION soup_message_io_pause ##### --> +<para> + +</para> + +@msg: + + +<!-- ##### FUNCTION soup_message_io_unpause ##### --> +<para> + +</para> + +@msg: + + +<!-- ##### FUNCTION soup_message_wrote_informational ##### --> +<para> + +</para> + +@msg: + + +<!-- ##### FUNCTION soup_message_wrote_headers ##### --> +<para> + +</para> + +@msg: + + +<!-- ##### FUNCTION soup_message_wrote_chunk ##### --> +<para> + +</para> + +@msg: + + +<!-- ##### FUNCTION soup_message_wrote_body ##### --> +<para> + +</para> + +@msg: + + +<!-- ##### FUNCTION soup_message_got_informational ##### --> +<para> + +</para> + +@msg: + + +<!-- ##### FUNCTION soup_message_got_headers ##### --> +<para> + +</para> + +@msg: + + +<!-- ##### FUNCTION soup_message_got_chunk ##### --> +<para> + +</para> + +@msg: + + +<!-- ##### FUNCTION soup_message_got_body ##### --> +<para> + +</para> + +@msg: + + +<!-- ##### FUNCTION soup_message_finished ##### --> +<para> + +</para> + +@msg: + + diff --git a/docs/reference/tmpl/soup-method.sgml b/docs/reference/tmpl/soup-method.sgml new file mode 100644 index 00000000..f4c39d8a --- /dev/null +++ b/docs/reference/tmpl/soup-method.sgml @@ -0,0 +1,160 @@ +<!-- ##### SECTION Title ##### --> +soup-method + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### MACRO SOUP_METHOD_POST ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SOUP_METHOD_GET ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SOUP_METHOD_HEAD ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SOUP_METHOD_OPTIONS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SOUP_METHOD_PUT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SOUP_METHOD_MOVE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SOUP_METHOD_COPY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SOUP_METHOD_DELETE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SOUP_METHOD_TRACE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SOUP_METHOD_CONNECT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SOUP_METHOD_MKCOL ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SOUP_METHOD_PROPPATCH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SOUP_METHOD_PROPFIND ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SOUP_METHOD_PATCH ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SOUP_METHOD_LOCK ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SOUP_METHOD_UNLOCK ##### --> +<para> + +</para> + + + +<!-- ##### ENUM SoupMethodId ##### --> +<para> + +</para> + +@SOUP_METHOD_ID_UNKNOWN: +@SOUP_METHOD_ID_POST: +@SOUP_METHOD_ID_GET: +@SOUP_METHOD_ID_HEAD: +@SOUP_METHOD_ID_OPTIONS: +@SOUP_METHOD_ID_PUT: +@SOUP_METHOD_ID_MOVE: +@SOUP_METHOD_ID_COPY: +@SOUP_METHOD_ID_DELETE: +@SOUP_METHOD_ID_TRACE: +@SOUP_METHOD_ID_CONNECT: +@SOUP_METHOD_ID_MKCOL: +@SOUP_METHOD_ID_PROPPATCH: +@SOUP_METHOD_ID_PROPFIND: +@SOUP_METHOD_ID_PATCH: +@SOUP_METHOD_ID_LOCK: +@SOUP_METHOD_ID_UNLOCK: + +<!-- ##### FUNCTION soup_method_get_id ##### --> +<para> + +</para> + +@method: +@Returns: + + diff --git a/docs/reference/tmpl/soup-misc.sgml b/docs/reference/tmpl/soup-misc.sgml new file mode 100644 index 00000000..c7fb37c6 --- /dev/null +++ b/docs/reference/tmpl/soup-misc.sgml @@ -0,0 +1,116 @@ +<!-- ##### SECTION Title ##### --> +soup-misc + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### 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_base64_decode ##### --> +<para> + +</para> + +@text: +@out_len: +@Returns: + + +<!-- ##### FUNCTION soup_base64_decode_step ##### --> +<para> + +</para> + +@in: +@len: +@out: +@state: +@save: +@Returns: + + +<!-- ##### FUNCTION soup_signal_connect_once ##### --> +<para> + +</para> + +@instance: +@detailed_signal: +@c_handler: +@data: +@Returns: +<!-- # Unused Parameters # --> +@signal: + + +<!-- ##### FUNCTION soup_str_case_hash ##### --> +<para> + +</para> + +@key: +@Returns: + + +<!-- ##### FUNCTION soup_str_case_equal ##### --> +<para> + +</para> + +@v1: +@v2: +@Returns: + + +<!-- ##### VARIABLE soup_ssl_supported ##### --> +<para> + +</para> + + diff --git a/docs/reference/tmpl/soup-server-auth.sgml b/docs/reference/tmpl/soup-server-auth.sgml new file mode 100644 index 00000000..2497ce4e --- /dev/null +++ b/docs/reference/tmpl/soup-server-auth.sgml @@ -0,0 +1,118 @@ +<!-- ##### SECTION Title ##### --> +soup-server-auth + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### USER_FUNCTION SoupServerAuthCallbackFn ##### --> +<para> + +</para> + +@auth_ctx: +@auth: +@msg: +@data: +@Returns: + + +<!-- ##### FUNCTION soup_server_auth_context_challenge ##### --> +<para> + +</para> + +@auth_ctx: +@msg: +@header_name: + + +<!-- ##### ENUM SoupAuthType ##### --> +<para> + +</para> + +@SOUP_AUTH_TYPE_BASIC: +@SOUP_AUTH_TYPE_DIGEST: + +<!-- ##### STRUCT SoupServerAuthBasic ##### --> +<para> + +</para> + +@type: +@user: +@passwd: + +<!-- ##### ENUM SoupDigestAlgorithm ##### --> +<para> + +</para> + +@SOUP_ALGORITHM_MD5: +@SOUP_ALGORITHM_MD5_SESS: + +<!-- ##### STRUCT SoupServerAuthDigest ##### --> +<para> + +</para> + +@type: +@algorithm: +@integrity: +@realm: +@user: +@nonce: +@nonce_count: +@cnonce: +@digest_uri: +@digest_response: +@request_method: + +<!-- ##### FUNCTION soup_server_auth_new ##### --> +<para> + +</para> + +@auth_ctx: +@auth_hdrs: +@msg: +@Returns: + + +<!-- ##### FUNCTION soup_server_auth_free ##### --> +<para> + +</para> + +@auth: + + +<!-- ##### FUNCTION soup_server_auth_get_user ##### --> +<para> + +</para> + +@auth: +@Returns: + + +<!-- ##### FUNCTION soup_server_auth_check_passwd ##### --> +<para> + +</para> + +@auth: +@passwd: +@Returns: + + diff --git a/docs/reference/tmpl/soup-server-message.sgml b/docs/reference/tmpl/soup-server-message.sgml new file mode 100644 index 00000000..09bb7b82 --- /dev/null +++ b/docs/reference/tmpl/soup-server-message.sgml @@ -0,0 +1,86 @@ +<!-- ##### SECTION Title ##### --> +SoupServerMessage + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### FUNCTION soup_server_message_new ##### --> +<para> + +</para> + +@server: +@Returns: + + +<!-- ##### FUNCTION soup_server_message_get_server ##### --> +<para> + +</para> + +@smsg: +@Returns: + + +<!-- ##### FUNCTION soup_server_message_set_encoding ##### --> +<para> + +</para> + +@smsg: +@encoding: + + +<!-- ##### FUNCTION soup_server_message_get_encoding ##### --> +<para> + +</para> + +@smsg: +@Returns: + + +<!-- ##### FUNCTION soup_server_message_start ##### --> +<para> + +</para> + +@smsg: + + +<!-- ##### FUNCTION soup_server_message_is_started ##### --> +<para> + +</para> + +@smsg: +@Returns: + + +<!-- ##### FUNCTION soup_server_message_finish ##### --> +<para> + +</para> + +@smsg: + + +<!-- ##### FUNCTION soup_server_message_is_finished ##### --> +<para> + +</para> + +@smsg: +@Returns: + + diff --git a/docs/reference/tmpl/soup-server.sgml b/docs/reference/tmpl/soup-server.sgml new file mode 100644 index 00000000..11436c17 --- /dev/null +++ b/docs/reference/tmpl/soup-server.sgml @@ -0,0 +1,188 @@ +<!-- ##### SECTION Title ##### --> +SoupServer + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### STRUCT SoupServerContext ##### --> +<para> + +</para> + +@msg: +@path: +@method_id: +@auth: +@server: +@handler: +@sock: + +<!-- ##### USER_FUNCTION SoupServerCallbackFn ##### --> +<para> + +</para> + +@context: +@msg: +@user_data: + + +<!-- ##### USER_FUNCTION SoupServerUnregisterFn ##### --> +<para> + +</para> + +@server: +@handler: +@user_data: + + +<!-- ##### MACRO SOUP_SERVER_PORT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SOUP_SERVER_INTERFACE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SOUP_SERVER_SSL_CERT_FILE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SOUP_SERVER_SSL_KEY_FILE ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION soup_server_new ##### --> +<para> + +</para> + +@optname1: +@Varargs: +@Returns: + + +<!-- ##### FUNCTION soup_server_get_protocol ##### --> +<para> + +</para> + +@serv: +@Returns: + + +<!-- ##### FUNCTION soup_server_get_port ##### --> +<para> + +</para> + +@serv: +@Returns: + + +<!-- ##### FUNCTION soup_server_run ##### --> +<para> + +</para> + +@serv: + + +<!-- ##### FUNCTION soup_server_run_async ##### --> +<para> + +</para> + +@serv: + + +<!-- ##### FUNCTION soup_server_quit ##### --> +<para> + +</para> + +@serv: + + +<!-- ##### FUNCTION soup_server_add_handler ##### --> +<para> + +</para> + +@serv: +@path: +@auth_ctx: +@callback: +@unreg: +@data: + + +<!-- ##### FUNCTION soup_server_remove_handler ##### --> +<para> + +</para> + +@serv: +@path: + + +<!-- ##### FUNCTION soup_server_get_handler ##### --> +<para> + +</para> + +@serv: +@path: +@Returns: + + +<!-- ##### FUNCTION soup_server_list_handlers ##### --> +<para> + +</para> + +@serv: +@Returns: + + +<!-- ##### FUNCTION soup_server_context_get_client_address ##### --> +<para> + +</para> + +@ctx: +@Returns: + + +<!-- ##### FUNCTION soup_server_context_get_client_host ##### --> +<para> + +</para> + +@ctx: +@Returns: + + diff --git a/docs/reference/tmpl/soup-session.sgml b/docs/reference/tmpl/soup-session.sgml new file mode 100644 index 00000000..0fea40f8 --- /dev/null +++ b/docs/reference/tmpl/soup-session.sgml @@ -0,0 +1,107 @@ +<!-- ##### SECTION Title ##### --> +SoupSession + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### MACRO SOUP_SESSION_PROXY_URI ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SOUP_SESSION_MAX_CONNS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SOUP_SESSION_MAX_CONNS_PER_HOST ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SOUP_SESSION_USE_NTLM ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SOUP_SESSION_SSL_CA_FILE ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION soup_session_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION soup_session_new_with_options ##### --> +<para> + +</para> + +@optname1: +@Varargs: +@Returns: + + +<!-- ##### FUNCTION soup_session_queue_message ##### --> +<para> + +</para> + +@session: +@req: +@callback: +@user_data: + + +<!-- ##### FUNCTION soup_session_requeue_message ##### --> +<para> + +</para> + +@session: +@req: + + +<!-- ##### FUNCTION soup_session_send_message ##### --> +<para> + +</para> + +@session: +@req: +@Returns: + + +<!-- ##### FUNCTION soup_session_abort ##### --> +<para> + +</para> + +@session: + + diff --git a/docs/reference/tmpl/soup-soap-message.sgml b/docs/reference/tmpl/soup-soap-message.sgml new file mode 100644 index 00000000..f6f36669 --- /dev/null +++ b/docs/reference/tmpl/soup-soap-message.sgml @@ -0,0 +1,321 @@ +<!-- ##### SECTION Title ##### --> +SoupSoapMessage + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### STRUCT SoupSoapMessage ##### --> +<para> + +</para> + + +<!-- ##### 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_start_envelope ##### --> +<para> + +</para> + +@msg: + + +<!-- ##### FUNCTION soup_soap_message_end_envelope ##### --> +<para> + +</para> + +@msg: + + +<!-- ##### FUNCTION soup_soap_message_start_body ##### --> +<para> + +</para> + +@msg: + + +<!-- ##### FUNCTION soup_soap_message_end_body ##### --> +<para> + +</para> + +@msg: + + +<!-- ##### FUNCTION soup_soap_message_start_element ##### --> +<para> + +</para> + +@msg: +@name: +@prefix: +@ns_uri: + + +<!-- ##### FUNCTION soup_soap_message_end_element ##### --> +<para> + +</para> + +@msg: + + +<!-- ##### FUNCTION soup_soap_message_start_fault ##### --> +<para> + +</para> + +@msg: +@faultcode: +@faultstring: +@faultfactor: + + +<!-- ##### FUNCTION soup_soap_message_end_fault ##### --> +<para> + +</para> + +@msg: + + +<!-- ##### FUNCTION soup_soap_message_start_fault_detail ##### --> +<para> + +</para> + +@msg: + + +<!-- ##### FUNCTION soup_soap_message_end_fault_detail ##### --> +<para> + +</para> + +@msg: + + +<!-- ##### FUNCTION soup_soap_message_start_header ##### --> +<para> + +</para> + +@msg: + + +<!-- ##### FUNCTION soup_soap_message_end_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_end_header_element ##### --> +<para> + +</para> + +@msg: + + +<!-- ##### FUNCTION soup_soap_message_write_int ##### --> +<para> + +</para> + +@msg: +@Param2: + + +<!-- ##### FUNCTION soup_soap_message_write_double ##### --> +<para> + +</para> + +@msg: +@d: + + +<!-- ##### FUNCTION soup_soap_message_write_base64 ##### --> +<para> + +</para> + +@msg: +@string: +@len: + + +<!-- ##### FUNCTION soup_soap_message_write_time ##### --> +<para> + +</para> + +@msg: +@timeval: + + +<!-- ##### FUNCTION soup_soap_message_write_string ##### --> +<para> + +</para> + +@msg: +@string: + + +<!-- ##### FUNCTION soup_soap_message_write_buffer ##### --> +<para> + +</para> + +@msg: +@buffer: +@len: + + +<!-- ##### FUNCTION soup_soap_message_set_element_type ##### --> +<para> + +</para> + +@msg: +@xsi_type: + + +<!-- ##### FUNCTION soup_soap_message_set_null ##### --> +<para> + +</para> + +@msg: + + +<!-- ##### 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_set_default_namespace ##### --> +<para> + +</para> + +@msg: +@ns_uri: + + +<!-- ##### FUNCTION soup_soap_message_set_encoding_style ##### --> +<para> + +</para> + +@msg: +@enc_style: + + +<!-- ##### FUNCTION soup_soap_message_reset ##### --> +<para> + +</para> + +@msg: + + +<!-- ##### FUNCTION soup_soap_message_persist ##### --> +<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: + + diff --git a/docs/reference/tmpl/soup-socket.sgml b/docs/reference/tmpl/soup-socket.sgml new file mode 100644 index 00000000..e5716dbe --- /dev/null +++ b/docs/reference/tmpl/soup-socket.sgml @@ -0,0 +1,237 @@ +<!-- ##### SECTION Title ##### --> +SoupSocket + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### MACRO SOUP_SOCKET_FLAG_NONBLOCKING ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SOUP_SOCKET_FLAG_NODELAY ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SOUP_SOCKET_FLAG_REUSEADDR ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SOUP_SOCKET_IS_SERVER ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SOUP_SOCKET_SSL_CREDENTIALS ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION soup_socket_new ##### --> +<para> + +</para> + +@optname1: +@Varargs: +@Returns: + + +<!-- ##### FUNCTION soup_socket_connect ##### --> +<para> + +</para> + +@sock: +@remote_addr: +@Returns: +<!-- # Unused Parameters # --> +@rem_addr: + + +<!-- ##### FUNCTION soup_socket_listen ##### --> +<para> + +</para> + +@sock: +@local_addr: +@Returns: + + +<!-- ##### FUNCTION soup_socket_start_ssl ##### --> +<para> + +</para> + +@sock: +@Returns: + + +<!-- ##### FUNCTION soup_socket_disconnect ##### --> +<para> + +</para> + +@sock: + + +<!-- ##### FUNCTION soup_socket_is_connected ##### --> +<para> + +</para> + +@sock: +@Returns: + + +<!-- ##### USER_FUNCTION SoupSocketCallback ##### --> +<para> + +</para> + +@sock: +@status: +@user_data: + + +<!-- ##### USER_FUNCTION SoupSocketListenerCallback ##### --> +<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: +<!-- # Unused Parameters # --> +@status: + + +<!-- ##### FUNCTION soup_socket_server_new ##### --> +<para> + +</para> + +@local_addr: +@ssl_creds: +@callback: +@user_data: +@Returns: +<!-- # Unused Parameters # --> +@Param3: + + +<!-- ##### FUNCTION soup_socket_get_local_address ##### --> +<para> + +</para> + +@sock: +@Returns: + + +<!-- ##### FUNCTION soup_socket_get_remote_address ##### --> +<para> + +</para> + +@sock: +@Returns: + + +<!-- ##### ENUM SoupSocketIOStatus ##### --> +<para> + +</para> + +@SOUP_SOCKET_OK: +@SOUP_SOCKET_WOULD_BLOCK: +@SOUP_SOCKET_EOF: +@SOUP_SOCKET_ERROR: + +<!-- ##### FUNCTION soup_socket_read ##### --> +<para> + +</para> + +@sock: +@buffer: +@len: +@nread: +@Returns: + + +<!-- ##### FUNCTION soup_socket_read_until ##### --> +<para> + +</para> + +@sock: +@buffer: +@len: +@boundary: +@boundary_len: +@nread: +@got_boundary: +@Returns: + + +<!-- ##### FUNCTION soup_socket_write ##### --> +<para> + +</para> + +@sock: +@buffer: +@len: +@nwrote: +@Returns: + + diff --git a/docs/reference/tmpl/soup-ssl.sgml b/docs/reference/tmpl/soup-ssl.sgml new file mode 100644 index 00000000..e2e9b9a2 --- /dev/null +++ b/docs/reference/tmpl/soup-ssl.sgml @@ -0,0 +1,71 @@ +<!-- ##### SECTION Title ##### --> +soup-ssl + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### ENUM SoupSSLType ##### --> +<para> + +</para> + +@SOUP_SSL_TYPE_CLIENT: +@SOUP_SSL_TYPE_SERVER: + +<!-- ##### FUNCTION soup_ssl_get_client_credentials ##### --> +<para> + +</para> + +@ca_file: +@Returns: + + +<!-- ##### FUNCTION soup_ssl_free_client_credentials ##### --> +<para> + +</para> + +@creds: + + +<!-- ##### FUNCTION soup_ssl_get_server_credentials ##### --> +<para> + +</para> + +@cert_file: +@key_file: +@Returns: + + +<!-- ##### FUNCTION soup_ssl_free_server_credentials ##### --> +<para> + +</para> + +@creds: + + +<!-- ##### FUNCTION soup_ssl_wrap_iochannel ##### --> +<para> + +</para> + +@sock: +@type: +@remote_host: +@credentials: +@Returns: + + diff --git a/docs/reference/tmpl/soup-status.sgml b/docs/reference/tmpl/soup-status.sgml new file mode 100644 index 00000000..f94bf70a --- /dev/null +++ b/docs/reference/tmpl/soup-status.sgml @@ -0,0 +1,142 @@ +<!-- ##### SECTION Title ##### --> +soup-status + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### 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: + +<!-- ##### MACRO SOUP_STATUS_IS_INFORMATIONAL ##### --> +<para> + +</para> + +@x: + + +<!-- ##### MACRO SOUP_STATUS_IS_SUCCESSFUL ##### --> +<para> + +</para> + +@x: + + +<!-- ##### MACRO SOUP_STATUS_IS_REDIRECTION ##### --> +<para> + +</para> + +@x: + + +<!-- ##### MACRO SOUP_STATUS_IS_CLIENT_ERROR ##### --> +<para> + +</para> + +@x: + + +<!-- ##### MACRO SOUP_STATUS_IS_SERVER_ERROR ##### --> +<para> + +</para> + +@x: + + +<!-- ##### ENUM SoupKnownStatusCode ##### --> +<para> + +</para> + +@SOUP_STATUS_CANCELLED: +@SOUP_STATUS_CANT_RESOLVE: +@SOUP_STATUS_CANT_RESOLVE_PROXY: +@SOUP_STATUS_CANT_CONNECT: +@SOUP_STATUS_CANT_CONNECT_PROXY: +@SOUP_STATUS_SSL_FAILED: +@SOUP_STATUS_IO_ERROR: +@SOUP_STATUS_MALFORMED: +@SOUP_STATUS_CONTINUE: +@SOUP_STATUS_SWITCHING_PROTOCOLS: +@SOUP_STATUS_PROCESSING: +@SOUP_STATUS_OK: +@SOUP_STATUS_CREATED: +@SOUP_STATUS_ACCEPTED: +@SOUP_STATUS_NON_AUTHORITATIVE: +@SOUP_STATUS_NO_CONTENT: +@SOUP_STATUS_RESET_CONTENT: +@SOUP_STATUS_PARTIAL_CONTENT: +@SOUP_STATUS_MULTI_STATUS: +@SOUP_STATUS_MULTIPLE_CHOICES: +@SOUP_STATUS_MOVED_PERMANENTLY: +@SOUP_STATUS_FOUND: +@SOUP_STATUS_MOVED_TEMPORARILY: +@SOUP_STATUS_SEE_OTHER: +@SOUP_STATUS_NOT_MODIFIED: +@SOUP_STATUS_USE_PROXY: +@SOUP_STATUS_NOT_APPEARING_IN_THIS_PROTOCOL: +@SOUP_STATUS_TEMPORARY_REDIRECT: +@SOUP_STATUS_BAD_REQUEST: +@SOUP_STATUS_UNAUTHORIZED: +@SOUP_STATUS_PAYMENT_REQUIRED: +@SOUP_STATUS_FORBIDDEN: +@SOUP_STATUS_NOT_FOUND: +@SOUP_STATUS_METHOD_NOT_ALLOWED: +@SOUP_STATUS_NOT_ACCEPTABLE: +@SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED: +@SOUP_STATUS_PROXY_UNAUTHORIZED: +@SOUP_STATUS_REQUEST_TIMEOUT: +@SOUP_STATUS_CONFLICT: +@SOUP_STATUS_GONE: +@SOUP_STATUS_LENGTH_REQUIRED: +@SOUP_STATUS_PRECONDITION_FAILED: +@SOUP_STATUS_REQUEST_ENTITY_TOO_LARGE: +@SOUP_STATUS_REQUEST_URI_TOO_LONG: +@SOUP_STATUS_UNSUPPORTED_MEDIA_TYPE: +@SOUP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE: +@SOUP_STATUS_INVALID_RANGE: +@SOUP_STATUS_EXPECTATION_FAILED: +@SOUP_STATUS_UNPROCESSABLE_ENTITY: +@SOUP_STATUS_LOCKED: +@SOUP_STATUS_FAILED_DEPENDENCY: +@SOUP_STATUS_INTERNAL_SERVER_ERROR: +@SOUP_STATUS_NOT_IMPLEMENTED: +@SOUP_STATUS_BAD_GATEWAY: +@SOUP_STATUS_SERVICE_UNAVAILABLE: +@SOUP_STATUS_GATEWAY_TIMEOUT: +@SOUP_STATUS_HTTP_VERSION_NOT_SUPPORTED: +@SOUP_STATUS_INSUFFICIENT_STORAGE: +@SOUP_STATUS_NOT_EXTENDED: + +<!-- ##### FUNCTION soup_status_get_phrase ##### --> +<para> + +</para> + +@status_code: +@Returns: + + diff --git a/docs/reference/tmpl/soup-types.sgml b/docs/reference/tmpl/soup-types.sgml new file mode 100644 index 00000000..02ad0554 --- /dev/null +++ b/docs/reference/tmpl/soup-types.sgml @@ -0,0 +1,28 @@ +<!-- ##### SECTION Title ##### --> +soup-types + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### MACRO SOUP_MAKE_TYPE ##### --> +<para> + +</para> + +@l: +@t: +@ci: +@i: +@parent: + + diff --git a/docs/reference/tmpl/soup-uri.sgml b/docs/reference/tmpl/soup-uri.sgml new file mode 100644 index 00000000..c344f580 --- /dev/null +++ b/docs/reference/tmpl/soup-uri.sgml @@ -0,0 +1,128 @@ +<!-- ##### SECTION Title ##### --> +soup-uri + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### TYPEDEF SoupProtocol ##### --> +<para> + +</para> + + +<!-- ##### MACRO SOUP_PROTOCOL_HTTP ##### --> +<para> + +</para> + + + +<!-- ##### MACRO SOUP_PROTOCOL_HTTPS ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION soup_uri_new_with_base ##### --> +<para> + +</para> + +@base: +@uri_string: +@Returns: + + +<!-- ##### FUNCTION soup_uri_new ##### --> +<para> + +</para> + +@uri_string: +@Returns: + + +<!-- ##### FUNCTION soup_uri_to_string ##### --> +<para> + +</para> + +@uri: +@just_path: +@Returns: + + +<!-- ##### FUNCTION soup_uri_copy ##### --> +<para> + +</para> + +@uri: +@Returns: + + +<!-- ##### FUNCTION soup_uri_copy_root ##### --> +<para> + +</para> + +@uri: +@Returns: + + +<!-- ##### FUNCTION soup_uri_equal ##### --> +<para> + +</para> + +@uri1: +@uri2: +@Returns: + + +<!-- ##### FUNCTION soup_uri_free ##### --> +<para> + +</para> + +@uri: + + +<!-- ##### FUNCTION soup_uri_encode ##### --> +<para> + +</para> + +@part: +@escape_extra: +@Returns: + + +<!-- ##### FUNCTION soup_uri_decode ##### --> +<para> + +</para> + +@part: + + +<!-- ##### FUNCTION soup_uri_uses_default_port ##### --> +<para> + +</para> + +@uri: +@Returns: + + |