Usar a descoberta de serviços de rede

A descoberta de serviços de rede (NSD, na sigla em inglês) dá ao app acesso a serviços que outros dispositivos fornecem em uma rede local. Os dispositivos compatíveis com a NSD incluem impressoras, webcams, servidores HTTPS e outros dispositivos móveis.

A NSD implementa o mecanismo de descoberta de serviços baseado em DNS (DNS-SD), que permite que o app solicite serviços especificando um tipo de serviço e o nome de uma instância de dispositivo que fornece o tipo desejado de serviço. DNS-SD é compatível com Android e outras plataformas móveis.

Adicionar a NSD ao seu app permite que os usuários identifiquem outros dispositivos na rede local que oferece suporte aos serviços solicitados por seu aplicativo. Isso é útil para variedade de aplicativos ponto a ponto, como compartilhamento de arquivos ou jogos. As APIs NSD do Android simplificam o esforço necessário para a implementação esses recursos.

Esta lição mostra como criar um aplicativo que pode transmitir os nome e informações de conexão com a rede local e procure informações de outros aplicativos fazendo o mesmo. Por fim, esta lição mostra como para se conectar ao mesmo aplicativo em execução em outro dispositivo.

Registrar seu serviço na rede

Observação: esta etapa é opcional. Se você não se importar em transmitir os serviços do app pela rede local, você pode pular para a seção na próxima seção, Descobrir serviços na rede.

Para registrar seu serviço na rede local, crie um objeto NsdServiceInfo. Esse objeto fornece as informações que outros dispositivos da rede usam ao decidir se devem se conectar à sua serviço.

fun registerService(port: Int) {
    // Create the NsdServiceInfo object, and populate it.
    val serviceInfo = NsdServiceInfo().apply {
        // The name is subject to change based on conflicts
        // with other services advertised on the same network.
        serviceName = "NsdChat"
        serviceType = "_nsdchat._tcp"
        setPort(port)
        ...
    }
}

public void registerService(int port) {
    // Create the NsdServiceInfo object, and populate it.
    NsdServiceInfo serviceInfo = new NsdServiceInfo();

    // The name is subject to change based on conflicts
    // with other services advertised on the same network.
    serviceInfo.setServiceName("NsdChat");
    serviceInfo.setServiceType("_nsdchat._tcp");
    serviceInfo.setPort(port);
    ...
}

Esse snippet de código define o nome do serviço como "NsdChat". O nome do serviço é o nome da instância: é o nome visível para outros dispositivos na rede. O nome fica visível para qualquer dispositivo na rede que esteja usando a NSD para procurar serviços locais. Lembre-se de que o nome deve ser exclusivo para cada serviço na e o Android lida automaticamente com a resolução de conflitos. Se dois dispositivos na rede têm o aplicativo NsdChat instalado, um dos eles mudam o nome do serviço automaticamente, para algo como "NsdChat". (1)".

O segundo define o tipo de serviço e especifica qual protocolo e transporte que o aplicativo usa. A sintaxe é "_<protocolo>._<camadadetransporte>". Na snippet de código, o serviço usa o protocolo HTTP executado em TCP. Um aplicativo oferecer um serviço de impressora (por exemplo, uma impressora em rede) definiria como "_ipp._tcp".

Observação : os números atribuídos internacionalmente Authority (IANA) gerencia um banco de dados lista autoritativa de tipos de serviço usados por protocolos de descoberta de serviços, como NSD e Bonjour. Você pode fazer download da lista no Lista IANA de nomes de serviço e números de porta. Se você pretende usar um novo tipo de serviço, reserve-o preenchendo da IANA Ports and Service formulário de inscrição.

Ao configurar a porta do seu serviço, evite fixá-la no código, entrar em conflito com outros aplicativos. Por exemplo, supondo que que o seu aplicativo sempre use a porta 1337 o colocará em potencial conflito com e outros aplicativos instalados que usam a mesma porta. Em vez disso, use o próxima porta disponível. Como essas informações são fornecidas a outros apps por um a transmissão do serviço, não é preciso que a porta que seu aplicativo conhecidos por outros aplicativos em tempo de compilação. Em vez disso, os aplicativos podem receber essas informações da transmissão do serviço, logo antes de se conectar ao serviço.

Se estiver trabalhando com soquetes, aqui está como você pode inicializar um soquete para qualquer disponível apenas definindo-a como 0.

