lastfm_archive
v0.10.0

View Source LastfmArchive.Cache behaviour (lastfm_archive v0.10.0)

GenServer storing archiving state to ensure scrobbles are fetched only once.

Link to this section Summary

Types

end_of_day()
start_of_day()
user()
year()

Callbacks

get({}, server)
load(user, server, keyword)
put({}, {}, tuple, server)
serialise(user, server, keyword)

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

clear(user, server \\ __MODULE__, options)
get(key, server \\ __MODULE__)
load(user, server \\ __MODULE__, options \\ [])
put(arg1, arg2, value, server \\ __MODULE__)
reset(server \\ __MODULE__, options \\ [])
serialise(user, server \\ __MODULE__, options \\ [])
start_link(opts)
state()
state(server)

Link to this section Types

Link to this type

end_of_day()

View Source 
@type end_of_day() :: integer()
Link to this type

start_of_day()

View Source 
@type start_of_day() :: integer()
Link to this type

user()

View Source 
@type user() :: binary()
Link to this type

year()

View Source 
@type year() :: integer()

Link to this section Callbacks

Link to this callback

get({}, server)

View Source 
@callback get(
  {user(), year()},
  GenServer.server()
) :: map()
Link to this callback

load(user, server, keyword)

View Source 
@callback load(user(), GenServer.server(), keyword()) :: map()
Link to this callback

put({}, {}, tuple, server)

View Source 
@callback put(
  {user(), year()},
  {start_of_day(), end_of_day()},
  tuple(),
  GenServer.server()
) :: :ok
Link to this callback

serialise(user, server, keyword)

View Source 
@callback serialise(user(), GenServer.server(), keyword()) :: term()

Link to this section Functions

Link to this function

child_spec(init_arg)

View Source

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

clear(user, server \\ __MODULE__, options)

View Source 
@spec clear(binary(), GenServer.server(), keyword()) :: map()
Link to this function

get(key, server \\ __MODULE__)

View Source
Link to this function

load(user, server \\ __MODULE__, options \\ [])

View Source
Link to this function

put(arg1, arg2, value, server \\ __MODULE__)

View Source
Link to this function

reset(server \\ __MODULE__, options \\ [])

View Source 
@spec reset(
  GenServer.server(),
  keyword()
) :: :ok
Link to this function

serialise(user, server \\ __MODULE__, options \\ [])

View Source
Link to this function

start_link(opts)

View Source
Link to this function

state()

View Source 
@spec state() :: map()
Link to this function

state(server)

View Source 
@spec state(GenServer.server()) :: map()