View Source ExSTARS (ExSTARS v0.1.1)

Documentation for ExSTARS.

Summary

Types

Functions

Link to this function

send(name \\ ExSTARS.Client, message)

View Source
@spec send(name :: GenServer.name(), message :: String.t()) ::
  :ok | {:error, :send_failed}

Send a message.

Example

iex> ExSTARS.send("term1 stars")
:ok
iex> ExSTARS.send("System help")
:ok
Link to this function

start_client(name \\ ExSTARS.Client, address, port)

View Source
@spec start_client(
  name :: client(),
  address :: :inet.socket_address() | :inet.hostname(),
  port :: :inet.port_number()
) :: :ok | {:error, :already_started}

Start STARS client.

Example

iex> ExSTARS.start_client({127, 0, 0, 1}, 6057)
:ok