fun initializeServerSocket() {
    // Initialize a server socket on the next available port.
    serverSocket = ServerSocket(0).also { socket ->
        // Store the chosen port.
        mLocalPort = socket.localPort
        ...
    }
}

public void initializeServerSocket() {
    // Initialize a server socket on the next available port.
    serverSocket = new ServerSocket(0);

    // Store the chosen port.
    localPort = serverSocket.getLocalPort();
    ...
}

Agora que você definiu o objeto NsdServiceInfo, é preciso implementar a interface RegistrationListener. Isso interface contém callbacks usados pelo Android para alertar seu aplicativo do sucesso ou falha do registro e cancelamento do registro do serviço.

private val registrationListener = object : NsdManager.RegistrationListener {

    override fun onServiceRegistered(NsdServiceInfo: NsdServiceInfo) {
        // Save the service name. Android may have changed it in order to
        // resolve a conflict, so update the name you initially requested
        // with the name Android actually used.
        mServiceName = NsdServiceInfo.serviceName
    }

    override fun onRegistrationFailed(serviceInfo: NsdServiceInfo, errorCode: Int) {
        // Registration failed! Put debugging code here to determine why.
    }

    override fun onServiceUnregistered(arg0: NsdServiceInfo) {
        // Service has been unregistered. This only happens when you call
        // NsdManager.unregisterService() and pass in this listener.
    }

    override fun onUnregistrationFailed(serviceInfo: NsdServiceInfo, errorCode: Int) {
        // Unregistration failed. Put debugging code here to determine why.
    }
}

public void initializeRegistrationListener() {
    registrationListener = new NsdManager.RegistrationListener() {

        @Override
        public void onServiceRegistered(NsdServiceInfo NsdServiceInfo) {
            // Save the service name. Android may have changed it in order to
            // resolve a conflict, so update the name you initially requested
            // with the name Android actually used.
            serviceName = NsdServiceInfo.getServiceName();
        }

        @Override
        public void onRegistrationFailed(NsdServiceInfo serviceInfo, int errorCode) {
            // Registration failed! Put debugging code here to determine why.
        }

        @Override
        public void onServiceUnregistered(NsdServiceInfo arg0) {
            // Service has been unregistered. This only happens when you call
            // NsdManager.unregisterService() and pass in this listener.
        }

        @Override
        public void onUnregistrationFailed(NsdServiceInfo serviceInfo, int errorCode) {
            // Unregistration failed. Put debugging code here to determine why.
        }
    };
}

Agora você tem tudo o que precisa para registrar seu serviço. Chame o método registerService():

Esse método é assíncrono. Portanto, qualquer código que precise ser executado Depois que o serviço for registrado, acesse o método onServiceRegistered().

fun registerService(port: Int) {
    // Create the NsdServiceInfo object, and populate it.
    val serviceInfo = NsdServiceInfo().apply {
        // The name is subject to change based on conflicts
        // with other services advertised on the same network.
        serviceName = "NsdChat"
        serviceType = "_nsdchat._tcp"
        setPort(port)
    }

    nsdManager = (getSystemService(Context.NSD_SERVICE) as NsdManager).apply {
        registerService(serviceInfo, NsdManager.PROTOCOL_DNS_SD, registrationListener)
    }
}

public void registerService(int port) {
    NsdServiceInfo serviceInfo = new NsdServiceInfo();
    serviceInfo.setServiceName("NsdChat");
    serviceInfo.setServiceType("_http._tcp.");
    serviceInfo.setPort(port);

    nsdManager = Context.getSystemService(Context.NSD_SERVICE);

    nsdManager.registerService(
            serviceInfo, NsdManager.PROTOCOL_DNS_SD, registrationListener);
}

Descobrir serviços na rede

A rede está repleta de vida, de impressoras ferozes de webcams dóceis de rede e as batalhas brutais e ferozes de um jogo da velha próximo jogadores. A chave para permitir que seu aplicativo veja esse ecossistema vibrante de é a descoberta de serviços. Seu aplicativo precisa detectar serviços transmissões na rede para ver quais serviços estão disponíveis e filtrar qualquer coisa com a qual o aplicativo não possa trabalhar.

A descoberta de serviços, assim como o registro de serviço, tem duas etapas: a configuração de um listener de descoberta com os callbacks relevantes e a criação de uma única Chamada de API para discoverServices().

Primeiro, instancie uma classe anônima que implemente NsdManager.DiscoveryListener. O snippet a seguir mostra exemplo simples:

