ex_api v1.0.0-rc.1 ExApi View Source

This module manages all apis and theirs implementations.

Link to this section Summary

Functions

all()

Lists all registered apis

check_api(api_or_module)

Checks given api

check_api_impl(api_or_module, impl_or_group_with_id)

Checks implementation with api

check_impl(impl_or_module)

Checks implementation

get(api_or_module)

Fetches api

get_default_impl(api_or_module)

Fetches default implementation for specified api

get_impl(impl_or_module)

Fetches implementation

get_impl(api_or_module, impl_or_group_with_id)

Fetches implementation for specified group and api

get_impls(api_or_module)

Fetches all implementations for specified api

init(args)

Callback for: GenServer.init/1

register_api(api_or_module)

Registers api asynchronously

register_impl(impl_or_module)

Registers api implementation asynchronously

set_default_impl(impl_or_module)

Changes default api implementation asynchronously

set_default_impl(api_or_module, impl_or_group_with_id)

Changes default api implementation asynchronously

start_link(args \\ [])

Starts ExApi GenServer server

unregister_api(api_or_module)

Unregisters api asynchronously

unregister_impl(impl_or_module)

Unregisters api implementation asynchronously

Link to this section Functions

all()

all() :: {:ok, [ExApi.Api.t]}

Lists all registered apis.

check_api(api_or_module)

check_api(ExApi.Api.t) ::
  {:ok, ExApi.Api.t} |
  {:error, ExApi.Error.ApiMismatchError.t} |
  {:error, ExApi.Error.ApiNotRegisteredError.t}

check_api(module) ::
  {:ok, ExApi.Api.t} |
  {:error, ExApi.Error.ApiNotFoundError.t} |
  {:error, ExApi.Error.ModuleNotLoadedError.t} |
  {:error, ExApi.Error.NotApiError.t}

Checks given api

check_api_impl(api_or_module, impl_or_group_with_id)

check_api_impl(ExApi.Api.t, ExApi.Implementation.t) ::
  {:ok, ExApi.Implementation.t} |
  {:error, ExApi.Error.ApiMismatchError.t} |
  {:error, ExApi.Error.ApiNotRegisteredError.t} |
  {:error, ExApi.Error.ImplementationMismatchError.t} |
  {:error, ExApi.Error.ImplementationNotRegisteredError.t} |
  {:error, ExApi.Error.WrongApiError.t}

check_api_impl(ExApi.Api.t, {group :: atom, id :: atom}) ::
  {:ok, ExApi.Implementation.t} |
  {:error, ExApi.Error.ApiMismatchError.t} |
  {:error, ExApi.Error.ApiNotRegisteredError.t} |
  {:error, ExApi.Error.ImplementationNotFoundError.t}

check_api_impl(api_module :: module, ExApi.Implementation.t) ::
  {:ok, ExApi.Implementation.t} |
  {:error, ExApi.Error.ApiNotFoundError.t} |
  {:error, ExApi.Error.ImplementationMismatchError.t} |
  {:error, ExApi.Error.ImplementationNotRegisteredError.t} |
  {:error, ExApi.Error.ModuleNotLoadedError.t} |
  {:error, ExApi.Error.NotApiError.t}

check_api_impl(api_module :: module, {group :: atom, id :: atom}) ::
  {:ok, ExApi.Implementation.t} |
  {:error, ExApi.Error.ApiNotFoundError.t} |
  {:error, ExApi.Error.ImplementationNotFoundError.t} |
  {:error, ExApi.Error.ModuleNotLoadedError.t} |
  {:error, ExApi.Error.NotApiError.t}

Checks implementation with api.

check_impl(impl_or_module)

check_impl(ExApi.Implementation.t) ::
  {:ok, ExApi.Implementation.t} |
  {:error, ExApi.Error.ApiNotFoundError.t} |
  {:error, ExApi.Error.ImplementationNotFoundError.t}

check_impl(module) ::
  {:ok, ExApi.Implementation.t} |
  {:error, ExApi.Error.ApiNotFoundError.t} |
  {:error, ExApi.Error.ImplementationNotFoundError.t} |
  {:error, ExApi.Error.ModuleNotLoadedError.t} |
  {:error, ExApi.Error.NotImplementationError.t}

Checks implementation.

get(api_or_module)

get(ExApi.Api.t) ::
  {:ok, ExApi.Api.t} |
  {:error, ExApi.Error.ApiMismatchError.t} |
  {:error, ExApi.Error.ApiNotRegisteredError.t}

get(module) ::
  {:ok, ExApi.Api.t} |
  {:error, ExApi.Error.ApiNotFoundError.t} |
  {:error, ExApi.Error.ModuleNotLoadedError.t} |
  {:error, ExApi.Error.NotApiError.t}

Fetches api.

