Packages

gleam_erlang

0.22.0
1.3.0 1.2.0 1.1.0 1.0.0 1.0.0-rc1 0.34.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.1 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.1 0.18.0 0.18.0-rc1 retired 0.17.1 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.3 0.9.2 0.9.1 0.9.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

Types and functions for programs running on Erlang!

HexDocs

Current section

Files

Jump to
Readme
46 Versions
1 Dependency
346 Dependants
Files
Activity
gleam_erlang src gleam erlang node.gleam
Raw

src/gleam/erlang/node.gleam 

import gleam/erlang/atom.{Atom}



pub type Node



type DoNotLeak



/// Return the current node.

///

@external(erlang, "erlang", "node")

pub fn self() -> Node



/// Return a list of all visible nodes in the cluster, not including the current

/// node.

///

/// The current node can be included by calling `self()` and prepending the

/// result.

///

/// ```gleam

/// let all_nodes = [node.self(), ..node.visible()]

/// ```

///

@external(erlang, "erlang", "nodes")

pub fn visible() -> List(Node)



pub type ConnectError {

  /// Was unable to connect to the node.

  FailedToConnect

  /// The local node is not alive, so it is not possible to connect to the other

  /// node.

  LocalNodeIsNotAlive

}



// TODO: test unknown node

// TODO: test successfully connecting

/// Establish a connection to a node, so the nodes can send messages to each

/// other and any other connected nodes.

///

/// Returns `Error(FailedToConnect)` if the node is not reachable.

///

/// Returns `Error(LocalNodeIsNotAlive)` if the local node is not alive, meaning

/// it is not running in distributed mode.

///

@external(erlang, "gleam_erlang_ffi", "connect_node")

pub fn connect(node: Atom) -> Result(Node, ConnectError)



// TODO: test

/// Send a message to a named process on a given node.

///

/// These messages are untyped, like regular Erlang messages.

///

pub fn send(node: Node, name: Atom, message: message) -> Nil {

  raw_send(#(name, node), message)

  Nil

}



@external(erlang, "erlang", "send")

fn raw_send(receiver: #(Atom, Node), message: message) -> DoNotLeak



/// Convert a node to the atom of its name.

///

@external(erlang, "gleam_erlang_ffi", "identity")

pub fn to_atom(node: Node) -> Atom