// Instantiate a new DiscoveryListener
private val discoveryListener = object : NsdManager.DiscoveryListener {

    // Called as soon as service discovery begins.
    override fun onDiscoveryStarted(regType: String) {
        Log.d(TAG, "Service discovery started")
    }

    override fun onServiceFound(service: NsdServiceInfo) {
        // A service was found! Do something with it.
        Log.d(TAG, "Service discovery success$service")
        when {
            service.serviceType != SERVICE_TYPE -> // Service type is the string containing the protocol and
                // transport layer for this service.
                Log.d(TAG, "Unknown Service Type: ${service.serviceType}")
            service.serviceName == mServiceName -> // The name of the service tells the user what they'd be
                // connecting to. It could be "Bob's Chat App".
                Log.d(TAG, "Same machine: $mServiceName")
            service.serviceName.contains("NsdChat") -> nsdManager.resolveService(service, resolveListener)
        }
    }

    override fun onServiceLost(service: NsdServiceInfo) {
        // When the network service is no longer available.
        // Internal bookkeeping code goes here.
        Log.e(TAG, "service lost: $service")
    }

    override fun onDiscoveryStopped(serviceType: String) {
        Log.i(TAG, "Discovery stopped: $serviceType")
    }

    override fun onStartDiscoveryFailed(serviceType: String, errorCode: Int) {
        Log.e(TAG, "Discovery failed: Error code:$errorCode")
        nsdManager.stopServiceDiscovery(this)
    }

    override fun onStopDiscoveryFailed(serviceType: String, errorCode: Int) {
        Log.e(TAG, "Discovery failed: Error code:$errorCode")
        nsdManager.stopServiceDiscovery(this)
    }
}

public void initializeDiscoveryListener() {

    // Instantiate a new DiscoveryListener
    discoveryListener = new NsdManager.DiscoveryListener() {

        // Called as soon as service discovery begins.
        @Override
        public void onDiscoveryStarted(String regType) {
            Log.d(TAG, "Service discovery started");
        }

        @Override
        public void onServiceFound(NsdServiceInfo service) {
            // A service was found! Do something with it.
            Log.d(TAG, "Service discovery success" + service);
            if (!service.getServiceType().equals(SERVICE_TYPE)) {
                // Service type is the string containing the protocol and
                // transport layer for this service.
                Log.d(TAG, "Unknown Service Type: " + service.getServiceType());
            } else if (service.getServiceName().equals(serviceName)) {
                // The name of the service tells the user what they'd be
                // connecting to. It could be "Bob's Chat App".
                Log.d(TAG, "Same machine: " + serviceName);
            } else if (service.getServiceName().contains("NsdChat")){
                nsdManager.resolveService(service, resolveListener);
            }
        }

        @Override
        public void onServiceLost(NsdServiceInfo service) {
            // When the network service is no longer available.
            // Internal bookkeeping code goes here.
            Log.e(TAG, "service lost: " + service);
        }

        @Override
        public void onDiscoveryStopped(String serviceType) {
            Log.i(TAG, "Discovery stopped: " + serviceType);
        }

        @Override
        public void onStartDiscoveryFailed(String serviceType, int errorCode) {
            Log.e(TAG, "Discovery failed: Error code:" + errorCode);
            nsdManager.stopServiceDiscovery(this);
        }

        @Override
        public void onStopDiscoveryFailed(String serviceType, int errorCode) {
            Log.e(TAG, "Discovery failed: Error code:" + errorCode);
            nsdManager.stopServiceDiscovery(this);
        }
    };
}

