ArchAstro.SDK.Channel (archastro v0.3.5)

A joined Phoenix Channel owned by an ArchAstro.SDK.Socket process.

Summary

Types

t()

Functions

join(socket, topic, payload, module, descriptor, timeout \\ 5000)

leave(channel, timeout \\ 5000)

push(channel, event, payload, descriptor, timeout \\ 5000)

subscribe(channel, event, subscriber, descriptor)

Types

t()

@type t() :: %ArchAstro.SDK.Channel{
  join_response: ArchAstro.SDK.JSON.t() | struct(),
  module: module(),
  socket: GenServer.server(),
  topic: String.t()
}

Functions

join(socket, topic, payload, module, descriptor, timeout \\ 5000)

@spec join(
  GenServer.server(),
  String.t(),
  ArchAstro.SDK.JSON.object() | struct(),
  module(),
  ArchAstro.SDK.Codec.descriptor(),
  timeout()
) :: {:ok, t()} | {:error, ArchAstro.SDK.Error.reason()}

leave(channel, timeout \\ 5000)

@spec leave(t(), timeout()) :: :ok | {:error, ArchAstro.SDK.Error.reason()}

push(channel, event, payload, descriptor, timeout \\ 5000)

@spec push(
  t(),
  String.t(),
  ArchAstro.SDK.JSON.object() | struct(),
  ArchAstro.SDK.Codec.descriptor(),
  timeout()
) ::
  {:ok, ArchAstro.SDK.JSON.t() | struct() | :ok}
  | {:error, ArchAstro.SDK.Error.reason()}