Module xmpp

.

Copyright © (C) 2015-2017, Evgeny Khramtsov

Behaviours: application.

Authors: Evgeny Khramtsov (ekhramtsov@process-one.net).

Description

Data Types

decode_option()

decode_option() = ignore_els

lang()

lang() = binary()

match_fun()

match_fun() = fun((xmlel()) -> boolean())

reason_text()

reason_text() = binary() | {io:format(), list()}

Function Index

append_subtags/2
decode/1
decode/3
decode_els/1
decode_els/3
del_meta/2
encode/1
encode/2
err_bad_request/0
err_bad_request/2
err_conflict/0
err_conflict/2
err_feature_not_implemented/0
err_feature_not_implemented/2
err_forbidden/0
err_forbidden/2
err_gone/0
err_gone/2
err_internal_server_error/0
err_internal_server_error/2
err_item_not_found/0
err_item_not_found/2
err_jid_malformed/0
err_jid_malformed/2
err_not_acceptable/0
err_not_acceptable/2
err_not_allowed/0
err_not_allowed/2
err_not_authorized/0
err_not_authorized/2
err_payment_required/0
err_payment_required/2
err_policy_violation/0
err_policy_violation/2
err_recipient_unavailable/0
err_recipient_unavailable/2
err_redirect/0
err_redirect/2
err_registration_required/0
err_registration_required/2
err_remote_server_not_found/0
err_remote_server_not_found/2
err_remote_server_timeout/0
err_remote_server_timeout/2
err_resource_constraint/0
err_resource_constraint/2
err_service_unavailable/0
err_service_unavailable/2
err_subscription_required/0
err_subscription_required/2
err_undefined_condition/1
err_undefined_condition/3
err_unexpected_request/0
err_unexpected_request/2
format_error/1
get_els/1
get_error/1
get_from/1
get_id/1
get_lang/1
get_meta/1
get_meta/2
get_meta/3
get_name/1
get_ns/1
get_subtag/2
get_text/1
get_text/2
get_to/1
get_type/1
has_subtag/2
io_format_error/1
is_known_tag/1
is_known_tag/2
is_stanza/1
make_error/2
make_iq_result/1
make_iq_result/2
mk_text/1
mk_text/2
pp/1
prep_lang/1
put_meta/3
register_codec/1
remove_subtag/2
serr_bad_format/0
serr_bad_format/2
serr_bad_namespace_prefix/0
serr_bad_namespace_prefix/2
serr_conflict/0
serr_conflict/2
serr_connection_timeout/0
serr_connection_timeout/2
serr_host_gone/0
serr_host_gone/2
serr_host_unknown/0
serr_host_unknown/2
serr_improper_addressing/0
serr_improper_addressing/2
serr_internal_server_error/0
serr_internal_server_error/2
serr_invalid_from/0
serr_invalid_from/2
serr_invalid_id/0
serr_invalid_id/2
serr_invalid_namespace/0
serr_invalid_namespace/2
serr_invalid_xml/0
serr_invalid_xml/2
serr_not_authorized/0
serr_not_authorized/2
serr_not_well_formed/0
serr_not_well_formed/2
serr_policy_violation/0
serr_policy_violation/2
serr_remote_connection_failed/0
serr_remote_connection_failed/2
serr_reset/0
serr_reset/2
serr_resource_constraint/0
serr_resource_constraint/2
serr_restricted_xml/0
serr_restricted_xml/2
serr_see_other_host/0
serr_see_other_host/2
serr_system_shutdown/0
serr_system_shutdown/2
serr_undefined_condition/0
serr_undefined_condition/2
serr_unsupported_encoding/0
serr_unsupported_encoding/2
serr_unsupported_feature/0
serr_unsupported_feature/2
serr_unsupported_stanza_type/0
serr_unsupported_stanza_type/2
serr_unsupported_version/0
serr_unsupported_version/2
set_els/2
set_error/2
set_from/2
set_from_to/3
set_id/2
set_lang/2
set_meta/2
set_subtag/2
set_to/2
set_tr_callback/1
set_type/2
start/2
stop/1
unregister_codec/1
update_meta/3

Function Details

append_subtags/2

append_subtags(Stanza::iq(), Tags::[xmpp_element() | xmlel()]) -> iq()

decode/1

decode(El::xmlel() | xmpp_element()) -> xmpp_element()

decode/3

decode(Xmlel::xmlel() | xmpp_element(), TopXMLNS::binary(), Opts::[decode_option()]) -> xmpp_element()

decode_els/1

decode_els(Stanza::iq()) -> iq()

