community_theatre v0.1.1 CommunityTheatre.ActiveSubscription

This module coordinates client subscriptions and their rate limiters to ensure that clients only receive updates at the rate they specified.

Link to this section Summary

Functions

Returns a specification to start this module under a supervisor.

Start an instance of an active subscription with the provided options.

Link to this section Types

Link to this type

options()

options() :: [option()]
Link to this type

rate_limiter()

rate_limiter() :: {:rate_limiter, atom()}
Link to this type

update_frequency()

update_frequency() :: {:update_frequency, hz()}

Link to this section Functions

Link to this function

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

start_link(opts)

start_link(options()) :: {:ok, pid()} | :ignore | {:error, any()}

Start an instance of an active subscription with the provided options.