Overviewerlang logo

Module escalus_session

Module providing basic session manipulation.

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

Description

Module providing basic session manipulation

Data Types

client()

client() = escalus_connection:client()

feature()

feature() = {atom(), any()}

features()

features() = [feature()]

step()

step() = fun((escalus_connection:client(), features()) -> step_state())

step_state()

step_state() = {escalus_connection:client(), features()}

user_spec()

user_spec() = escalus_users:user_spec()

Function Index

authenticate/1
authenticate/2
bind/1
bind/2
can_use_amp/2
can_use_compression/2
can_use_stream_management/2
compress/1
maybe_stream_management/2
maybe_stream_resumption/2
maybe_use_carbons/2
maybe_use_compression/2
maybe_use_ssl/2
send_presence_available/1
send_presence_unavailable/1
session/1
session/2
start_stream/1
start_stream/2
starttls/1
stream_features/2
stream_management/2
stream_resumption/2
use_ssl/2

Function Details

authenticate/1

authenticate(Client::client()) -> client()

authenticate/2

authenticate(Client::escalus_connection:client(), Features::features()) -> step_state()

bind/1

bind(Client::client()) -> client()

bind/2

bind(Client::escalus_connection:client(), Features::features()) -> step_state()

can_use_amp/2

can_use_amp(Props::user_spec(), Features::features()) -> boolean()

can_use_compression/2

can_use_compression(Props::user_spec(), Features::features()) -> boolean()

can_use_stream_management/2

can_use_stream_management(Props::user_spec(), Features::features()) -> boolean()

compress/1

compress(Client::client()) -> client()

maybe_stream_management/2

maybe_stream_management(Client::escalus_connection:client(), Features::features()) -> step_state()

maybe_stream_resumption/2

maybe_stream_resumption(Client::escalus_connection:client(), Features::features()) -> step_state()

maybe_use_carbons/2

maybe_use_carbons(Client::escalus_connection:client(), Features::features()) -> step_state()

maybe_use_compression/2

maybe_use_compression(Client::escalus_connection:client(), Features::features()) -> step_state()

maybe_use_ssl/2

maybe_use_ssl(Client::escalus_connection:client(), Features::features()) -> step_state()

send_presence_available/1

send_presence_available(Client::escalus:client()) -> ok

send_presence_unavailable/1

send_presence_unavailable(Client::escalus:client()) -> ok

session/1

session(Client::client()) -> client()

session/2

session(Client::escalus_connection:client(), Features::features()) -> step_state()

start_stream/1

start_stream(Client::client()) -> client()

start_stream/2

start_stream(Client::escalus_connection:client(), Features::features()) -> step_state()

starttls/1

starttls(Client::client()) -> client()

stream_features/2

stream_features(Client::escalus_connection:client(), Features::features()) -> step_state()

stream_management/2

stream_management(Client::escalus_connection:client(), Features::features()) -> step_state()

stream_resumption/2

stream_resumption(Client::escalus_connection:client(), Features::features()) -> step_state()

use_ssl/2

use_ssl(Props::user_spec(), Features::features()) -> boolean()

Overviewerlang logo

Generated by EDoc