UAInspector v0.15.1 UAInspector.ShortCodeMap.OSs View Source
Operating System Short Code Map.
Link to this section Summary
Functions
Returns the local filename for this map
Returns the remote path for this map
Invoked when the server is started. start_link/3
or start/3
will
block until it returns
Returns all database entries as a list
Starts the database server
Converts a raw entry to its ets representation
Returns the long representation for a short name
Returns the short representation for a long name
Returns a name representation for this map
Returns a type representation for this map
Link to this section Functions
Returns the local filename for this map.
Callback implementation for UAInspector.ShortCodeMap.file_local/0
.
Returns the remote path for this map.
Callback implementation for UAInspector.ShortCodeMap.file_remote/0
.
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 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
.
Returns all database entries as a list.
Callback implementation for UAInspector.Storage.Server.list/0
.
Starts the database server.
Callback implementation for UAInspector.Storage.Server.start_link/0
.
Converts a raw entry to its ets representation.
If necessary a data conversion is made from the raw data passed directly out of the database file and the actual data needed when querying the database.
Callback implementation for UAInspector.ShortCodeMap.to_ets/1
.
Returns the long representation for a short name.
Unknown names are returned unmodified.
Callback implementation for UAInspector.ShortCodeMap.to_long/1
.
Returns the short representation for a long name.
Unknown names are returned unmodified.
Callback implementation for UAInspector.ShortCodeMap.to_short/1
.
Returns a name representation for this map.
Callback implementation for UAInspector.ShortCodeMap.var_name/0
.
Returns a type representation for this map.
Callback implementation for UAInspector.ShortCodeMap.var_type/0
.