Module escalus_bosh

Module abstracting TCP connection to XMPP server.

Copyright © (C) 2011-2012, Erlang Solutions Ltd.

Behaviours: escalus_connection, gen_server.

Description

Module abstracting TCP connection to XMPP server

Data Types

state()

state() = #state{}

Function Index

assert_stream_end/2
assert_stream_start/2
code_change/3
connect/1
empty_body/2
empty_body/3
get_active/1
get_keepalive/1
get_requests/1
get_rid/1
get_sid/1
handle_call/3
handle_cast/2
handle_info/2
init/1
is_connected/1
kill/1
mark_as_terminated/1
pause/2
recv/1
resend_raw/2
reset_parser/1
send/2
send_raw/2
session_creation_body/2
session_creation_body/6
session_termination_body/2
set_active/2
set_filter_predicate/2
set_keepalive/2
set_quickfail/2
stop/1
stream_end_req/1
stream_start_req/1
terminate/2
upgrade_to_tls/2
use_zlib/1

Function Details

assert_stream_end/2

assert_stream_end(Rep::exml_stream:element(), X2::term()) -> exml_stream:element()

assert_stream_start/2

assert_stream_start(Rep::exml_stream:element(), X2::term()) -> exml_stream:element()

code_change/3

code_change(OldVsn::term(), State::state(), Extra::term()) -> {ok, state()}

connect/1

connect(Args::[{atom(), any()}]) -> pid()

empty_body/2

empty_body(Rid::integer(), Sid::binary()) -> exml:element()

empty_body/3

empty_body(Rid::integer(), Sid::binary() | nil, ExtraAttrs::[exml:attr()]) -> exml:element()

get_active/1

get_active(Pid::pid()) -> boolean()

get_keepalive/1

get_keepalive(Pid::pid()) -> boolean()

get_requests/1

get_requests(Pid::pid()) -> non_neg_integer()

get_rid/1

get_rid(Pid::pid()) -> integer() | nil

get_sid/1

get_sid(Pid::pid()) -> binary() | nil

handle_call/3

handle_call(X1::term(), From::{pid(), term()}, State::state()) -> {reply, term(), state()} | {noreply, state()} | {stop, normal, ok, state()}

handle_cast/2

handle_cast(X1::term(), State::state()) -> {noreply, state()} | {stop, normal, state()}

handle_info/2

handle_info(HttpReply::term(), State::state()) -> {noreply, state()}

init/1

init(X1::list()) -> {ok, state()}

is_connected/1

is_connected(Pid::pid()) -> boolean()

kill/1

kill(Pid::pid()) -> ok | already_stopped

mark_as_terminated/1

mark_as_terminated(Pid::pid()) -> {ok, marked_as_terminated}

pause/2

pause(Pid::pid(), Seconds::integer()) -> ok

recv/1

recv(Pid::escalus:client()) -> exml_stream:element() | empty

resend_raw/2

resend_raw(Pid::pid(), Body::exml:element()) -> ok

reset_parser/1

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

send/2

send(Pid::pid(), Elem::exml:element()) -> ok

send_raw/2

send_raw(Pid::pid(), Body::exml:element()) -> ok

session_creation_body/2

session_creation_body(Rid::integer(), To::binary()) -> exml:element()

session_creation_body/6

session_creation_body(Wait::integer(), Version::binary(), Lang::binary(), Rid::integer(), To::binary(), Sid::binary() | nil) -> exml:element()

session_termination_body/2

session_termination_body(Rid::integer(), Sid::binary() | nil) -> exml:element()

set_active/2

set_active(Pid::pid(), Active::boolean()) -> ok

set_filter_predicate/2

set_filter_predicate(Pid::pid(), Pred::escalus_connection:filter_pred()) -> ok

set_keepalive/2

set_keepalive(Pid::pid(), NewKeepalive::boolean()) -> {ok, OldKeepalive::boolean(), NewKeepalive::boolean()}

set_quickfail/2

set_quickfail(Client::escalus:client(), QuickfailFlag::boolean()) -> ok

stop/1

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

stream_end_req/1

stream_end_req(X1::term()) -> exml_stream:element()

stream_start_req/1

stream_start_req(Props::escalus_users:user_spec()) -> exml_stream:element()

terminate/2

terminate(Reason::term(), State::state()) -> any()

upgrade_to_tls/2

upgrade_to_tls(X1::term(), X2::term()) -> no_return()

use_zlib/1

use_zlib(Pid::pid()) -> no_return()


Generated by EDoc