Class ZBeacon

java.lang.Object

org.zeromq.ZBeacon

public class ZBeacon
extends Object

This class implements a peer-to-peer discovery service for local networks. A beacon can broadcast and/or capture service announcements using UDP messages on the local area network. This implementation uses IPv4 UDP broadcasts. You can define the format of your outgoing beacons, and set a filter that validates incoming beacons. Beacons are sent and received asynchronously in the background.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	ZBeacon.BroadcastClient	The broadcast client periodically sends beacons via UDP to the network.
private class	ZBeacon.BroadcastServer	The broadcast server receives beacons.
static class	ZBeacon.Builder
static interface	ZBeacon.Listener	All beacons with matching prefix are passed to a listener.

Field Summary

Fields

Modifier and Type	Field	Description
private final AtomicReference<byte[]>	beacon
private final ZBeacon.BroadcastClient	broadcastClient
private final AtomicLong	broadcastInterval
private final ZBeacon.BroadcastServer	broadcastServer
private final AtomicReference<Thread.UncaughtExceptionHandler>	clientExHandler
private static final InetAddress	DEFAULT_BROADCAST_ADDRESS
static final String	DEFAULT_BROADCAST_HOST
private static final InetAddress	DEFAULT_BROADCAST_HOST_ADDRESS
static final long	DEFAULT_BROADCAST_INTERVAL
private final AtomicReference<ZBeacon.Listener>	listener
private final AtomicReference<byte[]>	prefix
private final AtomicReference<Thread.UncaughtExceptionHandler>	serverExHandler

Constructor Summary

Constructors

Constructor	Description
ZBeacon(int port, byte[] beacon)
ZBeacon(String broadcastAddress, byte[] serverAddress, int port, byte[] beacon, long broadcastInterval, boolean ignoreLocalAddress, boolean blocking)	Deprecated.
ZBeacon(String host, int port, byte[] beacon)
ZBeacon(String host, int port, byte[] beacon, boolean ignoreLocalAddress)
ZBeacon(String host, int port, byte[] beacon, boolean ignoreLocalAddress, boolean blocking)
ZBeacon(InetAddress broadcastAddress, InetAddress serverAddress, int port, byte[] beacon, long broadcastInterval, boolean ignoreLocalAddress, boolean blocking)

Method Summary

Modifier and Type	Method	Description
byte[]	getBeacon()
long	getBroadcastInterval()
ZBeacon.Listener	getListener()
byte[]	getPrefix()
void	setBeacon(byte[] beacon)	Deprecated. use the builder
void	setBroadcastInterval(long broadcastInterval)
void	setListener(ZBeacon.Listener listener)	Deprecated. use the builder
void	setPrefix(byte[] prefix)	Deprecated. use the builder
void	setUncaughtExceptionHandlers(Thread.UncaughtExceptionHandler clientExHandler, Thread.UncaughtExceptionHandler serverExHandler)	Deprecated. use the builder
void	start()
void	startClient()
void	startServer()
void	stop()

Methods inherited from class Object

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

Field Details

DEFAULT_BROADCAST_INTERVAL

public static final long DEFAULT_BROADCAST_INTERVAL

See Also:

• Constant Field Values

DEFAULT_BROADCAST_HOST

public static final String DEFAULT_BROADCAST_HOST

See Also:

• Constant Field Values

DEFAULT_BROADCAST_HOST_ADDRESS

private static final InetAddress DEFAULT_BROADCAST_HOST_ADDRESS

DEFAULT_BROADCAST_ADDRESS

private static final InetAddress DEFAULT_BROADCAST_ADDRESS

broadcastClient

private final ZBeacon.BroadcastClient broadcastClient

broadcastServer

private final ZBeacon.BroadcastServer broadcastServer

prefix

private final AtomicReference<byte[]> prefix

beacon

private final AtomicReference<byte[]> beacon

broadcastInterval

private final AtomicLong broadcastInterval

listener

private final AtomicReference<ZBeacon.Listener> listener

clientExHandler

private final AtomicReference<Thread.UncaughtExceptionHandler> clientExHandler

serverExHandler

private final AtomicReference<Thread.UncaughtExceptionHandler> serverExHandler

Constructor Details

ZBeacon

public ZBeacon(int port,
 byte[] beacon)

ZBeacon

public ZBeacon(String host,
 int port,
 byte[] beacon)

ZBeacon

public ZBeacon(String host,
 int port,
 byte[] beacon,
 boolean ignoreLocalAddress)

ZBeacon

public ZBeacon(String host,
 int port,
 byte[] beacon,
 boolean ignoreLocalAddress,
 boolean blocking)

ZBeacon

public ZBeacon(InetAddress broadcastAddress,
 InetAddress serverAddress,
 int port,
 byte[] beacon,
 long broadcastInterval,
 boolean ignoreLocalAddress,
 boolean blocking)

ZBeacon

@Deprecated
public ZBeacon(String broadcastAddress,
 byte[] serverAddress,
 int port,
 byte[] beacon,
 long broadcastInterval,
 boolean ignoreLocalAddress,
 boolean blocking)

Deprecated.

Method Details

setUncaughtExceptionHandlers

@Deprecated
public void setUncaughtExceptionHandlers(Thread.UncaughtExceptionHandler clientExHandler,
 Thread.UncaughtExceptionHandler serverExHandler)

Deprecated.

use the builder

Parameters:

clientExHandler -

serverExHandler -

startClient

public void startClient()

startServer

public void startServer()

start

public void start()

stop

public void stop()
          throws InterruptedException

Throws:

InterruptedException

setBeacon

@Deprecated
public void setBeacon(byte[] beacon)

Deprecated.

use the builder

Parameters:

beacon -

getBeacon

public byte[] getBeacon()

setPrefix

@Deprecated
public void setPrefix(byte[] prefix)

Deprecated.

use the builder

Parameters:

prefix -

getPrefix

public byte[] getPrefix()

setListener

@Deprecated
public void setListener(ZBeacon.Listener listener)

Deprecated.

use the builder

Parameters:

listener -

getListener

public ZBeacon.Listener getListener()

getBroadcastInterval

public long getBroadcastInterval()

setBroadcastInterval

public void setBroadcastInterval(long broadcastInterval)