esdee - v1.0.1

esdee/discoverer

Provides an actor-based DNS-SD discovery mechanism.

Types

Builder

opaque </>

A type for building the options for starting a discovery actor.

pub opaque type Builder

Discoverer

opaque </>

A handle to a service discovery actor.

pub opaque type Discoverer

Msg

opaque </>

The internal actor message type (required to be visible for naming the process).

pub opaque type Msg

Subscription

opaque </>

A handle that can be used to unsubscribe from updates.

pub opaque type Subscription

Values

build

</> 
pub fn build(options: esdee.Options) -> Builder

Starts building a discoverer from the base options.

named

</> 
pub fn named(
  builder: Builder,
  name: process.Name(Msg),
) -> #(Builder, Discoverer)

Configures the builder to use a named process with the actor, and returns a discoverer instance that can be used across potential restarts.

poll_service_details

</> 
pub fn poll_service_details(
  discoverer: Discoverer,
  service_type: String,
) -> Result(Nil, toss.Error)

Sends a DNS-SD question querying the given service type in the local network. If there are errors with the socket(s), returns the first error.

poll_service_types

</> 
pub fn poll_service_types(
  discoverer: Discoverer,
) -> Result(Nil, toss.Error)

Sends a DNS-SD question querying all the available service types in the local network. If there are errors with the socket(s), returns the first error.

poll_timeout

</> 
pub fn poll_timeout(builder: Builder, timeout: Int) -> Builder

Sets a timeout for the actor to respond to poll requests. Should be very fast, as no incoming data is waited for.

start

</> 
pub fn start(
  builder: Builder,
) -> Result(actor.Started(Discoverer), actor.StartError)

Starts a DNS-SD service discovery actor

start_timeout

</> 
pub fn start_timeout(builder: Builder, timeout: Int) -> Builder

Sets a timeout for the actor to start. Should be very fast, as no incoming data is waited for.

stop

</> 
pub fn stop(discoverer: Discoverer) -> Nil

Stops the service discovery actor.

subscribe_to_service_details

</> 
pub fn subscribe_to_service_details(
  discoverer: Discoverer,
  service_type: String,
  subject: process.Subject(esdee.ServiceDescription),
) -> Subscription

Subscribes the given subject to all discovered service details. You will also need to call poll_service_details to discover services quickly.

subscribe_to_service_details_mapping

</> 
pub fn subscribe_to_service_details_mapping(
  discoverer: Discoverer,
  service_type: String,
  subject: process.Subject(a),
  mapper: fn(esdee.ServiceDescription) -> a,
) -> Subscription

Subscribes the given subject to all discovered service details, using the given function to map to another message type. You will also need to call poll_service_details to discover services quickly.

subscribe_to_service_types

</> 
pub fn subscribe_to_service_types(
  discoverer: Discoverer,
  subject: process.Subject(String),
) -> Subscription

Subscribes the given subject to all discovered service types. Note that the same service type might be reported by multiple peers. You will also need to call poll_service_types to discover services quickly.

subscribe_to_service_types_mapping

</> 
pub fn subscribe_to_service_types_mapping(
  discoverer: Discoverer,
  subject: process.Subject(a),
  mapper: fn(String) -> a,
) -> Subscription

Subscribes the given subject to all discovered service types, using the given function to map to another message type. Note that the same service type might be reported by multiple peers. You will also need to call poll_service_types to discover services quickly.

supervised

</> 
pub fn supervised(
  builder: Builder,
  on_start: option.Option(fn(Discoverer) -> Nil),
) -> supervision.ChildSpecification(Discoverer)

Returns a child specification for running the actor with supervision. If specified, the on_start function will be called after the actor starts or restarts.

unsubscribe

</> 
pub fn unsubscribe(
  discoverer: Discoverer,
  subscription: Subscription,
) -> Nil

Terminates the given subscription.

✨ Search Document