View Source ExSTARS (ExSTARS v0.1.5)
Documentation for ExSTARS
.
Summary
Functions
Send a message.
Send a message using the specified client.
Start STARS client.
Start STARS client.
Functions
@spec send(message :: String.t()) :: :ok | {:error, :send_failed}
Send a message.
Example
iex> ExSTARS.send("term1 stars")
:ok
iex> ExSTARS.send("System help")
:ok
Send a message using the specified client.
Example
iex> ExSTARS.send("term1", "System help")
:ok
@spec start_client( address :: :inet.socket_address() | :inet.hostname(), port :: :inet.port_number(), callback_pid :: pid() ) :: :ok | {:error, :already_started}
Start STARS client.
Example
iex> ExSTARS.start_client({127, 0, 0, 1}, 6057)
:ok
@spec start_client( name :: String.t(), key :: String.t(), address :: :inet.socket_address() | :inet.hostname(), port :: :inet.port_number(), callback_pid :: pid() ) :: :ok | {:error, :already_started}
Start STARS client.
Example
iex> ExSTARS.start_client("term1", "stars", {127, 0, 0, 1}, 6057)
:ok