You are reading 13.3.0. See this page in 13.4.1.
Titanium.Network.BonjourService
Extends Titanium.Proxy
Describes a service on the network which is published by Bonjour.
You can obtain a BonjourService instance by calling Titanium.Network.createBonjourService
or from the service list from a BonjourBrowser
updatedservices event.
You can only publish Bonjour services attached to a socket which is currently listening; you cannot publish a service for a remotely connected socket. If you stop the Bonjour service and wish to close the socket it uses, it is strongly recommended that you stop the service first. When a window which publishes a Bonjour service is closed, you must stop the service if the associated socket is also to be closed, or if it is no longer necessary to publish. Bonjour service resolution and publishing is asynchronous.
In iOS 14.0+, to publish service add key NSLocalNetworkUsageDescription and NSBonjourServices in tiapp.xml file.
Example:
<ti:app>
<!-- ... -->
<ios>
<plist>
<dict>
<!-- Reason to access local network-->
<key>NSLocalNetworkUsageDescription</key>
[string](api:Global.String)
Specify the reason for accessing the local network.
This appears in the alert dialog when asking the user
for permission to access local network.
</string>
<!-- List of bonjour service type-->
<key>NSBonjourServices</key>
<array>
[string](api:Global.String)_test._tcp</string>
<array/>
</dict>
</plist>
</ios>
<!-- ... -->
</ti:app>
Examples
Resolve local HTTP/TCP services
The following code excerpt looks for http-based TCP zeroconf services on the local network. It then attempts to resolve the service, establishing a socket that can be used for communications.
// Create the Bonjour Browser (looking for http)
var httpBonjourBrowser = Ti.Network.createBonjourBrowser({
serviceType: '_http._tcp',
domain: 'local'
});
// Handle updated services
httpBonjourBrowser.addEventListener('updatedservices', function (e) {
for (var service of e.services) {
// callback style
service.resolve(120, (err, success) => {
console.log(service.socket);
console.log(service.socket.port);
console.log(service.socket.host);
});
}
});
// Start searching
httpBonjourBrowser.search();
Create and Publish a local HTTP/TCP service
The following code excerpt creates a zeroconf bonjour service and publishes it out to the local network. A TCP Socket is used to handle listening for clients and communicating.
// Create the Bonjour Service
var localService = Ti.Network.createBonjourService({
name: 'example',
type: '_test._tcp',
domain: 'local.'
});
// Create the socket we'll tie to the service
var bonjourSocket = Ti.Network.Socket.createTCP({
host: '127.0.0.1',
port: 40401,
accepted: function (e) {
// Here you handle clients connecting
Ti.API.info("Listening socket <" + e.socket + "> accepted incoming connection <" + e.inbound + ">");
e.inbound.write(Ti.createBuffer({
value: 'You have been connected to a listening socket.\r\n'
}));
e.inbound.close();
},
error: function (e) {
// handle errors...
Ti.API.error("Socket <" + e.socket + "> encountered error when listening");
Ti.API.error(" error code <" + e.errorCode + ">");
Ti.API.error(" error description <" + e.error + ">");
}
});
// Make the socket listen for connections
bonjourSocket.listen();
// Make the socket accept incoming connections
bonjourSocket.accept({ timeout: 10000 });
// Publish the service
localService.publish(bonjourSocket, function (err, bool) {
// Now you can find the service on your network (including using a Ti.Network.BonjourBrowser)
});
Properties 7
Inherited from Titanium.Proxy
The name of the API that this proxy corresponds to.
Inherited from Titanium.Proxy
Indicates if the proxy will bubble an event to its parent.
Default: true
domain
Stringthe domain of the service
isLocal
Booleanwhether or not the service is local to the device
Default: true
name
Stringthe name of the service
the TCPSocket object that is used to connect to the service
type
Stringthe type of the service
Methods 7
Inherited from Titanium.Proxy
Adds the specified callback as an event listener for the named event.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. 4 fields
|
applyProperties
since 3.0.0Inherited from Titanium.Proxy
Applies the properties to the proxy.
| Parameters | Type | Description |
|---|---|---|
| props | Dictionary | A dictionary of properties to apply. |
Inherited from Titanium.Proxy
Fires a synthesized event to any registered listeners.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| event? | Dictionary | A dictionary of keys and values to add to the Titanium.Event object sent to the listeners. |
Asynchronously publish a Bonjour service to the network. Only works if isLocal is TRUE
| Parameters | Type | Description |
|---|---|---|
| socket | Titanium.Network.Socket.TCP | a TCPSocket object to associate with the Bonjour service. |
| callback? | Callback<Error, Boolean> | Asynchronous callback function to receive the result of the publish operation |
Inherited from Titanium.Proxy
Removes the specified callback as an event listener for the named event.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to 4 fields
|
Asynchronously resolve a Bonjour service from the network. Must be done before attempting to access the service's socket information, if a remote service. You cannot resolve a locally published service.
| Parameters | Type | Description |
|---|---|---|
| timeout? | Number | the timeout for service resolution, in seconds. Optional, default is 120s. |
| callback? | Callback<Error, Boolean> | Asynchronous callback function to receive the result of the resolve operation |
Asynchronously halts a currently running attempt to publish or resolve a service.
| Parameters | Type | Description |
|---|---|---|
| callback? | Callback<Error, Boolean> | Asynchronous callback function to receive the result of the stop operation |
Events 3
Fired when the service has been published (or errored).
| Event properties | Type | Description |
|---|---|---|
| code | Number | Error code |
| error | String | Error message |
| success | Boolean | Reports if the publish operation was successful |
| source | Titanium.Network.BonjourService | the service whose publish operation was completed/errored. |
Fired when the service has been resolved (or errored). If successful, the socket property should now be available.
| Event properties | Type | Description |
|---|---|---|
| code | Number | Error code |
| error | String | Error message |
| success | Boolean | Reports if the resolve operation was successful |
| source | Titanium.Network.BonjourService | the service whose resolve operation was completed/errored. |
Fired when a service's publish or resolution was stopped via Titanium.Network.BonjourService.stop
| Event properties | Type | Description |
|---|---|---|
| code | Number | Error code |
| error | String | Error message |
| success | Boolean | Reports if the stop operation was successful |
| source | Titanium.Network.BonjourService | the service whose publish or resolve operation was stopped. |