decode_els/3

decode_els(Stanza::iq(), TopXMLNS::binary(), MatchFun::match_fun()) -> iq()

del_meta/2

del_meta(Iq::iq(), K::any()) -> iq()

encode/1

encode(Pkt::xmpp_element() | xmlel()) -> xmlel()

encode/2

encode(Pkt::xmpp_element() | xmlel(), TopXMLNS::binary()) -> xmlel()

err_bad_request/0

err_bad_request() -> stanza_error()

err_bad_request/2

err_bad_request(Text::reason_text(), Lang::lang()) -> stanza_error()

err_conflict/0

err_conflict() -> stanza_error()

err_conflict/2

err_conflict(Text::reason_text(), Lang::lang()) -> stanza_error()

err_feature_not_implemented/0

err_feature_not_implemented() -> stanza_error()

err_feature_not_implemented/2

err_feature_not_implemented(Text::reason_text(), Lang::lang()) -> stanza_error()

err_forbidden/0

err_forbidden() -> stanza_error()

err_forbidden/2

err_forbidden(Text::reason_text(), Lang::lang()) -> stanza_error()

err_gone/0

err_gone() -> stanza_error()

err_gone/2

err_gone(Text::reason_text(), Lang::lang()) -> stanza_error()

err_internal_server_error/0

err_internal_server_error() -> stanza_error()

err_internal_server_error/2

err_internal_server_error(Text::reason_text(), Lang::lang()) -> stanza_error()

err_item_not_found/0

err_item_not_found() -> stanza_error()

err_item_not_found/2

err_item_not_found(Text::reason_text(), Lang::lang()) -> stanza_error()

err_jid_malformed/0

err_jid_malformed() -> stanza_error()

err_jid_malformed/2

err_jid_malformed(Text::reason_text(), Lang::lang()) -> stanza_error()

err_not_acceptable/0

err_not_acceptable() -> stanza_error()

err_not_acceptable/2

err_not_acceptable(Text::reason_text(), Lang::lang()) -> stanza_error()

err_not_allowed/0

err_not_allowed() -> stanza_error()

err_not_allowed/2

err_not_allowed(Text::reason_text(), Lang::lang()) -> stanza_error()

err_not_authorized/0

err_not_authorized() -> stanza_error()

err_not_authorized/2

err_not_authorized(Text::reason_text(), Lang::lang()) -> stanza_error()

err_payment_required/0

err_payment_required() -> stanza_error()

err_payment_required/2

err_payment_required(Text::reason_text(), Lang::lang()) -> stanza_error()

err_policy_violation/0

err_policy_violation() -> stanza_error()

err_policy_violation/2

err_policy_violation(Text::reason_text(), Lang::lang()) -> stanza_error()

err_recipient_unavailable/0

err_recipient_unavailable() -> stanza_error()

err_recipient_unavailable/2

err_recipient_unavailable(Text::reason_text(), Lang::lang()) -> stanza_error()

err_redirect/0

err_redirect() -> stanza_error()

err_redirect/2

err_redirect(Text::reason_text(), Lang::lang()) -> stanza_error()

err_registration_required/0

err_registration_required() -> stanza_error()

err_registration_required/2

err_registration_required(Text::reason_text(), Lang::lang()) -> stanza_error()

err_remote_server_not_found/0

err_remote_server_not_found() -> stanza_error()

err_remote_server_not_found/2

err_remote_server_not_found(Text::reason_text(), Lang::lang()) -> stanza_error()

err_remote_server_timeout/0

err_remote_server_timeout() -> stanza_error()

err_remote_server_timeout/2

err_remote_server_timeout(Text::reason_text(), Lang::lang()) -> stanza_error()

err_resource_constraint/0

err_resource_constraint() -> stanza_error()

err_resource_constraint/2

err_resource_constraint(Text::reason_text(), Lang::lang()) -> stanza_error()

err_service_unavailable/0

err_service_unavailable() -> stanza_error()

err_service_unavailable/2

err_service_unavailable(Text::reason_text(), Lang::lang()) -> stanza_error()

err_subscription_required/0

err_subscription_required() -> stanza_error()

err_subscription_required/2

err_subscription_required(Text::reason_text(), Lang::lang()) -> stanza_error()

err_undefined_condition/1

err_undefined_condition(Type::auth | cancel | continue | modify | wait) -> stanza_error()

err_undefined_condition/3

err_undefined_condition(Type::auth | cancel | continue | modify | wait, Text::reason_text(), Lang::lang()) -> stanza_error()

