Mercurial Mercurial > loudmouth / diff
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs/reference/tmpl/.svn/text-base/lm-connection.sgml.svn-base
changeset 2 f5b19569e1bc
parent 1 50e230cf7818
child 3 5c632650c603 
--- a/docs/reference/tmpl/.svn/text-base/lm-connection.sgml.svn-base	Mon May 19 18:27:00 2003 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,323 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-LmConnection
-
-<!-- ##### SECTION Short_Description ##### -->
-A client connection to the server
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### MACRO LM_CONNECTION ##### -->
-<para>
-Convenience macro used to cast a pointer to a #LmConnection.
-</para>
-
-@o: pointer to cast
-
-
-<!-- ##### MACRO LM_CONNECTION_DEFAULT_PORT ##### -->
-<para>
-Default jabber client port.
-</para>
-
-
-
-<!-- ##### MACRO LM_CONNECTION_DEFAULT_PORT_SSL ##### -->
-<para>
-Default jabber client port when using SSL encryption.
-</para>
-
-
-
-<!-- ##### STRUCT LmConnection ##### -->
-<para>
-This should not be accessed directly. Use the accessor functions as described below.
-</para>
-
-
-<!-- ##### ENUM LmHandlerResult ##### -->
-<para>
-The return type of an LmMessageHandler. This determines whether more message handlers should be called.
-</para>
-
-@LM_HANDLER_RESULT_REMOVE_MESSAGE: Stop calling message handlers. The message handler returning this declares the message has been handled and should be removed.
-@LM_HANDLER_RESULT_ALLOW_MORE_HANDLERS: Return to continue the calling handlers from the handler list. This declares that another handlers should handle the message.
-
-<!-- ##### ENUM LmHandlerPriority ##### -->
-<para>
-Since the handlers decide whether to stop the calling chain with there return values it's sometimes decirable to be able to set priority. For example a handler that only logs all incoming messages and then pass the message on to another handler wants to have priority %LM_HANDLER_PRIORITY_FIRST. An handler that should take all messages that wasn't handled by anything else would want to have priority %LM_HANDLER_PRIORITY_LAST. If several handlers have the same priority nothing can be side about which handler will be called first of them.
-</para>
-
-@LM_HANDLER_PRIORITY_LAST: Call the handler after all handlers with #NORMAL and #FIRST priority.
-@LM_HANDLER_PRIORITY_NORMAL: Called before handlers with priority #LAST and after those with #FIRST.
-@LM_HANDLER_PRIORITY_FIRST: These are called before all other handlers.
-
-<!-- ##### ENUM LmDisconnectReason ##### -->
-<para>
-Sent with #LmDisconnectFunction to describe why a connection was closed.
-</para>
-
-@LM_DISCONNECT_REASON_OK: 
-@LM_DISCONNECT_REASON_PING_TIME_OUT: Connection to the server pinged out.
-@LM_DISCONNECT_REASON_HUP: The socket emitted that the connection was hung up.
-@LM_DISCONNECT_REASON_ERROR: A generic error somewhere in the transport layer.
-@LM_DISCONNECT_REASON_UNKNOWN: An unknown error.
-
-<!-- ##### USER_FUNCTION LmResultFunction ##### -->
-<para>
-Callback for informing if an asynchronous operation was successful.
-</para>
-
-@connection: an #LmConnection
-@success: the result, %TRUE if operation succeeded, otherwise %FALSE
-@user_data: User data passed when function being called.
-
-
-<!-- ##### USER_FUNCTION LmDisconnectFunction ##### -->
-<para>
-Callback called when a connection is closed.
-</para>
-
-@connection: an #LmConnection
-@reason: the reason the connection was closed.
-@user_data: User data passed when function being called.
-
-
-<!-- ##### FUNCTION lm_connection_new ##### -->
-<para>
-
-</para>
-
-@server: 
-@Returns: 
-
-
-<!-- ##### FUNCTION lm_connection_open ##### -->
-<para>
-
-</para>
-
-@connection: 
-@function: 
-@user_data: 
-@notify: 
-@error: 
-@Returns: 
-
-
-<!-- ##### FUNCTION lm_connection_open_and_block ##### -->
-<para>
-
-</para>
-
-@connection: 
-@error: 
-@Returns: 
-
-
-<!-- ##### FUNCTION lm_connection_close ##### -->
-<para>
-
-</para>
-
-@connection: 
-@error: 
-@Returns: 
-
-
-<!-- ##### FUNCTION lm_connection_authenticate ##### -->
-<para>
-
-</para>
-
-@connection: 
-@username: 
-@password: 
-@resource: 
-@function: 
-@user_data: 
-@notify: 
-@error: 
-@Returns: 
-
-
-<!-- ##### FUNCTION lm_connection_authenticate_and_block ##### -->
-<para>
-
-</para>
-
-@connection: 
-@username: 
-@password: 
-@resource: 
-@error: 
-@Returns: 
-
-
-<!-- ##### FUNCTION lm_connection_is_authenticated ##### -->
-<para>
-
-</para>
-
-@connection: 
-@Returns: 
-
-
-<!-- ##### FUNCTION lm_connection_get_server ##### -->
-<para>
-
-</para>
-
-@connection: 
-@Returns: 
-
-
-<!-- ##### FUNCTION lm_connection_set_server ##### -->
-<para>
-
-</para>
-
-@connection: 
-@server: 
-
-
-<!-- ##### FUNCTION lm_connection_get_port ##### -->
-<para>
-
-</para>
-
-@connection: 
-@Returns: 
-
-
-<!-- ##### FUNCTION lm_connection_set_port ##### -->
-<para>
-
-</para>
-
-@connection: 
-@port: 
-
-
-<!-- ##### FUNCTION lm_connection_get_use_ssl ##### -->
-<para>
-
-</para>
-
-@connection: 
-@Returns: 
-
-
-<!-- ##### FUNCTION lm_connection_set_use_ssl ##### -->
-<para>
-
-</para>
-
-@connection: 
-@use_ssl: 
-
-
-<!-- ##### FUNCTION lm_connection_send ##### -->
-<para>
-
-</para>
-
-@connection: 
-@message: 
-@error: 
-@Returns: 
-
-
-<!-- ##### FUNCTION lm_connection_send_with_reply ##### -->
-<para>
-
-</para>
-
-@connection: 
-@message: 
-@handler: 
-@error: 
-@Returns: 
-
-
-<!-- ##### FUNCTION lm_connection_send_with_reply_and_block ##### -->
-<para>
-
-</para>
-
-@connection: 
-@message: 
-@error: 
-@Returns: 
-
-
-<!-- ##### FUNCTION lm_connection_register_message_handler ##### -->
-<para>
-
-</para>
-
-@connection: 
-@handler: 
-@type: 
-@priority: 
-
-
-<!-- ##### FUNCTION lm_connection_unregister_message_handler ##### -->
-<para>
-
-</para>
-
-@connection: 
-@handler: 
-@type: 
-
-
-<!-- ##### FUNCTION lm_connection_set_disconnect_function ##### -->
-<para>
-
-</para>
-
-@connection: 
-@function: 
-@user_data: 
-@notify: 
-
-
-<!-- ##### FUNCTION lm_connection_send_raw ##### -->
-<para>
-
-</para>
-
-@connection: 
-@str: 
-@error: 
-@Returns: 
-
-
-<!-- ##### FUNCTION lm_connection_ref ##### -->
-<para>
-
-</para>
-
-@connection: 
-@Returns: 
-
-
-<!-- ##### FUNCTION lm_connection_unref ##### -->
-<para>
-
-</para>
-
-@connection: 
-
-
-y<
-
-
loudmouth