Module xmpp_stream_in

Behaviours: ?GEN_SERVER.

This module defines the xmpp_stream_in behaviour.
Optional callback functions: init/1, handle_cast/2, handle_call/3, handle_info/2, terminate/2, code_change/3, handle_stream_start/2, handle_stream_established/1, handle_stream_end/2, handle_cdata/2, handle_authenticated_packet/2, handle_unauthenticated_packet/2, handle_unbinded_packet/2, handle_auth_success/4, handle_auth_failure/4, handle_send/3, handle_recv/3, handle_timeout/1, get_password_fun/1, get_password_fun/2, check_password_fun/2, check_password_digest_fun/2, bind/2, compress_methods/1, tls_options/1, tls_required/1, tls_enabled/1, sasl_mechanisms/2, unauthenticated_stream_features/1, authenticated_stream_features/1.

Data Types

state()

state() = map()

stop_reason()

stop_reason() = {stream, reset | {in | out, stream_error()}} | {tls, inet:posix() | atom() | binary()} | {socket, inet:posix() | atom()} | internal_failure

Function Index

accept/1
call/3
cast/2
change_shaper/2
close/1
close/2
code_change/3
establish/1
format_error/1
get_transport/1
handle_call/3
handle_cast/2
handle_info/2
init/1
reply/2
send/2
send_error/3
send_ws_ping/1
set_timeout/2
start/3
start_link/3
stop/1
terminate/2

Function Details

accept/1

accept(Pid::pid()) -> ok

call/3

call(Ref, Msg, Timeout) -> any()

cast/2

cast(Ref, Msg) -> any()

change_shaper/2

change_shaper(State::state(), Shaper::none | p1_shaper:state()) -> state()

close/1

close(Pid::pid()) -> ok

close/2

close(Pid::pid(), Reason::atom()) -> ok

code_change/3

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

establish/1

establish(State::state()) -> state()

format_error/1

format_error(Err::stop_reason()) -> binary()

get_transport/1

get_transport(X1) -> any()

handle_call/3

handle_call(Call, From, State) -> any()

handle_cast/2

handle_cast(Cast, State) -> any()

handle_info/2

handle_info(Info, State) -> any()

init/1

init(X1) -> any()

reply/2

reply(Ref, Reply) -> any()

send/2

send(Pid::pid(), Pkt::xmpp_element()) -> ok

send_error/3

send_error(State::state(), Pkt::xmpp_element() | xmlel(), Err::stanza_error()) -> state()

send_ws_ping/1

send_ws_ping(Pid::pid()) -> ok

set_timeout/2

set_timeout(State::state(), Timeout::non_neg_integer() | infinity) -> state()

start/3

start(Mod, Args, Opts) -> any()

start_link/3

start_link(Mod, Args, Opts) -> any()

stop/1

stop(Pid::pid()) -> ok

terminate/2

terminate(Reason, State) -> any()


Generated by EDoc, May 24 2025, 01:26:36.