err_unexpected_request/0

err_unexpected_request() -> stanza_error()

err_unexpected_request/2

err_unexpected_request(Text::reason_text(), Lang::lang()) -> stanza_error()

format_error/1

format_error(Reason::term()) -> binary()

get_els/1

get_els(Iq::stanza()) -> [xmpp_element() | xmlel()]

get_error/1

get_error(Stanza::stanza()) -> undefined | stanza_error()

get_from/1

get_from(Iq::stanza()) -> undefined | jid:jid()

get_id/1

get_id(Iq::stanza() | xmlel()) -> binary()

get_lang/1

get_lang(Iq::stanza() | xmlel()) -> binary()

get_meta/1

get_meta(Iq::stanza()) -> map()

get_meta/2

get_meta(Iq::stanza(), K::any()) -> any()

get_meta/3

get_meta(Iq::stanza(), K::any(), Def::any()) -> any()

get_name/1

get_name(Xmlel::xmpp_element() | xmlel()) -> binary()

get_ns/1

get_ns(Xmlel::xmpp_element() | xmlel()) -> binary()

get_subtag/2

get_subtag(Stanza::stanza(), Tag::xmpp_element()) -> xmpp_element() | false

get_text/1

get_text(Text::[text()]) -> binary()

get_text/2

get_text(Text::[text()], Lang::binary()) -> binary()

get_to/1

get_to(Iq::stanza()) -> undefined | jid:jid()

get_type/1

get_type(Iq::iq()) -> iq_type()

has_subtag/2

has_subtag(Stanza::stanza(), Tag::xmpp_element()) -> boolean()

io_format_error/1

io_format_error(Reason::term()) -> {binary(), [binary()]}

is_known_tag/1

is_known_tag(El::xmlel()) -> boolean()

is_known_tag/2

is_known_tag(El::xmlel(), TopXMLNS::binary()) -> boolean()

is_stanza/1

is_stanza(Message::any()) -> boolean()

make_error/2

make_error(Message::message(), Err::stanza_error() | xmlel()) -> message()

make_iq_result/1

make_iq_result(IQ::iq()) -> iq()

make_iq_result/2

make_iq_result(Iq::iq(), El::xmpp_element() | xmlel() | undefined) -> iq()

mk_text/1

mk_text(Text::reason_text()) -> [text()]

mk_text/2

mk_text(Text::reason_text(), Lang::lang()) -> [text()]

pp/1

pp(Term::any()) -> iodata()

prep_lang/1

prep_lang(L::binary()) -> binary()

put_meta/3

put_meta(Iq::iq(), K::any(), V::any()) -> iq()

register_codec/1

register_codec(Mod::module()) -> ok

remove_subtag/2

remove_subtag(Stanza::iq(), Tag::xmpp_element()) -> iq()

serr_bad_format/0

serr_bad_format() -> stream_error()

serr_bad_format/2

serr_bad_format(Text::reason_text(), Lang::lang()) -> stream_error()

serr_bad_namespace_prefix/0

serr_bad_namespace_prefix() -> stream_error()

serr_bad_namespace_prefix/2

serr_bad_namespace_prefix(Text::reason_text(), Lang::lang()) -> stream_error()

serr_conflict/0

serr_conflict() -> stream_error()

serr_conflict/2

serr_conflict(Text::reason_text(), Lang::lang()) -> stream_error()

serr_connection_timeout/0

serr_connection_timeout() -> stream_error()

serr_connection_timeout/2

serr_connection_timeout(Text::reason_text(), Lang::lang()) -> stream_error()

serr_host_gone/0

serr_host_gone() -> stream_error()

serr_host_gone/2

serr_host_gone(Text::reason_text(), Lang::lang()) -> stream_error()

serr_host_unknown/0

serr_host_unknown() -> stream_error()

serr_host_unknown/2

serr_host_unknown(Text::reason_text(), Lang::lang()) -> stream_error()

serr_improper_addressing/0

serr_improper_addressing() -> stream_error()

serr_improper_addressing/2

serr_improper_addressing(Text::reason_text(), Lang::lang()) -> stream_error()

serr_internal_server_error/0

serr_internal_server_error() -> stream_error()

serr_internal_server_error/2

serr_internal_server_error(Text::reason_text(), Lang::lang()) -> stream_error()

serr_invalid_from/0

serr_invalid_from() -> stream_error()

serr_invalid_from/2

serr_invalid_from(Text::reason_text(), Lang::lang()) -> stream_error()

serr_invalid_id/0

serr_invalid_id() -> stream_error()

