new(%args)
This methods takes following arguments:
write_cb
The callback that is called when a XML stanza was completely written and is ready for transfer.
The first argument of the callback will be the character data to send to the socket.
And calls "init".
init
(Re)initializes the writer.
flush()
This method flushes the internal write buffer and will invoke the "write_cb" callback. (see also "new
()" above)
send_init_stream($language,$domain,$namespace)
This method will generate a XMPP stream header. $domain has to be the domain of the server (or
endpoint) we want to connect to.
$namespace is the namespace URI or the tag (from AnyEvent::XMPP::Namespaces) for the stream
namespace. (This is used by AnyEvent::XMPP::Component to connect as component to a server).
$namespace can also be undefined, in this case the "client" namespace will be used.
send_whitespace_ping
This method sends a single space to the server.
send_handshake($streamid,$secret)
This method sends a component handshake. Please note that $secret must be XML escaped!
send_end_of_stream
Sends end of the stream.
send_sasl_auth($mechanisms,$user,$hostname,$pass)
This methods sends the start of a SASL authentication. $mechanisms is an array reference, containing
the mechanism names that are to be tried.
send_sasl_response($challenge)
This method generated the SASL authentication response to a $challenge. You must not call this
method without calling "send_sasl_auth ()" before.
send_starttls
Sends the starttls command to the server.
send_iq($id,$type,$create_cb,%attrs)
This method sends an IQ stanza of type $type (to be compliant only use: 'get', 'set', 'result' and
'error').
If $create_cb is a code reference it will be called with an XML::Writer instance as first argument,
which must be used to fill the IQ stanza. The XML::Writer is in UNSAFE mode, so you can safely use
raw() to write out XML.
$create_cb is a hash reference the hash will be used as key=>value arguments for the "simxml"
function defined in AnyEvent::XMPP::Util. "simxml" will then be used to generate the contents of the
IQ stanza. (This is very convenient when you want to write the contents of stanzas in the code and
don't want to build a DOM tree yourself...).
If $create_cb is an array reference it's elements will be interpreted as single $create_cb argument
(which can either be a hash reference or code reference themself) and executed sequentially.
If $create_cb is undefined an empty tag will be generated.
Example:
$writer->send_iq ('newid', 'get', {
defns => 'version',
node => { name => 'query', ns => 'version' }
}, to => 'jabber.org')
%attrs should have further attributes for the IQ stanza tag. For example 'to' or 'from'. If the
%attrs contain a 'lang' attribute it will be put into the 'xml' namespace. If the 'to' attribute
contains an undef it will be omitted.
$id is the id to give this IQ stanza and is mandatory in this API.
Please note that all attribute values and character data will be filtered by "filter_xml_chars" (see
also AnyEvent::XMPP::Util).
send_presence($id,$type,$create_cb,%attrs)
Sends a presence stanza.
$create_cb has the same meaning as for "send_iq". %attrs will let you pass further optional
arguments like 'to'.
$type is the type of the presence, which may be one of:
unavailable, subscribe, subscribed, unsubscribe, unsubscribed, probe, error
Or undef, in case you want to send a 'normal' presence. Or something completely different if you
don't like the RFC 3921 :-)
%attrs contains further attributes for the presence tag or may contain one of the following
exceptional keys:
If %attrs contains a 'show' key: a child xml tag with that name will be generated with the value as
the content, which should be one of 'away', 'chat', 'dnd' and 'xa'. If it contains an undefined
value no such tag will be generated, which usually means that the 'available' presence is meant.
If %attrs contains a 'status' key: a child xml tag with that name will be generated with the value as
content. If the value of the 'status' key is an hash reference the keys will be interpreted as
language identifiers for the xml:lang attribute of each status element. If one of these keys is the
empty string '' no xml:lang attribute will be generated for it. The values will be the character
content of the status tags.
If %attrs contains a 'priority' key: a child xml tag with that name will be generated with the value
as content, which must be a number between -128 and +127.
Note: If $create_cb is undefined and one of the above attributes (show, status or priority) were
given, the generates presence tag won't be empty.
Please note that all attribute values and character data will be filtered by "filter_xml_chars" (see
also AnyEvent::XMPP::Util).
send_message($id,$to,$type,$create_cb,%attrs)
Sends a message stanza.
$to is the destination JID of the message. $type is the type of the message, and if $type is
undefined it will default to 'chat'. $type must be one of the following: 'chat', 'error',
'groupchat', 'headline' or 'normal'.
$create_cb has the same meaning as in "send_iq".
%attrs contains further attributes for the message tag or may contain one of the following
exceptional keys:
If %attrs contains a 'body' key: a child xml tag with that name will be generated with the value as
content. If the value of the 'body' key is an hash reference the keys will be interpreted as language
identifiers for the xml:lang attribute of each body element. If one of these keys is the empty string
'' no xml:lang attribute will be generated for it. The values will be the character content of the
body tags.
If %attrs contains a 'subject' key: a child xml tag with that name will be generated with the value
as content. If the value of the 'subject' key is an hash reference the keys will be interpreted as
language identifiers for the xml:lang attribute of each subject element. If one of these keys is the
empty string '' no xml:lang attribute will be generated for it. The values will be the character
content of the subject tags.
If %attrs contains a 'thread' key: a child xml tag with that name will be generated and the value
will be the character content.
Please note that all attribute values and character data will be filtered by "filter_xml_chars" (see
also AnyEvent::XMPP::Util).
write_error_tag($error_stanza_node,$error_type,$error)
$error_type is one of 'cancel', 'continue', 'modify', 'auth' and 'wait'. $error is the name of the
error tag child element. If $error is one of the following:
'bad-request', 'conflict', 'feature-not-implemented', 'forbidden', 'gone',
'internal-server-error', 'item-not-found', 'jid-malformed', 'not-acceptable',
'not-allowed', 'not-authorized', 'payment-required', 'recipient-unavailable',
'redirect', 'registration-required', 'remote-server-not-found',
'remote-server-timeout', 'resource-constraint', 'service-unavailable',
'subscription-required', 'undefined-condition', 'unexpected-request'
then a default can be select for $error_type, and the argument can be undefined.
Note: This method is currently a bit limited in the generation of the xml for the errors, if you need
more please contact me.
Install Now
PNG Icons
