Module escalus_ws

Module abstracting Websockets over TCP connection to XMPP server.

Copyright © (C) 2012, Erlang Solutions Ltd.

Behaviours: escalus_connection, gen_server.

Description

Module abstracting Websockets over 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
handle_call/3
handle_cast/2
handle_info/2
init/1
is_connected/1
kill/1
reset_parser/1
send/2
set_filter_predicate/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(StreamEndRep::exml_stream:element(), Props::term()) -> exml_stream:element()

assert_stream_start/2

assert_stream_start(StreamStartRep::exml_stream:element(), Props::term()) -> exml_stream:element()

code_change/3

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

connect/1

connect(Args::[proplists:property()]) -> pid()

handle_call/3

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

handle_cast/2

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

handle_info/2

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

init/1

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

is_connected/1

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

kill/1

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

reset_parser/1

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

send/2

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

set_filter_predicate/2

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

stop/1

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

stream_end_req/1

stream_end_req(Props::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()) -> term()

upgrade_to_tls/2

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

use_zlib/1

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


Generated by EDoc