com.arashpayan.chirp

Class Chirp

java.lang.Object

com.arashpayan.chirp.Chirp

public class Chirp
extends java.lang.Object

Start here to use this library.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_PAYLOAD_BYTES The maximum size of a payload when serialized into JSON.

Method Summary

Modifier and Type	Method and Description
static ChirpBrowser.Builder	browseFor(java.lang.String serviceName) Convenience method for creating a ChirpBrowser.
static boolean	isValidServiceName(java.lang.String name) Checks if name can be used as a Chirp service name.
static ChirpPublisher.Builder	publish(java.lang.String serviceName) Convenience method for creating a ChirpPublisher.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_PAYLOAD_BYTES

public static final int MAX_PAYLOAD_BYTES

The maximum size of a payload when serialized into JSON. Chirp uses gson for serializing payloads into JSON.

See Also:

Constant Field Values

Method Detail

browseFor

public static ChirpBrowser.Builder browseFor(@NonNull
                                             java.lang.String serviceName)

Convenience method for creating a ChirpBrowser.

Parameters:

serviceName - the name of the service to browse/listen for. Pass in "*" if you want to listen for all services on the network

Returns:

a ChirpBrowser.Builder

isValidServiceName

public static boolean isValidServiceName(java.lang.String name)

Checks if name can be used as a Chirp service name. Service names must a) not be empty, b) consist of characters from a-z, A-Z, 0-9, . (period), or - (hyphen), and c) be less than 32 characters. The ideal service name is a reverse dns style string. e.g. com.example.something

Parameters:

name - the string to test for validity

Returns:

true if the string can be used as a Chirp service name. false otherwise.

publish

public static ChirpPublisher.Builder publish(@NonNull
                                             java.lang.String serviceName)

Convenience method for creating a ChirpPublisher.

Parameters:

serviceName - the name of the service to publish

Returns:

a Builder that can be configured further or used to start and return the ChirpPublisher