# Titanium.Network.BonjourService

> Describes a service on the network which is published by Bonjour.

- Source: https://titaniumsdk.com/docs/sdk/12.6.2/Titanium.Network.BonjourService
- Titanium SDK version: 12.6.2
- Kind: proxy
- Platforms: iPhone, iPad, macOS
- Since: Titanium SDK 1.2.0
- Extends: Titanium.Proxy
- Inheritance: Titanium.Proxy

You can obtain a `BonjourService` instance by calling [Titanium.Network.createBonjourService](https://titaniumsdk.com/docs/sdk/Titanium.Network.md#createBonjourService) 
or from the `service` list from a [BonjourBrowser](https://titaniumsdk.com/docs/sdk/Titanium.Network.BonjourBrowser.md)  
`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:

``` xml
<ti:app>
  <!-- ... -->
  <ios>
    <plist>
      <dict>
        <!-- Reason to access local network-->
        <key>NSLocalNetworkUsageDescription</key>
        [string](https://titaniumsdk.com/docs/sdk/Global.String.md)
            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](https://titaniumsdk.com/docs/sdk/Global.String.md)_test._tcp</string>
        <array/>
      </dict>
    </plist>
  </ios>
  <!-- ... -->
</ti:app>
```

## Example: 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.

``` js
// 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();
```

## Example: 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.

``` js
// 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, fnction (err, bool) {
  // Now you can find the service on your network (including using a Ti.Network.BonjourBrowser)
});
```

## Properties

### domain

- Type: String
- Platforms: iPhone, iPad, macOS

the domain of the service

### isLocal

- Type: Boolean
- Platforms: iPhone, iPad, macOS
- Default: `true`

whether or not the service is local to the device

### name

- Type: String
- Platforms: iPhone, iPad, macOS

the name of the service

### socket

- Type: Titanium.Network.Socket.TCP
- Platforms: iPhone, iPad, macOS

the TCPSocket object that is used to connect to the service

### type

- Type: String
- Platforms: iPhone, iPad, macOS

the type of the service

## Methods

### publish

- Platforms: iPhone, iPad, macOS

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

Parameters:

- `socket` (Titanium.Network.Socket.TCP): a TCPSocket object to associate with the Bonjour service.
- `callback` (Callback<Error, Boolean>, optional): Asynchronous callback function to receive the result of the publish operation

### resolve

- Platforms: iPhone, iPad, macOS

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:

- `timeout` (Number, optional): the timeout for service resolution, in seconds. Optional, default is 120s. Default: `120`.
- `callback` (Callback<Error, Boolean>, optional): Asynchronous callback function to receive the result of the resolve operation

### stop

- Platforms: iPhone, iPad, macOS

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

Parameters:

- `callback` (Callback<Error, Boolean>, optional): Asynchronous callback function to receive the result of the stop operation

## Events

### publish

- Platforms: iPhone, iPad, macOS

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

Event properties:

- `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

- Platforms: iPhone, iPad, macOS

Fired when the service has been resolved (or errored). If successful, the [socket](https://titaniumsdk.com/docs/sdk/Titanium.Network.BonjourService.md#socket) property should now be available.

Event properties:

- `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

- Platforms: iPhone, iPad, macOS

Fired when a service's publish or resolution was stopped via [Titanium.Network.BonjourService.stop](https://titaniumsdk.com/docs/sdk/Titanium.Network.BonjourService.md#stop)

Event properties:

- `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.

## Inherited members

6 members are inherited. Each is documented on the type that declares it.

- [Titanium.Proxy](https://titaniumsdk.com/docs/sdk/12.6.2/Titanium.Proxy.md): `addEventListener`, `apiName`, `applyProperties`, `bubbleParent`, `fireEvent`, `removeEventListener`

---

- This corpus documents Titanium SDK 13.4.1. Anything here that does not name a version describes 13.4.1.
- Titanium is maintained by TiDev. The Appcelerator toolchain is retired: there is no `appc` CLI, no Appcelerator Studio and no hosted build service. The supported CLI is `titanium` on npm, invoked as `ti`.