Harald.HCI.Transport (harald v0.3.0) View Source
A server to manage lower level transports and parse bluetooth events.
Link to this section Summary
Types
Options
:adapter_opts - adapter_opts(). []. The options provided to the adapter on start.
:adapter - adapter(). Required. The transport implementation module.
:id - atom(). Required. Uniquely identifies this transport instance to Harald.
:subscriber_pids - MapSet.t(). #MapSet<[]>. The pids that received data and events will be
sent to.
Functions
Returns a specification to start this module under a supervisor.
Returns the registered name derived from id.
Start the transport.
Link to this section Types
Specs
adapter() :: module()
Specs
Specs
id() :: atom()
Specs
start_link_opts() :: [ adapter: adapter(), adapter_opts: adapter_opts(), id: id(), subscriber_pids: MapSet.t() ]
Options
:adapter_opts - adapter_opts(). []. The options provided to the adapter on start.
:adapter - adapter(). Required. The transport implementation module.
:id - atom(). Required. Uniquely identifies this transport instance to Harald.
:subscriber_pids - MapSet.t(). #MapSet<[]>. The pids that received data and events will be
sent to.
Link to this section Functions
Returns a specification to start this module under a supervisor.
See Supervisor.
Returns the registered name derived from id.
Specs
start_link(start_link_opts()) :: GenServer.on_start()
Start the transport.