smart_city_registry v3.1.0 SmartCity.Registry.Subscriber View Source
This module manages subscriptions to the dataset and organization channels in Redis PubSub.
You most likely won't need to interact with this module directly beyond starting one as part of your application. Callbacks are exposed via the SmartCity.Registry.MessageHandler
behaviour.
Link to this section Summary
Functions
Returns a specification to start this module under a supervisor
Invoked when the server is started. start_link/3
or start/3
will
block until it returns
Send update to dataset channel on Redis PubSub
Send update to organization channel on Redis PubSub
Link to this section Functions
child_spec(init_arg) View Source
Returns a specification to start this module under a supervisor.
See Supervisor
.
init(opts) View Source
Invoked when the server is started. start_link/3
or start/3
will
block until it returns.
init_arg
is the argument term (second argument) passed to start_link/3
.
Returning {:ok, state}
will cause start_link/3
to return
{:ok, pid}
and the process to enter its loop.
Returning {:ok, state, timeout}
is similar to {:ok, state}
except handle_info(:timeout, state)
will be called after timeout
milliseconds if no messages are received within the timeout.
Returning {:ok, state, :hibernate}
is similar to {:ok, state}
except the process is hibernated before entering the loop. See
c:handle_call/3
for more information on hibernation.
Returning {:ok, state, {:continue, continue}}
is similar to
{:ok, state}
except that immediately after entering the loop
the c:handle_continue/2
callback will be invoked with the value
continue
as first argument.
Returning :ignore
will cause start_link/3
to return :ignore
and
the process will exit normally without entering the loop or calling
c:terminate/2
. If used when part of a supervision tree the parent
supervisor will not fail to start nor immediately try to restart the
GenServer
. The remainder of the supervision tree will be started
and so the GenServer
should not be required by other processes.
It can be started later with Supervisor.restart_child/2
as the child
specification is saved in the parent supervisor. The main use cases for
this are:
- The
GenServer
is disabled by configuration but might be enabled later. - An error occurred and it will be handled by a different mechanism than the
Supervisor
. Likely this approach involves callingSupervisor.restart_child/2
after a delay to attempt a restart.
Returning {:stop, reason}
will cause start_link/3
to return
{:error, reason}
and the process to exit with reason reason
without
entering the loop or calling c:terminate/2
.
Callback implementation for GenServer.init/1
.
send_dataset_update(id)
View Source
send_dataset_update(String.Chars.t()) :: term()
send_dataset_update(String.Chars.t()) :: term()
Send update to dataset channel on Redis PubSub.
Parameters
- id: The dataset id for which an update occured and should be published.
Examples
iex> SmartCity.Registry.Subscriber.send_dataset_update("12345_abcde")
{:ok, 7}
send_organization_update(id)
View Source
send_organization_update(String.Chars.t()) :: term()
send_organization_update(String.Chars.t()) :: term()
Send update to organization channel on Redis PubSub.
Parameters
- id: The organization id for which an update occured and should be published.
Examples
iex> SmartCity.Registry.Subscriber.send_organization_update("12345_abcde")
{:ok, 7}