Titanium.Network.BonjourService

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>
            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>_test._tcp</string>
        <array/>
      </dict>
    </plist>
  </ios>
  <!-- ... -->
</ti:app>

Extends: Titanium.Proxy · Since: 1.2.0 · Platforms: iphone, ipad, macos

Properties #

apiName#

extended

Type: String

The name of the API that this proxy corresponds to.

The value of this property is the fully qualified name of the API. For example, Button
returns Ti.UI.Button.

bubbleParent#

extended

Type: Boolean

Indicates if the proxy will bubble an event to its parent.

Some proxies (most commonly views) have a relationship to other proxies, often
established by the add() method. For example, for a button added to a window, a
click event on the button would bubble up to the window. Other common parents are
table sections to their rows, table views to their sections, and scrollable views
to their views. Set this property to false to disable the bubbling to the proxy's parent.

domain#

Type: String

the domain of the service

isLocal#

Type: Boolean

whether or not the service is local to the device

lifecycleContainer#

extended

Type: Titanium.UI.Window, Titanium.UI.TabGroup

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks
will also be called on the proxy. Proxies that require the activity lifecycle will need this property set
to the appropriate containing Window or TabGroup.

name#

Type: String

the name of the service

socket#

Type: Titanium.Network.Socket.TCP

the TCPSocket object that is used to connect to the service

type#

Type: String

the type of the service

Methods #

addEventListener #

extended

Adds the specified callback as an event listener for the named event.

Parameters:

Name	Type	Summary	Optional
`name`	`String`	Name of the event.	No
`callback`	`Callback<Titanium.Event>`	Callback function to invoke when the event is fired.	No

applyProperties #

extended

Applies the properties to the proxy.

Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that
myproxy[key] = value.

Parameters:

Name	Type	Summary	Optional
`props`	`Dictionary`	A dictionary of properties to apply.	No

fireEvent #

extended

Fires a synthesized event to any registered listeners.

Parameters:

Name	Type	Summary	Optional
`name`	`String`	Name of the event.	No
`event`	`Dictionary`	A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.	Yes

publish #

Asynchronously publish a Bonjour service to the network. Only works if isLocal is TRUE

Parameters:

Name	Type	Summary	Optional
`socket`	`Titanium.Network.Socket.TCP`	a TCPSocket object to associate with the Bonjour service.	No
`callback`	`Callback<Error, Boolean>`	Asynchronous callback function to receive the result of the publish operation	Yes

removeEventListener #

extended

Removes the specified callback as an event listener for the named event.

Multiple listeners can be registered for the same event, so the
callback parameter is used to determine which listener to remove.

When adding a listener, you must save a reference to the callback function
in order to remove the listener later:

var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);

To remove the listener, pass in a reference to the callback function:

window.removeEventListener('click', listener);

Parameters:

Name	Type	Summary	Optional
`name`	`String`	Name of the event.	No
`callback`	`Callback<Titanium.Event>`	Callback function to remove. Must be the same function passed to `addEventListener`.	No

resolve #

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:

Name	Type	Summary	Optional
`timeout`	`Number`	the timeout for service resolution, in seconds. Optional, default is 120s.	Yes
`callback`	`Callback<Error, Boolean>`	Asynchronous callback function to receive the result of the resolve operation	Yes

stop #

Asynchronously halts a currently running attempt to publish or resolve a service.

Parameters:

Name	Type	Summary	Optional
`callback`	`Callback<Error, Boolean>`	Asynchronous callback function to receive the result of the stop operation	Yes

Events #

publish #

Fired when the service has been published (or errored).

Event Properties:

Name	Type	Summary
`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.

resolve #

Fired when the service has been resolved (or errored). If successful, the socket property should now be available.

Event Properties:

Name	Type	Summary
`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.

stop #

Fired when a service's publish or resolution was stopped via Titanium.Network.BonjourService.stop

Event Properties:

Name	Type	Summary
`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.

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)
});

Notificationchannels

Launchoptionstype

Notificationparams

Usernotificationattachment

Usernotificationsettings

Mediascannerresponse

Clipboarditemstype

Systemimageparameters

Titanium.Network.BonjourService ​

Properties #

apiName#

bubbleParent#

domain#

isLocal#

lifecycleContainer#

name#

socket#

type#

Methods #

addEventListener #

applyProperties #

fireEvent #

publish #

removeEventListener #

resolve #

stop #

Events #

publish #

resolve #

stop #

Examples #

Resolve local HTTP/TCP services

Create and Publish a local HTTP/TCP service

Titanium.Network.BonjourService