Module katja_echo

Main Katja Echo API.

This module defines the katja_echo behaviour.
Required callback functions: events/1, query/1.

Description

Main Katja Echo API.

Data Types

event()

event() = #riemannpb_event{}

events()

events() = [event() | state()]

katja_echo_option()

katja_echo_option() = {pool, [atom()]} | {port, non_neg_integer()} | {callback, module()}

katja_echo_options()

katja_echo_options() = [katja_echo_option()]

state()

state() = #riemannpb_state{}

Function Index

query/2 Process a query scanning, parsing and fetching data from ETS table.
start_link/0 Start a supervisor tree to handle udp and tcp connections.
start_link/1 Start a supervisor tree to handle udp and tcp connections.

Function Details

query/2

query(Callback::undefined | module() | fun((events()) -> ok), Events::events()) -> {ok, events()}

Process a query scanning, parsing and fetching data from ETS table. Call the user callback for further processing. If Callback is undefined, no user callback will be called.

start_link/0

start_link() -> {ok, pid()}

Start a supervisor tree to handle udp and tcp connections.

See also: start_link/1.

start_link/1

start_link(Options::katja_echo_options()) -> {ok, pid()}

Options: is a list of config values.

Start a supervisor tree to handle udp and tcp connections.


Generated by EDoc