Spear.cancel_subscription

You're seeing just the function cancel_subscription, go back to Spear module for more information.
Link to this function

cancel_subscription(conn, subscription_reference, timeout \\ 5000)

View Source (since 0.1.0)

Specs

cancel_subscription(
  connection :: Spear.Connection.t(),
  subscription_reference :: reference(),
  timeout()
) :: :ok | {:error, any()}

Cancels a subscription

This function will cancel a subscription if the provided subscription_reference exists, but is idempotent: if the subscription_reference is not an active subscription reference, :ok will be returned.

Subscriptions are automatically cancelled when a subscribe process exits.

Examples

iex> {:ok, subscription} = Spear.subscribe(conn, self(), "my_stream")
{:ok, #Reference<0.4293953740.2750676995.30541>}
iex> Spear.cancel_subscription(conn, subscription)
:ok
iex> Spear.cancel_subscription(conn, subscription)
:ok