Module escalus_component

Data Types
Function Index
Function Details

Behaviours: gen_server.

This module defines the escalus_component behaviour.
Required callback functions: init/1, process_stanza/3.
Optional callback functions: terminate/2, handle_info/3.

Data Types

server_name()

server_name() = {local, atom()} | {global, any()} | {via, module(), any()}

state()

state() = #component_state{module = module(), features = escalus_session:features(), client = escalus_client:client(), user_state = any()}

Function Index

code_change/3
handle_call/3
handle_cast/2
handle_info/2
init/1
send/2
set_filter/2
start/3
start/4
start_link/3
start_link/4
stop/2
terminate/2

Function Details

code_change/3

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

handle_call/3

handle_call(Request::any(), From::{pid(), any()}, Component_state::state()) -> {reply, any(), state(), timeout()}

handle_cast/2

handle_cast(Request::any(), State::state()) -> {noreply, state(), timeout()}

handle_info/2

handle_info(Info::any(), Component_state::state()) -> {noreply, state(), timeout()}

init/1

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

send/2

send(Component::pid(), Stanza::exml:element()) -> ok

set_filter/2

set_filter(Component::pid(), FilterFN::function()) -> ok

start/3

start(Module::module(), ConnectionArgs::any(), Args::any()) -> {ok, pid()}

start/4

start(ServerName::server_name(), Module::module(), ConnectionArgs::any(), Args::any()) -> {ok, pid()}

start_link/3

start_link(Module::module(), ConnectionArgs::any(), Args::any()) -> {ok, pid()}

start_link/4

start_link(ServerName::server_name(), Module::module(), ConnectionArgs::any(), Args::any()) -> {ok, pid()}

stop/2

stop(Component::pid(), Reason::any()) -> ok

terminate/2

terminate(Reason, Component_state) -> any()

Generated by EDoc