com.arashpayan.chirp

Class ChirpBrowser

java.lang.Object

com.arashpayan.chirp.ChirpBrowser

public class ChirpBrowser
extends java.lang.Object

A ChirpBrowser is used to listen for Chirp services on the local network. You can construct and start a browser manually, or use the simpler class builder, like so:

     ChirpBrowser browser = Chirp.browseFor("com.example.service").
                                  listener(this).
                                  start(getApplication());
 

When you no longer need to listen for service(s) you should stop the browser:

     browser.stop();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChirpBrowser.Builder Used to chain configuration calls for creating a ChirpBrowser.

Constructor Summary

Constructors

Constructor and Description
ChirpBrowser(java.lang.String serviceName) Creates a browser that can search for the specified service name.

Method Summary

Modifier and Type	Method and Description
boolean	isStarted() Returns true if the browser is listening for services.
void	setListener(ChirpBrowserListener l) Sets a listener to receive callbacks.
void	start(Application app) Starts listening for and reporting Chirp service(s) on the local network.
void	stop() Stops the browser from listening and reporting services.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChirpBrowser

public ChirpBrowser(@NonNull
                    java.lang.String serviceName)

Creates a browser that can search for the specified service name. It's always easier to use Chirp.browseFor(String) to create and configure a ChirpBrowser instead of using the constructor.

Parameters:

serviceName - a valid service name, or "*" if the browser should return all services on the network

Method Detail

isStarted

public boolean isStarted()

Returns true if the browser is listening for services. False, otherwise.

Returns:

setListener

public void setListener(ChirpBrowserListener l)

Sets a listener to receive callbacks.

Parameters:

l - a ChirpBrowserListener or null

start

public void start(@NonNull
                  Application app)

Starts listening for and reporting Chirp service(s) on the local network.

Parameters:

app - the Application object is requested instead of a Context to avoid memory leaks from an Activity being passed in

stop

public void stop()

Stops the browser from listening and reporting services. The ChirpBrowser can not be reused.