.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Net::Jabber::Loudmouth::Connection 3pm" .TH Net::Jabber::Loudmouth::Connection 3pm "2018-11-02" "perl v5.28.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Net::Jabber::Loudmouth::Connection \- Jabber connection .SH "HIERARCHY" .IX Header "HIERARCHY" .Vb 2 \& Glib::Boxed \& +\-\-\-\-Net::Jabber::Loudmouth::Connection .Ve .SH "METHODS" .IX Header "METHODS" .SS "connection = Net::Jabber::Loudmouth::Connection\->\fBnew\fP ($server)" .IX Subsection "connection = Net::Jabber::Loudmouth::Connection->new ($server)" .IP "\(bu" 4 \&\f(CW$server\fR (string) .ie n .SS "connection = Net::Jabber::Loudmouth::Connection\->\fBnew_with_context\fP ($server, $context)" .el .SS "connection = Net::Jabber::Loudmouth::Connection\->\fBnew_with_context\fP ($server, \f(CW$context\fP)" .IX Subsection "connection = Net::Jabber::Loudmouth::Connection->new_with_context ($server, $context)" .IP "\(bu" 4 \&\f(CW$server\fR (string) .IP "\(bu" 4 \&\f(CW$context\fR (Glib::MainContext thingamabob) .ie n .SS "boolean = $connection\->\fBauthenticate\fP ($username, $password, $resource, $auth_cb, $user_data=undef)" .el .SS "boolean = \f(CW$connection\fP\->\fBauthenticate\fP ($username, \f(CW$password\fP, \f(CW$resource\fP, \f(CW$auth_cb\fP, \f(CW$user_data\fP=undef)" .IX Subsection "boolean = $connection->authenticate ($username, $password, $resource, $auth_cb, $user_data=undef)" .IP "\(bu" 4 \&\f(CW$username\fR (string) .IP "\(bu" 4 \&\f(CW$password\fR (string) .IP "\(bu" 4 \&\f(CW$resource\fR (string) .IP "\(bu" 4 \&\f(CW$auth_cb\fR (scalar) .IP "\(bu" 4 \&\f(CW$user_data\fR (scalar) .ie n .SS "boolean = $connection\->\fBauthenticate_and_block\fP ($username, $password, $resource)" .el .SS "boolean = \f(CW$connection\fP\->\fBauthenticate_and_block\fP ($username, \f(CW$password\fP, \f(CW$resource\fP)" .IX Subsection "boolean = $connection->authenticate_and_block ($username, $password, $resource)" .IP "\(bu" 4 \&\f(CW$username\fR (string) .IP "\(bu" 4 \&\f(CW$password\fR (string) .IP "\(bu" 4 \&\f(CW$resource\fR (string) .ie n .SS "$connection\->\fBcancel_open\fP" .el .SS "\f(CW$connection\fP\->\fBcancel_open\fP" .IX Subsection "$connection->cancel_open" .ie n .SS "boolean = $connection\->\fBclose\fP" .el .SS "boolean = \f(CW$connection\fP\->\fBclose\fP" .IX Subsection "boolean = $connection->close" .ie n .SS "$connection\->\fBset_disconnect_function\fP ($disconnect_cb, $user_data=undef)" .el .SS "\f(CW$connection\fP\->\fBset_disconnect_function\fP ($disconnect_cb, \f(CW$user_data\fP=undef)" .IX Subsection "$connection->set_disconnect_function ($disconnect_cb, $user_data=undef)" .IP "\(bu" 4 \&\f(CW$disconnect_cb\fR (scalar) .IP "\(bu" 4 \&\f(CW$user_data\fR (scalar) .ie n .SS "boolean = $connection\->\fBis_authenticated\fP" .el .SS "boolean = \f(CW$connection\fP\->\fBis_authenticated\fP" .IX Subsection "boolean = $connection->is_authenticated" .ie n .SS "boolean = $connection\->\fBis_open\fP" .el .SS "boolean = \f(CW$connection\fP\->\fBis_open\fP" .IX Subsection "boolean = $connection->is_open" .ie n .SS "string = $connection\->\fBget_jid\fP" .el .SS "string = \f(CW$connection\fP\->\fBget_jid\fP" .IX Subsection "string = $connection->get_jid" .ie n .SS "$connection\->\fBset_jid\fP ($jid)" .el .SS "\f(CW$connection\fP\->\fBset_jid\fP ($jid)" .IX Subsection "$connection->set_jid ($jid)" .IP "\(bu" 4 \&\f(CW$jid\fR (string) .ie n .SS "$connection\->\fBset_keep_alive_rate\fP ($rate)" .el .SS "\f(CW$connection\fP\->\fBset_keep_alive_rate\fP ($rate)" .IX Subsection "$connection->set_keep_alive_rate ($rate)" .IP "\(bu" 4 \&\f(CW$rate\fR (integer) .ie n .SS "boolean = $connection\->\fBopen\fP ($result_cb, $user_data=undef)" .el .SS "boolean = \f(CW$connection\fP\->\fBopen\fP ($result_cb, \f(CW$user_data\fP=undef)" .IX Subsection "boolean = $connection->open ($result_cb, $user_data=undef)" .IP "\(bu" 4 \&\f(CW$result_cb\fR (scalar) .IP "\(bu" 4 \&\f(CW$user_data\fR (scalar) .ie n .SS "boolean = $connection\->\fBopen_and_block\fP" .el .SS "boolean = \f(CW$connection\fP\->\fBopen_and_block\fP" .IX Subsection "boolean = $connection->open_and_block" .ie n .SS "integer = $connection\->\fBget_port\fP" .el .SS "integer = \f(CW$connection\fP\->\fBget_port\fP" .IX Subsection "integer = $connection->get_port" .ie n .SS "$connection\->\fBset_port\fP ($port)" .el .SS "\f(CW$connection\fP\->\fBset_port\fP ($port)" .IX Subsection "$connection->set_port ($port)" .IP "\(bu" 4 \&\f(CW$port\fR (integer) .ie n .SS "proxy = $connection\->\fBget_proxy\fP" .el .SS "proxy = \f(CW$connection\fP\->\fBget_proxy\fP" .IX Subsection "proxy = $connection->get_proxy" .ie n .SS "$connection\->\fBset_proxy\fP ($proxy)" .el .SS "\f(CW$connection\fP\->\fBset_proxy\fP ($proxy)" .IX Subsection "$connection->set_proxy ($proxy)" .IP "\(bu" 4 \&\f(CW$proxy\fR (Net::Jabber::Loudmouth::Proxy or undef) .ie n .SS "messagehandler = $connection\->\fBregister_message_handler\fP ($type, $priority, $handler_cb, $user_data=undef)" .el .SS "messagehandler = \f(CW$connection\fP\->\fBregister_message_handler\fP ($type, \f(CW$priority\fP, \f(CW$handler_cb\fP, \f(CW$user_data\fP=undef)" .IX Subsection "messagehandler = $connection->register_message_handler ($type, $priority, $handler_cb, $user_data=undef)" .IP "\(bu" 4 \&\f(CW$type\fR (Net::Jabber::Loudmouth::MessageType) .IP "\(bu" 4 \&\f(CW$priority\fR (Net::Jabber::Loudmouth::HandlerPriority) .IP "\(bu" 4 \&\f(CW$handler_cb\fR (scalar) .IP "\(bu" 4 \&\f(CW$user_data\fR (scalar) .ie n .SS "boolean = $connection\->\fBsend\fP ($message)" .el .SS "boolean = \f(CW$connection\fP\->\fBsend\fP ($message)" .IX Subsection "boolean = $connection->send ($message)" .IP "\(bu" 4 \&\f(CW$message\fR (Net::Jabber::Loudmouth::Message) .ie n .SS "boolean = $connection\->\fBsend_raw\fP ($str)" .el .SS "boolean = \f(CW$connection\fP\->\fBsend_raw\fP ($str)" .IX Subsection "boolean = $connection->send_raw ($str)" .IP "\(bu" 4 \&\f(CW$str\fR (string) .ie n .SS "boolean = $connection\->\fBsend_with_reply\fP ($message, $handler)" .el .SS "boolean = \f(CW$connection\fP\->\fBsend_with_reply\fP ($message, \f(CW$handler\fP)" .IX Subsection "boolean = $connection->send_with_reply ($message, $handler)" .IP "\(bu" 4 \&\f(CW$message\fR (Net::Jabber::Loudmouth::Message) .IP "\(bu" 4 \&\f(CW$handler\fR (Net::Jabber::Loudmouth::MessageHandler) .ie n .SS "message = $connection\->\fBsend_with_reply_and_block\fP ($message)" .el .SS "message = \f(CW$connection\fP\->\fBsend_with_reply_and_block\fP ($message)" .IX Subsection "message = $connection->send_with_reply_and_block ($message)" .IP "\(bu" 4 \&\f(CW$message\fR (Net::Jabber::Loudmouth::Message) .ie n .SS "string = $connection\->\fBget_server\fP" .el .SS "string = \f(CW$connection\fP\->\fBget_server\fP" .IX Subsection "string = $connection->get_server" .ie n .SS "$connection\->\fBset_server\fP ($server)" .el .SS "\f(CW$connection\fP\->\fBset_server\fP ($server)" .IX Subsection "$connection->set_server ($server)" .IP "\(bu" 4 \&\f(CW$server\fR (string) .ie n .SS "ssl = $connection\->\fBget_ssl\fP" .el .SS "ssl = \f(CW$connection\fP\->\fBget_ssl\fP" .IX Subsection "ssl = $connection->get_ssl" .ie n .SS "$connection\->\fBset_ssl\fP ($ssl)" .el .SS "\f(CW$connection\fP\->\fBset_ssl\fP ($ssl)" .IX Subsection "$connection->set_ssl ($ssl)" .IP "\(bu" 4 \&\f(CW$ssl\fR (Net::Jabber::Loudmouth::SSL or undef) .ie n .SS "connectionstate = $connection\->\fBget_state\fP" .el .SS "connectionstate = \f(CW$connection\fP\->\fBget_state\fP" .IX Subsection "connectionstate = $connection->get_state" .ie n .SS "$connection\->\fBunregister_message_handler\fP ($type, $handler)" .el .SS "\f(CW$connection\fP\->\fBunregister_message_handler\fP ($type, \f(CW$handler\fP)" .IX Subsection "$connection->unregister_message_handler ($type, $handler)" .IP "\(bu" 4 \&\f(CW$type\fR (Net::Jabber::Loudmouth::MessageType) .IP "\(bu" 4 \&\f(CW$handler\fR (Net::Jabber::Loudmouth::MessageHandler) .SH "ENUMS AND FLAGS" .IX Header "ENUMS AND FLAGS" .SS "enum Net::Jabber::Loudmouth::ConnectionState" .IX Subsection "enum Net::Jabber::Loudmouth::ConnectionState" .IP "\(bu" 4 \&'closed' / '\s-1LM_CONNECTION_STATE_CLOSED\s0' .IP "\(bu" 4 \&'opening' / '\s-1LM_CONNECTION_STATE_OPENING\s0' .IP "\(bu" 4 \&'open' / '\s-1LM_CONNECTION_STATE_OPEN\s0' .IP "\(bu" 4 \&'authenticating' / '\s-1LM_CONNECTION_STATE_AUTHENTICATING\s0' .IP "\(bu" 4 \&'authenticated' / '\s-1LM_CONNECTION_STATE_AUTHENTICATED\s0' .SS "enum Net::Jabber::Loudmouth::HandlerPriority" .IX Subsection "enum Net::Jabber::Loudmouth::HandlerPriority" .IP "\(bu" 4 \&'last' / '\s-1LM_HANDLER_PRIORITY_LAST\s0' .IP "\(bu" 4 \&'normal' / '\s-1LM_HANDLER_PRIORITY_NORMAL\s0' .IP "\(bu" 4 \&'first' / '\s-1LM_HANDLER_PRIORITY_FIRST\s0' .SS "enum Net::Jabber::Loudmouth::MessageType" .IX Subsection "enum Net::Jabber::Loudmouth::MessageType" .IP "\(bu" 4 \&'message' / '\s-1LM_MESSAGE_TYPE_MESSAGE\s0' .IP "\(bu" 4 \&'presence' / '\s-1LM_MESSAGE_TYPE_PRESENCE\s0' .IP "\(bu" 4 \&'iq' / '\s-1LM_MESSAGE_TYPE_IQ\s0' .IP "\(bu" 4 \&'stream' / '\s-1LM_MESSAGE_TYPE_STREAM\s0' .IP "\(bu" 4 \&'stream\-error' / '\s-1LM_MESSAGE_TYPE_STREAM_ERROR\s0' .IP "\(bu" 4 \&'stream\-features' / '\s-1LM_MESSAGE_TYPE_STREAM_FEATURES\s0' .IP "\(bu" 4 \&'auth' / '\s-1LM_MESSAGE_TYPE_AUTH\s0' .IP "\(bu" 4 \&'challenge' / '\s-1LM_MESSAGE_TYPE_CHALLENGE\s0' .IP "\(bu" 4 \&'response' / '\s-1LM_MESSAGE_TYPE_RESPONSE\s0' .IP "\(bu" 4 \&'success' / '\s-1LM_MESSAGE_TYPE_SUCCESS\s0' .IP "\(bu" 4 \&'failure' / '\s-1LM_MESSAGE_TYPE_FAILURE\s0' .IP "\(bu" 4 \&'proceed' / '\s-1LM_MESSAGE_TYPE_PROCEED\s0' .IP "\(bu" 4 \&'starttls' / '\s-1LM_MESSAGE_TYPE_STARTTLS\s0' .IP "\(bu" 4 \&'unknown' / '\s-1LM_MESSAGE_TYPE_UNKNOWN\s0' .SH "SEE ALSO" .IX Header "SEE ALSO" Net::Jabber::Loudmouth, Glib::Boxed .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (C) 2005 by Florian Ragwitz .PP This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.7 or, at your option, any later version of Perl 5 you may have available.