Grouper.GroupLeader (Grouper v0.1.0) View Source

This implements a group leader capable of IO and storing group metadata.

A Grouper.GroupLeader forwards IO upstream, just like any other group_leader. In addition, it also allocates a ETS table for this group and registers it in a global ETS table.

Requests for configuration and naming functions (mediated by the Grouper.Data module) store information in this ETS table (among other places).

Link to this section Summary

Types

infos()

valid info terms

init_option()

keyword options for init function

init_options()

options to init function

io_request()

IO request info term

option()

keyword options for start function

options()

options to start function

t()

state for Grouper.Leader

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

get_group_data(glpid)

gets state data for a given group leader

get_group_leader(glpid)

gets original group leader for this process

start_link(opts \\ [])

Starts a Grouper.Leader process linked to the current process.

stop(glpid, reason \\ :normal)

stops a group leader process

Link to this section Types

infos()

Specs

infos() :: io_request()

valid info terms

init_option()

Specs

init_option() ::
  {:commandeer, boolean() | pid() | [pid()]}
  | {:leader, pid()}
  | {:parent, pid()}

keyword options for init function

init_options()

Specs

init_options() :: [init_option()]

options to init function

io_request()

Specs

io_request() :: {:io_request, pid(), any(), any()}

IO request info term

option()

Specs

option() :: GenServer.option() | init_option()

keyword options for start function

options()

Specs

options() :: [option()]

options to start function

t()

Specs

t() :: %Grouper.GroupLeader{
  commandeered: [pid()],
  ets_table_id: atom(),
  group_leader: pid(),
  self: pid()
}

state for Grouper.Leader

Link to this section Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

get_group_data(glpid)

Specs

get_group_data(pid()) :: {:ok, t()}

gets state data for a given group leader

get_group_leader(glpid)

Specs

get_group_leader(pid()) :: pid()

gets original group leader for this process

start_link(opts \\ [])

Specs

start_link(options()) :: GenServer.on_start()

Starts a Grouper.Leader process linked to the current process.

This is typically used in a supervision tree.

In addition to the normal options accepted by GenServer.start_link/3, this also accepts the following options:

commandeer - during initialization, sets itself as group_leader for this process or list of processes instead of the calling process
leader - during initialization, sets this process as the group_leader to which it forwards IO requests
parent - this specifies the parent process, useful for testing and when not being started in a normal supervision tree

stop(glpid, reason \\ :normal)

Specs

stop(pid(), reason :: atom()) :: :ok

stops a group leader process