get_default_impl(api_or_module)

get_default_impl(ExApi.Api.t) ::
  {:ok, ExApi.Implementation.t | nil} |
  {:error, ExApi.Error.ApiMismatchError.t} |
  {:error, ExApi.Error.ApiNotRegisteredError.t}

get_default_impl(module) ::
  {:ok, ExApi.Implementation.t | nil} |
  {:error, ExApi.Error.ApiNotFoundError.t} |
  {:error, ExApi.Error.ModuleNotLoadedError.t} |
  {:error, ExApi.Error.NotApiError.t}

Fetches default implementation for specified api.

get_impl(impl_or_module)

get_impl(ExApi.Implementation.t) ::
  {:ok, ExApi.Implementation.t} |
  {:error, ExApi.Error.ApiNotFoundError.t} |
  {:error, ExApi.Error.ImplementationNotFoundError.t}

get_impl(module) ::
  {:ok, ExApi.Implementation.t} |
  {:error, ExApi.Error.ApiNotFoundError.t} |
  {:error, ExApi.Error.ImplementationNotFoundError.t} |
  {:error, ExApi.Error.ModuleNotLoadedError.t} |
  {:error, ExApi.Error.NotImplementationError.t}

Fetches implementation.

get_impl(api_or_module, impl_or_group_with_id)

get_impl(ExApi.Api.t, ExApi.Implementation.t) ::
  {:ok, ExApi.Implementation.t} |
  {:error, ExApi.Error.ApiMismatchError.t} |
  {:error, ExApi.Error.ApiNotRegisteredError.t} |
  {:error, ExApi.Error.ImplementationMismatchError.t} |
  {:error, ExApi.Error.ImplementationNotRegisteredError.t} |
  {:error, ExApi.Error.WrongApiError.t}

get_impl(ExApi.Api.t, {group :: atom, id :: atom}) ::
  {:ok, ExApi.Implementation.t} |
  {:error, ExApi.Error.ApiMismatchError.t} |
  {:error, ExApi.Error.ApiNotRegisteredError.t} |
  {:error, ExApi.Error.ImplementationNotFoundError.t}

get_impl(api_module :: module, ExApi.Implementation.t) ::
  {:ok, ExApi.Implementation.t} |
  {:error, ExApi.Error.ApiNotFoundError.t} |
  {:error, ExApi.Error.ImplementationMismatchError.t} |
  {:error, ExApi.Error.ImplementationNotRegisteredError.t} |
  {:error, ExApi.Error.ModuleNotLoadedError.t} |
  {:error, ExApi.Error.NotApiError.t}

get_impl(api_module :: module, {group :: atom, id :: atom}) ::
  {:ok, ExApi.Implementation.t} |
  {:error, ExApi.Error.ApiNotFoundError.t} |
  {:error, ExApi.Error.ImplementationNotFoundError.t} |
  {:error, ExApi.Error.ModuleNotLoadedError.t} |
  {:error, ExApi.Error.NotApiError.t}

Fetches implementation for specified group and api.

get_impls(api_or_module)

get_impls(ExApi.Api.t) ::
  {:ok, [ExApi.Implementation.t]} |
  {:error, ExApi.Error.ApiMismatchError.t} |
  {:error, ExApi.Error.ApiNotRegisteredError.t}

get_impls(module) ::
  {:ok, [ExApi.Implementation.t]} |
  {:error, ExApi.Error.ApiNotFoundError.t} |
  {:error, ExApi.Error.ModuleNotLoadedError.t} |
  {:error, ExApi.Error.NotApiError.t}

Fetches all implementations for specified api.

init(args)

init(args :: term) ::
  {:ok, state} |
  {:ok, state, timeout | :hibernate} |
  :ignore |
  {:stop, reason :: any} when state: any

Callback for: GenServer.init/1.

register_api(api_or_module)

register_api(ExApi.Api.t | module) :: :ok

Registers api asynchronously.

register_impl(impl_or_module)

register_impl(ExApi.Implementation.t | module) :: :ok

Registers api implementation asynchronously.

set_default_impl(impl_or_module)

set_default_impl(ExApi.Implementation.t | module) :: :ok

Changes default api implementation asynchronously.

set_default_impl(api_or_module, impl_or_group_with_id)

set_default_impl(ExApi.Api.t | module, ExApi.Implementation.t | {atom, atom}) :: :ok

Changes default api implementation asynchronously.

start_link(args \\ [])

start_link([]) :: GenServer.on_start

Starts ExApi GenServer server.

unregister_api(api_or_module)

unregister_api(ExApi.Api.t | module) :: :ok

Unregisters api asynchronously.

unregister_impl(impl_or_module)

unregister_impl(ExApi.Implementation.t | module) :: :ok

Unregisters api implementation asynchronously.