geocoder
v2.0.1

View Source Geocoder.Config (geocoder v2.0.1)

Centralization of configurations and defaults values.

The following options are available for configuration.

  • :pool_name - The name for the pool.
  • :pool_config - The configuration for the pool. It uses Poolboy behind the scene, so the following configuration key exists.
  • :store_module - The store module to use. Defaults to Geocoder.Store
  • :store_config - The store configuration
  • :worker_config - The worker configuration. Things like the provider, key, or even custom JSON codec or HTTP clients

Here is full example of a configuration (with all the defaults)

[
  pool_name: :geocoder_workers,
  pool_config: [
    worker_module: Geocoder.Worker,
    size: 4,
    max_overflow: 2,
    strategy: :lifo,
    name: {:local, :geocoder_workers}
  ],
  store_module: Geocoder.Store,
  store_config: [name: :geocoder_store, precision: 6],
  worker_config: [
    provider: Geocoder.Providers.OpenStreetMaps,
    key: nil,
    http_client: Geocoder.HttpClient.Httpoison,
    http_client_opts: [recv_timeout: 30000],
    json_codec: Jason,
    data: nil
  ]
]

Summary

Types

geocoder_config()
geocoder_option()
pool_config()
pool_option()
store_config()
store_option()
worker_config()
worker_option()

Functions

all(opts \\ [])
default_pool_name()
default_store_name()
pool_config(opts \\ [])
pool_name(opts \\ [])
store_config(opts \\ [])
store_module(opts \\ [])
worker_config(opts \\ [])

Types

Link to this type

geocoder_config()

View Source 
@type geocoder_config() :: [geocoder_option()]
Link to this type

geocoder_option()

View Source 
@type geocoder_option() ::
  {:pool_name, atom()}
  | {:pool_config, pool_config()}
  | {:store_module, module()}
  | {:store_config, store_config()}
  | {:worker_config, worker_config()}
Link to this type

pool_config()

View Source 
@type pool_config() :: [pool_option()]
Link to this type

pool_option()

View Source 
@type pool_option() ::
  {:worker_module, module()}
  | {:size, pos_integer()}
  | {:max_overflow, pos_integer()}
  | {:strategy, :fifo | :lifo}
  | {:name, atom() | {atom(), atom()}}
Link to this type

store_config()

View Source 
@type store_config() :: [store_option()]
Link to this type

store_option()

View Source 
@type store_option() :: {:name, atom()} | {:precision, pos_integer()}
Link to this type

worker_config()

View Source 
@type worker_config() :: [worker_option()]
Link to this type

worker_option()

View Source 
@type worker_option() ::
  {:provider, module()}
  | {:key, binary()}
  | {:http_client, module()}
  | {:http_client_opts, keyword()}
  | {:json_codec, module()}
  | {:data, map()}

Functions

Link to this function

all(opts \\ [])

View Source 
@spec all(geocoder_config()) :: geocoder_config()
Link to this function

default_pool_name()

View Source 
@spec default_pool_name() :: :geocoder_workers
Link to this function

default_store_name()

View Source 
@spec default_store_name() :: :geocoder_store
Link to this function

pool_config(opts \\ [])

View Source 
@spec pool_config(geocoder_config()) :: pool_config()
Link to this function

pool_name(opts \\ [])

View Source 
@spec pool_name(geocoder_config()) :: atom()
Link to this function

store_config(opts \\ [])

View Source
Link to this function

store_module(opts \\ [])

View Source 
@spec store_module(geocoder_config()) :: atom()
Link to this function

worker_config(opts \\ [])

View Source 
@spec worker_config(geocoder_config()) :: worker_config()
@spec worker_config(geocoder_config()) :: store_config()