diff -r 50e230cf7818 -r f5b19569e1bc docs/reference/tmpl/.svn/text-base/lm-connection.sgml.svn-base --- 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 @@ - -LmConnection - - -A client connection to the server - - - - - - - - - - - - - -Convenience macro used to cast a pointer to a #LmConnection. - - -@o: pointer to cast - - - - -Default jabber client port. - - - - - - -Default jabber client port when using SSL encryption. - - - - - - -This should not be accessed directly. Use the accessor functions as described below. - - - - - -The return type of an LmMessageHandler. This determines whether more message handlers should be called. - - -@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. - - - -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. - - -@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. - - - -Sent with #LmDisconnectFunction to describe why a connection was closed. - - -@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. - - - -Callback for informing if an asynchronous operation was successful. - - -@connection: an #LmConnection -@success: the result, %TRUE if operation succeeded, otherwise %FALSE -@user_data: User data passed when function being called. - - - - -Callback called when a connection is closed. - - -@connection: an #LmConnection -@reason: the reason the connection was closed. -@user_data: User data passed when function being called. - - - - - - - -@server: -@Returns: - - - - - - - -@connection: -@function: -@user_data: -@notify: -@error: -@Returns: - - - - - - - -@connection: -@error: -@Returns: - - - - - - - -@connection: -@error: -@Returns: - - - - - - - -@connection: -@username: -@password: -@resource: -@function: -@user_data: -@notify: -@error: -@Returns: - - - - - - - -@connection: -@username: -@password: -@resource: -@error: -@Returns: - - - - - - - -@connection: -@Returns: - - - - - - - -@connection: -@Returns: - - - - - - - -@connection: -@server: - - - - - - - -@connection: -@Returns: - - - - - - - -@connection: -@port: - - - - - - - -@connection: -@Returns: - - - - - - - -@connection: -@use_ssl: - - - - - - - -@connection: -@message: -@error: -@Returns: - - - - - - - -@connection: -@message: -@handler: -@error: -@Returns: - - - - - - - -@connection: -@message: -@error: -@Returns: - - - - - - - -@connection: -@handler: -@type: -@priority: - - - - - - - -@connection: -@handler: -@type: - - - - - - - -@connection: -@function: -@user_data: -@notify: - - - - - - - -@connection: -@str: -@error: -@Returns: - - - - - - - -@connection: -@Returns: - - - - - - - -@connection: - - -y< - -