Module teleport

Data Types

host()

host() = inet:socket_address() | inet:hostname()

pool_options()

pool_options() = #{host := host(), port => inet:port_number(), num_connections => non_neg_integer(), connect_timeout => non_neg_integer(), sup_intensity => non_neg_integer(), sup_period => non_neg_integer()}

server_config()

server_config() = #{host := host(), port => inet:port_number(), transport => tcp | ssl, num_acceptors => non_neg_integer()}

uri()

uri() = string()

Function Index

abcast/3
blocking_call/4
blocking_call/5
call/4
call/5
cast/4
close_channel/1
connect/2connect to a server using an uri.
demonitor_link/1
disconnect/1disconnect a link.
incoming_conns/0on a server node list incoming connections.
monitor_link/1monitor a link.
monitor_links/1monitor all links.
new_channel/1
outgoing_conns/0on a client node list outgoing connections.
recv_channel/1
recv_channel/2
register_channel/2
sbcast/3
send_channel/3
send_channel_sync/3
send_channel_sync/4
server_uri/1get the server uri that can be used to connect from a client.
start_server/2start a system.
stop_server/1stop a system.
unregister_channel/2

Function Details

abcast/3

abcast(Names, ProcName, Msg) -> any()

blocking_call/4

blocking_call(Name, M, F, A) -> any()

blocking_call/5

blocking_call(Name, M, F, A, Timeout) -> any()

call/4

call(Name, M, F, A) -> any()

call/5

call(Name, M, F, A, Timeout) -> any()

cast/4

cast(Name, M, F, A) -> any()

close_channel/1

close_channel(Channel) -> any()

connect/2

connect(Uri::uri(), Uri::pool_options()) -> boolean()

connect(Name::atom(), Uri::pool_options()) -> boolean()

connect to a server using an uri

demonitor_link/1

demonitor_link(Name) -> any()

disconnect/1

disconnect(Pid::atom() | pid()) -> ok

disconnect a link

incoming_conns/0

incoming_conns() -> any()

on a server node list incoming connections

monitor_link/1

monitor_link(Name) -> any()

monitor a link

monitor_links/1

monitor_links(X1::boolean()) -> ok

monitor all links

new_channel/1

new_channel(LinkId) -> any()

outgoing_conns/0

outgoing_conns() -> any()

on a client node list outgoing connections

recv_channel/1

recv_channel(Channel) -> any()

recv_channel/2

recv_channel(Channel, Timeout) -> any()

register_channel/2

register_channel(Channel, To) -> any()

sbcast/3

sbcast(Names, ProcName, Msg) -> any()

send_channel/3

send_channel(Channel, To, Msg) -> any()

send_channel_sync/3

send_channel_sync(Channel, To, Msg) -> any()

send_channel_sync/4

send_channel_sync(Channel, To, Msg, Timeout) -> any()

server_uri/1

server_uri(Name::atom()) -> uri()

get the server uri that can be used to connect from a client

start_server/2

start_server(Name::atom(), Config::server_config()) -> {ok, pid()} | {error, term()}

start a system. A system is a hierarchical group of processes which share common configuration. It is also the entry point for registering or looking up proceses.

stop_server/1

stop_server(Name::atom()) -> ok

stop a system

unregister_channel/2

unregister_channel(Channel, To) -> any()


Generated by EDoc