Module libp2p_group_relcast

• Data Types
• Function Index
• Function Details

Data Types

opt()

opt() = {stream_clients, [libp2p_group_worker:stream_client_spec()]}

Function Index

Function Details

handle_command/2

handle_command(GroupPid::pid(), Msg::term()) -> term() | {error, any()}

handle_input/2

handle_input(GroupPid::pid(), Msg::term()) -> ok

info/1

info(GroupPid::pid()) -> map()

Gets information for a group. The information is represented as a nested map of information related to the workers, sessions and streams that build up the group.

queues/1

queues(GroupPid::pid()) -> relcast:status()

Get the messages queued in the relcast server.

send/2

send(GroupPid::pid(), Data::iodata()) -> ok | {error, term()}

Send the given data to the member of the group. The implementation of the group determines the strategy used for delivery. For gossip groups, for example, delivery is best effort.

start_link/3

start_link(TID::ets:tab(), GroupID::string(), Args::[any()]) -> {ok, pid()} | {error, term()}