com.arashpayan.chirp

Class ChirpPublisher.Builder

java.lang.Object

com.arashpayan.chirp.ChirpPublisher.Builder

Enclosing class:

ChirpPublisher

public static class ChirpPublisher.Builder
extends java.lang.Object

Used to chain configuration calls for creating a ChirpPublisher.

Constructor Summary

Constructors

Constructor and Description
Builder(java.lang.String serviceName)

Method Summary

Modifier and Type	Method and Description
ChirpPublisher.Builder	payload(java.util.Map<java.lang.String,java.lang.Object> p) Sets a payload with arbitrary data to be associated with the service
ChirpPublisher	start(Application app) Starts the publisher and returns it
ChirpPublisher.Builder	ttl(int ttl) Sets the TTL of the service.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

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

Method Detail

payload

public ChirpPublisher.Builder payload(java.util.Map<java.lang.String,java.lang.Object> p)

Sets a payload with arbitrary data to be associated with the service

Parameters:

p - the payload

Returns:

the Builder object for method chaining

ttl

public ChirpPublisher.Builder ttl(int ttl)

Sets the TTL of the service. There's not really a good reason to set this, unless you're debugging the library or implementing Chirp in another language and need to test with this.

Parameters:

ttl - the ttl to use for the service

Returns:

the same Builder object for method chaining

start

public ChirpPublisher start(Application app)

Starts the publisher and returns it

Parameters:

app - the Application object is used instead of a Context to make sure an Activity, which could leak, isn't passed in

Returns:

the newly created and started ChirpPublisher