index :: net

net.mdns

MDNS service discovery

available since version: 0.9.8

---

information

Service '.local.' domain suffix is optional and can be omitted. There are service aliases: #osc - instead of '_osc._udp.local', #http - '_http._tcp.local', #all - to subscribe to all available services on the network. Note: on close object will automatically unregister any previously registered services. Note: the #all service is the special case - it will output all available network service names with format [service SERVICE(

methods:

• ifaces output available network interfaces and their info
  

• register register MDNS service instance. Instance will be available with DNS name NAME.local
  parameters:

  • SERVICE service name, for example: _osc._tcp, or alias: #osc
    type: symbol
    required: True
    

  • NAME instance name, for example: MY_SUPER_SERVER
    type: symbol
    required: True
    

  • PORT instance port
    type: int
    required: True
    

  • [PROPS] list of text props (TXT record), for example: @prop1 FOO @prop2 BOO will have TXT records prop1=FOO prop2=BAR
    type: list
    

• resolve does mDNS name resolving: get service information: host, ip, port etc by SERVICE type and INSTANCE name
  parameters:

  • SERVICE service name, for example: _osc._tcp, or alias: #osc or #http
    type: symbol
    required: True
    

  • NAME instance name, for example: MY_SUPER_SERVER
    type: symbol
    required: True
    

• subscribe subscribe to service events: add, remove and resolve
  parameters:

  • SERVICE service name, for example: _osc._tcp, or alias: #osc or #all
    type: symbol
    required: True
    

  • [ON=true] if true: subscribe, false: unsubscribe
    type: bool
    

• unregister manually unregister service instance.
  parameters:

  • SERVICE service name, for example: _osc._tcp, or alias: #osc
    type: symbol
    required: True
    

  • NAME instance name, for example: MY_SUPER_SERVER
    type: symbol
    required: True
    

• unsubscribe unsubscribe from specified service events
  parameters:
  • SERVICE service name, for example: _osc._tcp, or alias: #osc or #all
    type: symbol
    required: True
    

properties:

• @fullname Get/set if true: output full instance name (with service and domain suffix), for ex.: 'THE_SERVICE.xx.local.' format
  _type: bool
  default: 1
  

• @ip Get/set restrict addresses by type
  type: symbol
  enum: v4, v6, any
  default: v4
  

inlets:

• input
  type: control

outlets:

• add SERVICE NAME, remove SERVICE NAME, service add|remove SERVICE, resolve SERVICE NAME HOST PORT IP PROPERTIES
  type: control

keywords:

net zeroconf bonjour avahi mdns service discovery

Authors: Serge Poltavsky

License: GPL3 or later