Module escalus_event

Data Types
Function Index
Function Details

Data Types

config()

config() = escalus_config:config()

event_client()

event_client() = [{atom(), any()}]

manager()

manager() = pid()

resource()

resource() = binary()

Function Index

add_handler/3	Add an event handler.
delete_handler/3	Delete an event handler.
get_history/1
incoming_stanza/2
new_client/3	Create a new event emitter.
outgoing_stanza/2
pop_incoming_stanza/2
print_history/1
start/1	Start the event manager.
stop/1	Stop the event manager.
story_end/1
story_start/1

Function Details

add_handler/3

add_handler(Mgr::manager(), Handler::atom() | pid(), Args::[term()]) -> ok

Add an event handler

delete_handler/3

delete_handler(Mgr::manager(), Handler::atom() | pid(), Args::[term()]) -> ok

Delete an event handler

get_history/1

get_history(Config) -> any()

incoming_stanza/2

incoming_stanza(Client, Stanza) -> any()

new_client/3

new_client(Config, User, MaybeResource) -> undefined | EventClient

Config = config()
User = escalus_users:user_name() | escalus_users:user_spec()
MaybeResource = undefined | resource()
EventClient = event_client()

Create a new event emitter.

outgoing_stanza/2

outgoing_stanza(Client, Stanza) -> any()

pop_incoming_stanza/2

pop_incoming_stanza(Client, Stanza) -> any()

print_history/1

print_history(Config) -> any()

start/1

start(Config) -> any()

Start the event manager

stop/1

stop(Config) -> any()

Stop the event manager

story_end/1

story_end(Config) -> any()

story_start/1

story_start(Config) -> any()

Generated by EDoc