A API NSD usa os métodos dessa interface para informar ao aplicativo quando a descoberta é iniciada, quando falha, e quando os serviços são encontrados e perdidos (perdido significa não estará mais disponível"). Esse snippet faz várias verificações quando um serviço é encontrado.

1. O nome do serviço encontrado é comparado ao serviço nome do serviço local para determinar se o dispositivo pegou o próprio broadcast (válido).
2. O tipo de serviço é verificado para confirmar se é um tipo de serviço com o qual o aplicativo pode se conectar.
3. O nome do serviço é verificado para confirmar a conexão com o serviço para o aplicativo.

Verificar o nome do serviço nem sempre é necessário e só é relevante quando você se conectar a um aplicativo específico. Por exemplo, o aplicativo pode só quer se conectar a instâncias em que ele está sendo executado em outros dispositivos. No entanto, se o quer se conectar a uma impressora em rede, basta ver que o tipo de serviço é "_ipp._tcp".

Depois de configurar o listener, chame discoverServices(), transmitindo o tipo de serviço seu aplicativo deve procurar, o protocolo de descoberta a ser usado e a que você criou.

nsdManager.discoverServices(SERVICE_TYPE, NsdManager.PROTOCOL_DNS_SD, discoveryListener)

nsdManager.discoverServices(
        SERVICE_TYPE, NsdManager.PROTOCOL_DNS_SD, discoveryListener);

Conectar-se a serviços na rede

Quando seu aplicativo encontra um serviço na rede para se conectar, ele precisa primeiro determinar as informações de conexão para esse serviço, usando o resolveService(). Implemente um NsdManager.ResolveListener para transmitir e usá-lo para obter um NsdServiceInfo contendo as informações de conexão.

private val resolveListener = object : NsdManager.ResolveListener {

    override fun onResolveFailed(serviceInfo: NsdServiceInfo, errorCode: Int) {
        // Called when the resolve fails. Use the error code to debug.
        Log.e(TAG, "Resolve failed: $errorCode")
    }

    override fun onServiceResolved(serviceInfo: NsdServiceInfo) {
        Log.e(TAG, "Resolve Succeeded. $serviceInfo")

        if (serviceInfo.serviceName == mServiceName) {
            Log.d(TAG, "Same IP.")
            return
        }
        mService = serviceInfo
        val port: Int = serviceInfo.port
        val host: InetAddress = serviceInfo.host
    }
}

public void initializeResolveListener() {
    resolveListener = new NsdManager.ResolveListener() {

        @Override
        public void onResolveFailed(NsdServiceInfo serviceInfo, int errorCode) {
            // Called when the resolve fails. Use the error code to debug.
            Log.e(TAG, "Resolve failed: " + errorCode);
        }

        @Override
        public void onServiceResolved(NsdServiceInfo serviceInfo) {
            Log.e(TAG, "Resolve Succeeded. " + serviceInfo);

            if (serviceInfo.getServiceName().equals(serviceName)) {
                Log.d(TAG, "Same IP.");
                return;
            }
            mService = serviceInfo;
            int port = mService.getPort();
            InetAddress host = mService.getHost();
        }
    };
}

Assim que o serviço for resolvido, seu aplicativo receberá informações detalhadas informações do serviço, como endereço IP e número de porta. Isso é tudo. você precisa criar sua própria conexão de rede com o serviço.

Cancelar o registro do seu serviço ao fechar o aplicativo

É importante ativar e desativar a NSD a funcionalidade adequada durante a fase de preparação no ciclo de vida de ML. Cancelar o registro do aplicativo quando ele é fechado ajuda a evitar outros aplicativos pensem que ainda estão ativos e tentem se conectar reimplantá-lo. Além disso, a descoberta de serviços é uma operação cara e precisa ser interrompida quando a atividade mãe for pausada e reativada quando a atividade for retomado. Substituir os métodos do ciclo de vida da atividade principal e inserir o código para iniciar e interromper a transmissão e a descoberta do serviço, conforme apropriado.

    // In your application's Activity

    override fun onPause() {
        nsdHelper?.tearDown()
        super.onPause()
    }

    override fun onResume() {
        super.onResume()
        nsdHelper?.apply {
            registerService(connection.localPort)
            discoverServices()
        }
    }

    override fun onDestroy() {
        nsdHelper?.tearDown()
        connection.tearDown()
        super.onDestroy()
    }

    // NsdHelper's tearDown method
    fun tearDown() {
        nsdManager.apply {
            unregisterService(registrationListener)
            stopServiceDiscovery(discoveryListener)
        }
    }

    // In your application's Activity

    @Override
    protected void onPause() {
        if (nsdHelper != null) {
            nsdHelper.tearDown();
        }
        super.onPause();
    }

    @Override
    protected void onResume() {
        super.onResume();
        if (nsdHelper != null) {
            nsdHelper.registerService(connection.getLocalPort());
            nsdHelper.discoverServices();
        }
    }

    @Override
    protected void onDestroy() {
        nsdHelper.tearDown();
        connection.tearDown();
        super.onDestroy();
    }

    // NsdHelper's tearDown method
    public void tearDown() {
        nsdManager.unregisterService(registrationListener);
        nsdManager.stopServiceDiscovery(discoveryListener);
    }