ex_geo v1.1.1 ExGeo.Store View Source

Genserver responsible for storing and syncing the maxmind2 geolocation db

Link to this section Summary

Functions

Returns a specification to start this module under a supervisor

Fetches the current geo db

Same as fetch but throws if not found

Invoked when the server is started. start_link/3 or start/3 will block until it returns

Queries the stored maxmind database and returns a raw result if found. Fails if the db failed to download

Same as query/1 except will throw an Exception.t if no db has been downloaded

Link to this section Functions

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function fetch() View Source
fetch() :: {:ok, MMDB2Decoder.parse_result()} | {:error, :download_error}

Fetches the current geo db

Same as fetch but throws if not found

Invoked when the server is started. start_link/3 or start/3 will block until it returns.

args 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 :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 (re)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 calling Supervisor.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.

Link to this function query(ip) View Source
query(ExGeo.ip_address()) ::
  {:ok, map()} | {:error, :download_error | :not_found}

Queries the stored maxmind database and returns a raw result if found. Fails if the db failed to download

Same as query/1 except will throw an Exception.t if no db has been downloaded