Anoma.Node.Transport.Proxy.Node (Anoma v0.34.0)

I am the node proxy. I am responsible for communication with a remote node.

https://specs.anoma.net/v0.1.3/arch/node/net/node_proxy.html

A Node Proxy engine is responsible for communication with one specific remote node.

It performs transport selection, connection establishment and maintenance.

It forwards messages between local engine instances and Transport Connection engine instances.

Connections may be ephemeral or permanent. Ephemeral connections are established when the first message is sent to the node, or when the remote node initiates a connection, and not re-established automatically when the connection is lost. Permanent connections are established when the Node Proxy is started, and automatically re-established when the connection is lost.

The engine instance name corresponds to the remote NodeID.

Summary

Types

t()

I am the type of the PubSub Enigine.

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

init(args)
start_link(args \\ [])

I am the start_link function for the Ordering Engine.

subscribe(node_id, topic)

Types

t()

@type t() :: %Anoma.Node.Transport.Proxy.Node{
  node_id: String.t(),
  remote_node_id: String.t()
}

I am the type of the PubSub Enigine.

Fields

  • :node_id - The ID of the Node to which I belong.

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

init(args)

start_link(args \\ [])

@spec start_link(startup_options()) :: GenServer.on_start()

I am the start_link function for the Ordering Engine.

I register the engine with supplied node ID provided by the arguments.

subscribe(node_id, topic)

@spec subscribe(String.t(), String.t()) ::
  :ok | {:error, :invalid_topic} | {:error, :could_not_subscribe, String.t()}