xplane

v0.6.0

xplane v0.6.0 XPlane.Instance

Represent a running instance of X-Plane and provide a GenServer to monitor the local network for X-Plane multicast "beacon" messages and return them as a list.

Example 

iex> XPlane.Instance.start
{:ok, #PID<0.138.0>}
iex> XPlane.Instance.list
[
  %XPlane.Instance{
    computer_name: "Starboard",
    host: :xplane,
    ip: {192, 168, 0, 58},
    addr: "192.168.0.58",
    major_version: 1,
    minor_version: 1,
    port: 49000,
    role: :extern_visual,
    seconds_since_seen: 0,
    version_number: 105101
  }
]
iex> XPlane.Instance.stop
:ok

Link to this section Summary

Types

t()

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

init(atom)

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

list()

Return a list of the most recent X-Plane beacon details received from each IP address. Note that a listing does not guarantee that the instance is currently running, only that it was seen seconds_since_seen seconds ago.

start(opts \\ [])

Start GenServer that listens for X-Plane multicast beacon messages and maintains a register of received beacon details. A short delay built in to the function leaves enough time for beacons to be received so that subsequent calls to list return reasonable results.

start_link(opts \\ [])

Start GenServer linked to current process that listens for X-Plane multicast beacon messages and maintains a register of received beacon details. A short delay built in to the function leaves enough time for beacons to be received so that subsequent calls to list return reasonable results.

stop()

Stop the GenServer listening for multicast X-Plane beacon messages

Link to this section Types

Link to this type

t() 
t() :: %XPlane.Instance{
  addr: String.t(),
  computer_name: String.t(),
  host: :xplane | :planemaker,
  ip: {integer(), integer(), integer(), integer()},
  major_version: integer(),
  minor_version: integer(),
  port: integer(),
  role: :master | :extern_visual | :ios,
  seconds_since_seen: integer(),
  version_number: integer()
}

Link to this section Functions

Link to this function

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

init(atom)

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

init_arg 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 that it also sets a timeout. See the "Timeouts" section in the module documentation for more information.

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 {:ok, state, {:continue, continue}} is similar to {:ok, state} except that immediately after entering the loop the c:handle_continue/2 callback will be invoked with the value continue as first argument.

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 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

list() 
list() :: [t()]

Return a list of the most recent X-Plane beacon details received from each IP address. Note that a listing does not guarantee that the instance is currently running, only that it was seen seconds_since_seen seconds ago.

Reuseport code based on:

https://github.com/refuge/rbeacon/blob/master/src/rbeacon.erl#L414-L425

Link to this function

start(opts \\ []) 
start(list()) :: {:ok, pid()} | {:error, any()} | :ignore

Start GenServer that listens for X-Plane multicast beacon messages and maintains a register of received beacon details. A short delay built in to the function leaves enough time for beacons to be received so that subsequent calls to list return reasonable results.

Parameters

Accepts normal GenServer options apart from name which is set to the module name.

Link to this function

start_link(opts \\ []) 
start_link(list()) :: {:ok, pid()} | {:error, any()} | :ignore

Start GenServer linked to current process that listens for X-Plane multicast beacon messages and maintains a register of received beacon details. A short delay built in to the function leaves enough time for beacons to be received so that subsequent calls to list return reasonable results.

Parameters

Accepts normal GenServer options apart from name which is set to the module name.

Link to this function

stop() 
stop() :: :ok | {:error, any()}

Stop the GenServer listening for multicast X-Plane beacon messages