org.elasticsearch.common.network

Class MulticastChannel

java.lang.Object

org.elasticsearch.common.network.MulticastChannel

All Implemented Interfaces:

Closeable, AutoCloseable

public abstract class MulticastChannel
extends Object
implements Closeable

A multicast channel that supports registering for receive events, and sending datagram packets. Allows to easily share the same multicast socket if it holds the same config.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MulticastChannel.Config Config of multicast channel.
static interface	MulticastChannel.Listener Listener that gets called when data is received on the multicast channel.
static class	MulticastChannel.MultiListener Simple listener that wraps multiple listeners into one.

Field Summary

Fields

Modifier and Type	Field and Description
protected MulticastChannel.Listener	listener
static String	SHARED_CHANNEL_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MulticastChannel(MulticastChannel.Listener listener)

Method Summary

Modifier and Type	Method and Description
void	close() Close the channel.
protected abstract void	close(MulticastChannel.Listener listener)
static MulticastChannel	getChannel(String name, boolean shared, MulticastChannel.Config config, MulticastChannel.Listener listener) Builds a channel based on the provided config, allowing to control if sharing a channel that uses the same config is allowed or not.
abstract void	send(BytesReference data) Send the data over the multicast channel.

Methods inherited from class java.lang.Object

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

Field Detail

listener

protected final MulticastChannel.Listener listener

SHARED_CHANNEL_NAME

public static final String SHARED_CHANNEL_NAME

See Also:

Constant Field Values

Constructor Detail

MulticastChannel

protected MulticastChannel(MulticastChannel.Listener listener)

Method Detail

getChannel

public static MulticastChannel getChannel(String name,
                                          boolean shared,
                                          MulticastChannel.Config config,
                                          MulticastChannel.Listener listener)
                                   throws Exception

Builds a channel based on the provided config, allowing to control if sharing a channel that uses the same config is allowed or not.

Throws:

Exception

send

public abstract void send(BytesReference data)
                   throws Exception

Send the data over the multicast channel.

Throws:

Exception

close

public void close()

Close the channel.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

close

protected abstract void close(MulticastChannel.Listener listener)