Packages
spawn
1.0.0-rc.21
2.0.0-RC9
2.0.0-RC8
2.0.0-RC7
2.0.0-RC6
2.0.0-RC5
2.0.0-RC4
2.0.0-RC3
2.0.0-RC2
2.0.0-RC14
2.0.0-RC13
2.0.0-RC12
2.0.0-RC11
2.0.0-RC10
2.0.0-RC1
1.4.3
1.4.2
1.4.1
1.4.0
1.3.3
1.3.2
1.3.1
1.3.0
1.2.1
1.2.0
1.1.1
1.1.0
1.0.1
1.0.0
1.0.0-rc3
1.0.0-rc16
1.0.0-rc1
1.0.0-rc.38
1.0.0-rc.37
1.0.0-rc.36
1.0.0-rc.35
1.0.0-rc.34
1.0.0-rc.33
1.0.0-rc.32
1.0.0-rc.31
1.0.0-rc.30
1.0.0-rc.29
1.0.0-rc.28
1.0.0-rc.27
1.0.0-rc.26
1.0.0-rc.25
1.0.0-rc.24
1.0.0-rc.23
1.0.0-rc.22
1.0.0-rc.21
1.0.0-rc.20
1.0.0-rc.19
1.0.0-rc.18
1.0.0-rc.17
1.0.0-rc.2
0.6.3
0.6.2
0.6.1
0.6.0
0.5.5
0.5.4
0.5.3
0.5.1
0.5.0
0.5.0-rc.13
0.5.0-rc.12
0.5.0-rc.11
0.5.0-rc.10
0.5.0-rc.9
0.5.0-rc.8
0.5.0-rc.7
0.5.0-rc.6
0.5.0-rc.5
0.5.0-rc.3
0.5.0-alpha.13
0.5.0-alpha.12
0.5.0-alpha.11
0.5.0-alpha.10
0.5.0-alpha.9
0.5.0-alpha.8
0.5.0-alpha.7
0.5.0-alpha.6
0.5.0-alpha.5
0.5.0-alpha.4
0.5.0-alpha.3
0.5.0-alpha.2
0.5.0-alpha.1
0.1.0
Spawn is the core lib for Spawn Actors System
Current section
Files
Jump to
Current section
Files
lib/spawn/cluster/state_handoff/controller_behaviour.ex
defmodule Spawn.Cluster.StateHandoff.ControllerBehaviour do
@moduledoc """
Behavior for managing the state of clustered processes a.k.a lookups.
"""
@type node_type :: term()
@type config :: map()
@type data :: any()
@type new_data :: data()
@type id :: Eigr.Functions.Protocol.Actors.ActorId.t()
@type host :: Actors.Registry.HostActor.t()
@type hosts :: list(Actors.Registry.HostActor.t())
@type timer :: {atom(), integer()}
@doc """
Cleanup action.
"""
@callback clean(node(), data()) :: any()
@doc """
Fetch the ActorHost process reference by id.
In case `id` is the hash of the ActorId but here the struct ActorId is passed as a parameter.
An implementations must handle this.
"""
@callback get_by_id(id(), data()) :: {new_data(), hosts()}
@doc """
Any initialization code required by implementations of this behavior.
Must return the state to be added in the StateHandoffManager.
"""
@callback handle_init(config()) :: new_data() | {new_data(), timer()}
@doc """
Any procedure to be executed after the StateHandoffManager is initialized.
Executed during callback call to handle_continue.
"""
@callback handle_after_init(data()) :: new_data()
@doc """
Perform any necessary cleanups during StateHandoffManager termination.
Generally excluding references to all processes owned by the terminating node.
"""
@callback handle_terminate(node(), data()) :: new_data()
@callback handle_timer(any(), data()) :: new_data() | {new_data(), timer()}
@doc """
If necessary any procedure to be executed during a nodeup event
"""
@callback handle_nodeup_event(node(), node_type(), data()) :: new_data()
@doc """
If necessary any procedure to be executed during a nodedown event
"""
@callback handle_nodedown_event(node(), node_type(), data()) :: new_data()
@doc """
Adds a reference to an ActorHost process.
"""
@callback set(id(), node(), host(), data) :: new_data()
end