mdns_beacon package

Submodules

mdns_beacon.cli module

Console script for mdns-beacon.

class mdns_beacon.cli.IpAddressParamType

Bases: click.types.ParamType

An IPv4Address or IPv6Address parsed via ipaddress.ip_address.

Example

>>> ptype = IpAddressParamType()
>>> ptype.convert("127.0.0.1", None, None)
IPv4Address('127.0.0.1')

convert(value: AnyStr, param: Optional[click.core.Parameter], ctx: Optional[click.core.Context]) → Union[ipaddress.IPv4Address, ipaddress.IPv6Address]

Parse value into IPv4Address or IPv6Address.

name = 'ip_address'

mdns_beacon.cli.on_service_state_change(zeroconf: zeroconf.Zeroconf, service_type: str, name: str, state_change: zeroconf.ServiceStateChange) → None

On service state change handler.

mdns_beacon.cli.print_services() → None

Print services.

mdns_beacon.base module

Base mDNS Beacon module.

class mdns_beacon.base.BaseBeacon(ip_version: Optional[zeroconf.IPVersion] = None)

Bases: abc.ABC

mDNS Beacon base class.

Note

Derived beacons must override the _execute method.

ip_version

IP protocol version to use.

run_forever() → None

Run beacon forever.

stop() → None

Stop Beacon.

Ends zeroconf background threads, and prevent zeroconf instance from servicing further queries.

property zeroconf

Zeroconf instance.

mdns_beacon.beacon module

Beacon module.

class mdns_beacon.beacon.Beacon(aliases: Optional[List[str]] = None, addresses: Optional[List[Union[ipaddress.IPv4Address, ipaddress.IPv6Address]]] = None, port: int = 80, type_: str = 'http', protocol: str = 'tcp', ttl: int = 60, *args: Any, **kwargs: Any)

Bases: mdns_beacon.base.BaseBeacon

mDNS Beacon.

aliases

Service alias name list.

addresses

IP addresses that the service runs on.

port

Port that the service runs on.

type_

Service type.

protocol

Service protocol.

ttl

ttl used for the announce of the service.

\*args

Variable length argument list.

\*\*kwargs

Arbitrary keyword arguments.

property service_type

Beacon service type.

property services

Services to register on the local network.

stop() → None

Stop Beacon.

Unregister all the announced services.

mdns_beacon.listener module

mDNS listener module.

class mdns_beacon.listener.BeaconListener(handlers: Union[zeroconf.ServiceListener, List[Callable[…, None]]], services: Optional[List[str]] = None, timeout: Union[int, float] = 5, *args: Any, **kwargs: Any)

Bases: mdns_beacon.base.BaseBeacon

mDNS Beacon listener.

handlers

Service listeners or functions to be called when a service is added, updated or removed.

services

Fully qualified service type names list.

timeout

Seconds to wait for any responses.

property default_services

Return default services to listen on local networks.

Module contents

Top-level package for mdns-beacon.