atomvm_gleam/avm_pubsub

Types

Errors from avm_pubsub / gen_server.

pub type Error {
  Failed
  NotSupported
  Badarg
  Timeout
  Other(String)
}

</>

Opaque handle for a running avm_pubsub gen_server (pid()).

pub type Server

</>

pub fn error_to_string(error: Error) -> String

Format an Error for logging.

</>

pub fn publish(
  server: Server,
  topic: topic,
  term: term,
) -> Result(Int, Error)

Publish term on topic. Returns the number of matching subscribers notified.

Maps to upstream avm_pubsub:pub/3 (pub is a Gleam keyword).

</>

pub fn start() -> Result(Server, Error)

Start an unnamed avm_pubsub gen_server.

</>

pub fn start_named(name: String) -> Result(Server, Error)

Start an avm_pubsub gen_server registered under a local atom name.

name is converted to an atom in the FFI (binary_to_atom/2), matching other modules that accept Gleam String names.

</>

pub fn sub(server: Server, topic: topic) -> Result(Nil, Error)

Subscribe the calling process to topic.

</>

pub fn sub_pid(
  server: Server,
  topic: topic,
  pid: process.Pid,
) -> Result(Nil, Error)

Subscribe pid to topic.

</>

pub fn unsub(server: Server, topic: topic) -> Result(Nil, Error)

Unsubscribe the calling process from topic.

</>

pub fn unsub_pid(
  server: Server,
  topic: topic,
  pid: process.Pid,
) -> Result(Nil, Error)

Unsubscribe pid from topic.