serr_invalid_id/2

serr_invalid_id(Text::reason_text(), Lang::lang()) -> stream_error()

serr_invalid_namespace/0

serr_invalid_namespace() -> stream_error()

serr_invalid_namespace/2

serr_invalid_namespace(Text::reason_text(), Lang::lang()) -> stream_error()

serr_invalid_xml/0

serr_invalid_xml() -> stream_error()

serr_invalid_xml/2

serr_invalid_xml(Text::reason_text(), Lang::lang()) -> stream_error()

serr_not_authorized/0

serr_not_authorized() -> stream_error()

serr_not_authorized/2

serr_not_authorized(Text::reason_text(), Lang::lang()) -> stream_error()

serr_not_well_formed/0

serr_not_well_formed() -> stream_error()

serr_not_well_formed/2

serr_not_well_formed(Text::reason_text(), Lang::lang()) -> stream_error()

serr_policy_violation/0

serr_policy_violation() -> stream_error()

serr_policy_violation/2

serr_policy_violation(Text::reason_text(), Lang::lang()) -> stream_error()

serr_remote_connection_failed/0

serr_remote_connection_failed() -> stream_error()

serr_remote_connection_failed/2

serr_remote_connection_failed(Text::reason_text(), Lang::lang()) -> stream_error()

serr_reset/0

serr_reset() -> stream_error()

serr_reset/2

serr_reset(Text::reason_text(), Lang::lang()) -> stream_error()

serr_resource_constraint/0

serr_resource_constraint() -> stream_error()

serr_resource_constraint/2

serr_resource_constraint(Text::reason_text(), Lang::lang()) -> stream_error()

serr_restricted_xml/0

serr_restricted_xml() -> stream_error()

serr_restricted_xml/2

serr_restricted_xml(Text::reason_text(), Lang::lang()) -> stream_error()

serr_see_other_host/0

serr_see_other_host() -> stream_error()

serr_see_other_host/2

serr_see_other_host(Text::reason_text(), Lang::lang()) -> stream_error()

serr_system_shutdown/0

serr_system_shutdown() -> stream_error()

serr_system_shutdown/2

serr_system_shutdown(Text::reason_text(), Lang::lang()) -> stream_error()

serr_undefined_condition/0

serr_undefined_condition() -> stream_error()

serr_undefined_condition/2

serr_undefined_condition(Text::reason_text(), Lang::lang()) -> stream_error()

serr_unsupported_encoding/0

serr_unsupported_encoding() -> stream_error()

serr_unsupported_encoding/2

serr_unsupported_encoding(Text::reason_text(), Lang::lang()) -> stream_error()

serr_unsupported_feature/0

serr_unsupported_feature() -> stream_error()

serr_unsupported_feature/2

serr_unsupported_feature(Text::reason_text(), Lang::lang()) -> stream_error()

serr_unsupported_stanza_type/0

serr_unsupported_stanza_type() -> stream_error()

serr_unsupported_stanza_type/2

serr_unsupported_stanza_type(Text::reason_text(), Lang::lang()) -> stream_error()

serr_unsupported_version/0

serr_unsupported_version() -> stream_error()

serr_unsupported_version/2

serr_unsupported_version(Text::reason_text(), Lang::lang()) -> stream_error()

set_els/2

set_els(Iq::iq(), Els::[xmpp_element() | xmlel()]) -> iq()

set_error/2

set_error(Stanza::iq(), E::stanza_error()) -> iq()

set_from/2

set_from(Iq::iq(), J::jid:jid() | undefined) -> iq()

set_from_to/3

set_from_to(Iq::iq(), F::undefined | jid:jid(), T::undefined | jid:jid()) -> iq()

set_id/2

set_id(Iq::iq(), I::binary()) -> iq()

set_lang/2

set_lang(Iq::iq(), L::binary()) -> iq()

set_meta/2

set_meta(Iq::iq(), M::map()) -> iq()

set_subtag/2

set_subtag(Stanza::iq(), Tag::xmpp_element()) -> iq()

set_to/2

set_to(Iq::iq(), J::jid:jid() | undefined) -> iq()

set_tr_callback/1

set_tr_callback(Callback::{module(), atom()} | undefined) -> ok

set_type/2

set_type(Iq::iq(), T::iq_type()) -> iq()

start/2

start(StartType, StartArgs) -> any()

stop/1

stop(State) -> any()

unregister_codec/1

unregister_codec(Mod::module()) -> ok

update_meta/3

update_meta(Iq::iq(), K::any(), V::any()) -> iq()


Generated by EDoc