Module exmpp_session

The module exmpp_session puts together the mechanism to connect to an XMPP server, using various authentication mechanisms and network layers.

Behaviours: gen_fsm.

Authors: Mickael Remond (mickael.remond@process-one.net).

Description

The module exmpp_session puts together the mechanism to connect to an XMPP server, using various authentication mechanisms and network layers.

This module is intended to be used directly by client developers.

Function Index

auth/4Set the authentication info (user credentials) for the session.
auth_basic/3
auth_basic_digest/3
auth_info/3
auth_method/2Set the authentication method for the session.
code_change/4
connect_BOSH/4
connect_SSL/2
connect_SSL/3
connect_SSL/4
connect_TCP/2
connect_TCP/3
connect_TCP/4
get_connection_property/2Get a property of the underling connection (socket or bosh connection).
handle_event/3
handle_info/3
handle_sync_event/4
init/1
logged_in/2
logged_in/3
login/1
login/2
register_account/2
register_account/3
send_packet/2
set_controlling_process/2
setup/3
start/0
start/1
start_debug/0
start_link/0
start_link/1
stop/1
stream_closed/2
stream_closed/3
stream_error/2
stream_error/3
stream_opened/2
stream_opened/3
terminate/3
wait_for_auth_result/2
wait_for_bind_response/2
wait_for_compression_result/2
wait_for_legacy_auth_method/2
wait_for_register_result/2
wait_for_sasl_response/2
wait_for_session_response/2
wait_for_starttls_result/2
wait_for_stream/2
wait_for_stream/3
wait_for_stream_features/2

Function Details

auth/4

auth(Session, JID::Jid, Password, Method) -> Reply

Set the authentication info (user credentials) for the session. Method = password | digest | "PLAIN" | "ANONYMOUS" | "DIGEST-MD5" | string()

auth_basic/3

auth_basic(Session, JID, Password) -> any()

auth_basic_digest/3

auth_basic_digest(Session, JID, Password) -> any()

auth_info/3

auth_info(Session, JID, Password) -> any()

auth_method/2

auth_method(Session, Method) -> Reply

Set the authentication method for the session.

code_change/4

code_change(OldVsn, StateName, State, Extra) -> any()

connect_BOSH/4

connect_BOSH(Session, URL, Server, Options) -> any()

connect_SSL/2

connect_SSL(Session, Server) -> any()

connect_SSL/3

connect_SSL(Session, Server, Port) -> any()

connect_SSL/4

connect_SSL(Session, Server, Port, Options) -> any()

connect_TCP/2

connect_TCP(Session, Server) -> any()

connect_TCP/3

connect_TCP(Session, Server, Port) -> any()

connect_TCP/4

connect_TCP(Session, Server, Port, Options) -> any()

get_connection_property/2

get_connection_property(Session::pid(), Prop::atom()) -> {ok, any()} | {error, any()}

Get a property of the underling connection (socket or bosh connection)

See documentation on exmpp_socket and exmpp_bosh to see the supported properties. Returns {error, undefined} if the property is not defined for that kind of connection.

handle_event/3

handle_event(Event, StateName, State) -> any()

handle_info/3

handle_info(Info, StateName, State) -> any()

handle_sync_event/4

handle_sync_event(Event, From, StateName, State) -> any()

init/1

init(X1) -> any()

logged_in/2

logged_in(Xmlstreamelement, State) -> any()

logged_in/3

logged_in(X1, From, State) -> any()

login/1

login(Session) -> any()

login/2

login(Session, Mechanism) -> any()

register_account/2

register_account(Session, Password) -> any()

register_account/3

register_account(Session, Username, Password) -> any()

send_packet/2

send_packet(Session, Packet) -> any()

set_controlling_process/2

set_controlling_process(Session, Client) -> any()

setup/3

setup(UnknownMessage, From, State) -> any()

start/0

start() -> any()

start/1

start(X1) -> any()

start_debug/0

start_debug() -> any()

start_link/0

start_link() -> any()

start_link/1

start_link(X1) -> any()

stop/1

stop(Session) -> any()

stream_closed/2

stream_closed(Signal, State) -> any()

stream_closed/3

stream_closed(Signal, From, State) -> any()

stream_error/2

stream_error(Xmlstreamend, State) -> any()

stream_error/3

stream_error(Signal, From, State) -> any()

stream_opened/2

stream_opened(Xmlstreamelement, State) -> any()

stream_opened/3

stream_opened(X1, From, State) -> any()

terminate/3

terminate(Reason, StateName, State) -> any()

wait_for_auth_result/2

wait_for_auth_result(Xmlstreamelement, State) -> any()

wait_for_bind_response/2

wait_for_bind_response(Xmlstreamelement, State) -> any()

wait_for_compression_result/2

wait_for_compression_result(Xmlstreamelement, State) -> any()

wait_for_legacy_auth_method/2

wait_for_legacy_auth_method(Xmlstreamelement, State) -> any()

wait_for_register_result/2

wait_for_register_result(Xmlstreamelement, State) -> any()

wait_for_sasl_response/2

wait_for_sasl_response(Xmlstreamelement, State) -> any()

wait_for_session_response/2

wait_for_session_response(Xmlstreamelement, State) -> any()

wait_for_starttls_result/2

wait_for_starttls_result(Xmlstreamelement, State) -> any()

wait_for_stream/2

wait_for_stream(Xmlstreamstart, State) -> any()

wait_for_stream/3

wait_for_stream(Event, From, State) -> any()

wait_for_stream_features/2

wait_for_stream_features(Xmlstreamelement, State) -> any()


Generated by EDoc, Jul 1 2016, 03:38:28.