kantan_cluster
v0.5.0

View Source KantanCluster (kantan_cluster v0.5.0)

KantanCluster

かんたんクラスター

Hex version API docs CI

Summary

Types

message()
node_name()
option()

Options for a cluster.

topic()

Functions

broadcast(topic, message)

See Phoenix.PubSub.broadcast/4

broadcast!(topic, message)

See Phoenix.PubSub.broadcast!/4

broadcast_from(from, topic, message)

See Phoenix.PubSub.broadcast_from/5

broadcast_from!(from, topic, message)

See Phoenix.PubSub.broadcast_from!/5

direct_broadcast(node_name, topic, message)

See Phoenix.PubSub.direct_broadcast/5

direct_broadcast!(node_name, topic, message)

See Phoenix.PubSub.direct_broadcast!/5

local_broadcast(topic, message)

See Phoenix.PubSub.local_broadcast/4

local_broadcast_from(from, topic, message)

See Phoenix.PubSub.local_broadcast_from/5

node_name()

See Phoenix.PubSub.node_name/1

pubsub_name()
start_node(opts \\ [])

Starts a node. Configuration options can be specified as a keyword argument

subscribe(topic, opts \\ [])

See Phoenix.PubSub.subscribe/3

unsubscribe(topic)

See Phoenix.PubSub.unsubscribe/2

Types

Link to this type

message()

View Source 
@type message() :: any()
Link to this type

node_name()

View Source 
@type node_name() :: atom() | binary()
Link to this type

option()

View Source 
@type option() ::
  {:name, node()}
  | {:sname, node()}
  | {:cookie, atom()}
  | {:topologies, keyword()}

Options for a cluster.

Link to this type

topic()

View Source 
@type topic() :: binary()

Functions

Link to this function

broadcast(topic, message)

View Source 
@spec broadcast(topic(), message()) :: :ok | {:error, term()}

See Phoenix.PubSub.broadcast/4

Link to this function

broadcast!(topic, message)

View Source 
@spec broadcast!(topic(), message()) :: :ok

See Phoenix.PubSub.broadcast!/4

Link to this function

broadcast_from(from, topic, message)

View Source 
@spec broadcast_from(pid(), topic(), message()) :: :ok | {:error, term()}

See Phoenix.PubSub.broadcast_from/5

Link to this function

broadcast_from!(from, topic, message)

View Source 
@spec broadcast_from!(pid(), topic(), message()) :: :ok

See Phoenix.PubSub.broadcast_from!/5

Link to this function

direct_broadcast(node_name, topic, message)

View Source 
@spec direct_broadcast(node_name(), topic(), message()) :: :ok

See Phoenix.PubSub.direct_broadcast/5

Link to this function

direct_broadcast!(node_name, topic, message)

View Source 
@spec direct_broadcast!(node_name(), topic(), message()) :: :ok

See Phoenix.PubSub.direct_broadcast!/5

Link to this function

local_broadcast(topic, message)

View Source 
@spec local_broadcast(topic(), message()) :: :ok

See Phoenix.PubSub.local_broadcast/4

Link to this function

local_broadcast_from(from, topic, message)

View Source 
@spec local_broadcast_from(pid(), topic(), message()) :: :ok

See Phoenix.PubSub.local_broadcast_from/5

Link to this function

node_name()

View Source 
@spec node_name() :: node_name()

See Phoenix.PubSub.node_name/1

Link to this function

pubsub_name()

View Source
Link to this function

start_node(opts \\ [])

View Source 
@spec start_node([option()]) :: :ok

Starts a node. Configuration options can be specified as a keyword argument

KantanCluster.start(
  name: :"hoge@172.17.0.7",
  cookie: :mycookie
)

or in your config/config.exs.

config :kantan_cluster,
  name: :"hoge@172.17.0.7",
  cookie: :mycookie
Link to this function

subscribe(topic, opts \\ [])

View Source 
@spec subscribe(topic(), keyword()) :: :ok | {:error, term()}

See Phoenix.PubSub.subscribe/3

Link to this function

unsubscribe(topic)

View Source 
@spec unsubscribe(topic()) :: :ok

See Phoenix.PubSub.unsubscribe/2