Class CiaoService
Class Responder
A Responder instance represents a running MDNSServer and a set of advertised services.
+Class Responder
A Responder instance represents a running MDNSServer and a set of advertised services.
It will handle any service related operations, like advertising, sending goodbye packets or sending record updates. It handles answering questions arriving at the multicast address.
-Implements
- PacketHandler
Index
Methods
Implements
- PacketHandler
Index
Methods
create
- create
Service(options): CiaoService Creates a new CiaoService instance and links it to this Responder instance.
Parameters
- options: ServiceOptions
Defines all information about the service which should be created.
Returns CiaoService
The newly created CiaoService instance can be used to advertise and manage the created service.
-- options: ServiceOptions
get
- get
Announced Services(): IterableIterator<CiaoService> Returns IterableIterator<CiaoService>
shutdown
- shutdown(): Promise<void>
This method should be called when you want to unpublish all service exposed by this Responder. +
get
Announced Services - get
Announced Services(): IterableIterator<CiaoService> Returns IterableIterator<CiaoService>
shutdown
- shutdown(): Promise<void>
This method should be called when you want to unpublish all service exposed by this Responder. This method SHOULD be called before the node application exists, so any host on the network is informed of the shutdown of this machine. Calling the shutdown method is mandatory for a clean termination (sending goodbye packets).
The shutdown method must only be called ONCE.
Returns Promise<void>
The Promise resolves once all goodbye packets were sent (or immediately if any other users have a reference to this Responder instance).
-
- get
Enumeration ProtocolConst
Defines the transport protocol of a service.
+Enumeration ProtocolConst
Defines the transport protocol of a service.
As of RFC 6763 7. TCP must be used for any applications using tcp. For applications using any other transport protocol UDP must be used. This applies to all other transport protocols like SCTP, DCCP, RTMFP, etc
-Enumeration Members
TCP
UDP
Enumeration ServiceEventConst
Events thrown by a CiaoService
- Index
Enumeration Members
Enumeration ServiceEventConst
Events thrown by a CiaoService
+ Index
Enumeration Members
Enumeration Members
HOSTNAME_
Event is called when the Prober identifies that the hostname for the service is already used and thus resolve the name conflict by adjusting the hostname (e.g. adding '(2)' to the hostname). @@ -7,8 +7,8 @@ from the service name if not supplied. If you supply a custom hostname (not automatically derived from the service name) you must hook up a listener to this event in order for the hostname to be persisted.
-NAME_
Event is called when the Prober identifies that the name for the service is already used +
NAME_
Event is called when the Prober identifies that the name for the service is already used and thus resolve the name conflict by adjusting the name (e.g. adding '(2)' to the name). This change must be persisted and thus a listener must hook up to this event in order for the name to be persisted.
-Enumeration ServiceTypeConst
This enum defines some commonly used service types. +
Enumeration ServiceTypeConst
This enum defines some commonly used service types. This is also referred to as service name (as of RFC 6763). A service name must not be longer than 15 characters (RFC 6763 7.2).
- Index
Enumeration Members
Index
Enumeration Members
Enumeration Members
AIRDROP
AIRPLAY
AIRPORT
COMPANION_
DACP
DNS_
HAP
HOMEKIT
HTTP
HTTP_
IPP
IPPS
PRINTER
RAOP
TOUCH_
scanner
Enumeration Members
AIRDROP
AIRPLAY
AIRPORT
COMPANION_
DACP
DNS_
HAP
HOMEKIT
HTTP
HTTP_
IPP
IPPS
PRINTER
RAOP
TOUCH_
scanner
Function getResponder
- get
Responder(options?): Responder This method is used to get a responder for the provided (optional) set of options.
+getResponder | @homebridge/ciao - v1.2.0 \ No newline at end of file +Function getResponder
- get
Responder(options?): Responder This method is used to get a responder for the provided (optional) set of options.
Ciao tries to create as few Responder instances as possible. Thus, it will share the same Responder instance for the same set of options.
Parameters
Optionaloptions: ResponderOptionsIf specified, the options will be passed to the underlying mdns server.
Returns Responder
A Responder instance for the given options. Might be shared with others using the same options.
-
- get
@homebridge/ciao - v1.1.8
+
@homebridge/ciao - v1.2.0
mDNSResponder on macOS or avahi on most linux based systems).The one downside with the
mdns library is that running it on Windows is not really straight forward.
Generally we experienced with homebridge that many users run into problems when trying to install mdns.
Thus bonjour-hap and then ciao was created to provide a much easier to set up system.
-Interface MDNSServerOptions
Defines the options passed to the underlying mdns server.
- Index
Properties
Interface MDNSServerOptions
Defines the options passed to the underlying mdns server.
+ Index
Properties
Properties
Optional disable
If specified, the mdns server will not include any ipv6 address records and not bind any udp6 sockets. This is handy if you want to "bind" on 0.0.0.0 only.
-Optional interface
If specified, the mdns server will only listen on the specified interfaces (allowlist). +
Optional interface
If specified, the mdns server will only listen on the specified interfaces (allowlist). It can be supplied as a string (representing a single interface) or as an array of strings to define multiple interfaces. The interface can be defined by specifying the interface name (like 'en0') or by specifying an ip address.
-Interface ServiceOptions
Service options supplied when creating a new ciao service.
-disabledIpv6?: boolean;
domain?: string;
hostname?: string;
name: string;
port?: number;
protocol?: Protocol;
restrictedAddresses?: string[];
subtypes?: string[];
txt?: ServiceTxt;
type: string;
}
Index
Properties
Interface ServiceOptions
Service options supplied when creating a new ciao service.
+disabledIpv6?: boolean;
domain?: string;
hostname?: string;
name: string;
port?: number;
protocol?: Protocol;
restrictedAddresses?: string[];
subtypes?: string[];
txt?: ServiceTxt;
type: string;
}
Index
Properties
Properties
Optional disabled
The service won't advertise ipv6 address records. This can be used to simulate binding on 0.0.0.0. May be combined with restrictedAddresses.
-Optional domain
Adds ability to set custom domain. Will default to "local". +
Optional domain
Adds ability to set custom domain. Will default to "local". The domain will also be automatically appended to the hostname.
-Optional hostname
Defines a hostname under which the service can be reached. +
Optional hostname
Defines a hostname under which the service can be reached. The specified hostname must not include the TLD. If undefined the service name will be used as default.
-name
Instance name of the service
-Optional port
Port of the service. +
name
Instance name of the service
+Optional port
Port of the service. If not supplied it must be set later via updatePort BEFORE advertising the service.
-Optional protocol
The protocol the service uses. Default is TCP.
-Optional restricted
If defined it restricts the service to be advertised on the specified +
Optional protocol
The protocol the service uses. Default is TCP.
+Optional restricted
If defined it restricts the service to be advertised on the specified ip addresses or interface names.
If an interface name is specified, ANY address on that given interface will be advertised (if an IP address of the given interface is also given in the array, it will be overridden). @@ -30,8 +30,8 @@ If an ip address is given, the ip address must be valid at the time of service creation.
If the service is set to advertise on a given interface, though the MDNSServer is configured to ignore this interface, the service won't be advertised on the interface.
-Optional subtypes
Optional array of subtypes of the service. +
Optional subtypes
Optional array of subtypes of the service. Refer to ServiceType for some known examples.
-Optional txt
If defined, a txt record will be published with the given service.
-type
Type of the service.
-Optional txt
If defined, a txt record will be published with the given service.
+type
Type of the service.
+@homebridge/ciao - v1.1.8
Index
Enumerations
@homebridge/ciao - v1.2.0
Index
Enumerations
Classes
Variables
Functions
Type alias ServiceTxt
A service txt consist of multiple key=value pairs, +
Type alias ServiceTxt
A service txt consist of multiple key=value pairs, which get advertised on the network.
-Variable default
Type declaration
get
Responder: ((options?) => Responder) - (options?): Responder
This method is used to get a responder for the provided (optional) set of options.
+default | @homebridge/ciao - v1.2.0 \ No newline at end of file +Variable default
Type declaration
get
Responder: ((options?) => Responder) - (options?): Responder
This method is used to get a responder for the provided (optional) set of options.
Ciao tries to create as few Responder instances as possible. Thus, it will share the same Responder instance for the same set of options.
Parameters
Optionaloptions: ResponderOptionsIf specified, the options will be passed to the underlying mdns server.
Returns Responder
A Responder instance for the given options. Might be shared with others using the same options.
-
The CiaoService class represents a service which can be advertised on the network.
+- Preparing search index...
- The search index is not available
@homebridge/ciao - v1.2.0Class CiaoService
The CiaoService class represents a service which can be advertised on the network.
A service is identified by its fully qualified domain name (FQDN), which consist of the service name, the service type, the protocol and the service domain (.local by default).
The service defines a hostname and a port where the advertised service can be reached.
@@ -7,7 +7,7 @@A CiaoService class is always bound to a Responder and can be created using the Responder.createService method in the Responder class. Once the instance is created, advertise can be called to announce the service on the network.
-Hierarchy
Index
Methods
Hierarchy
Index
Methods
Returns Promise<void>
destroy
This method must be called if you want to free the memory used by this service. +
Returns Promise<void>
destroy
This method must be called if you want to free the memory used by this service. The service instance is not usable anymore after this call.
If the service is still announced, the service will first be removed from the network by calling end.
-Returns Promise<void>
end
This method will remove the advertisement for the service on all connected network interfaces. +
Returns Promise<void>
end
This method will remove the advertisement for the service on all connected network interfaces. If the service is still in the Probing state, probing will simply be cancelled.
Returns Promise<void>
Promise will resolve once the last goodbye packet was sent out
-getFQDN
Returns string
The fully qualified domain name of the service, used to identify the service.
-get
Returns string
The current hostname of the service.
-get
Returns undefined | string[]
Array of subtype pointers (undefined if no subtypes are specified).
-get
Returns number
The port the service is advertising for. +
getFQDN
Returns string
The fully qualified domain name of the service, used to identify the service.
+get
Returns string
The current hostname of the service.
+get
Returns undefined | string[]
Array of subtype pointers (undefined if no subtypes are specified).
+get
Returns number
The port the service is advertising for. {@code -1} is returned when the port is not yet set.
-get
Returns string
The service type pointer.
-update
Sets or updates the port of the service. +
get
Returns string
The service type pointer.
+update
Sets or updates the port of the service. A new port number can only be set when the service is still UNANNOUNCED. Otherwise, an assertion error will be thrown.
Parameters
The new port number.
-Returns void
update
Sets or updates the txt of the service.
+Returns void
update
Sets or updates the txt of the service.
Parameters
The updated txt record.
If set to true no announcement is sent for the updated record.
-Returns void
Settings
Member Visibility
Theme
On This Page
Returns void
Settings
Member Visibility
Theme
On This Page