Package io.netty.channel.group

Class DefaultChannelGroup

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<Channel>

io.netty.channel.group.DefaultChannelGroup

All Implemented Interfaces:

ChannelGroup, java.lang.Comparable<ChannelGroup>, java.lang.Iterable<Channel>, java.util.Collection<Channel>, java.util.Set<Channel>

public class DefaultChannelGroup
extends java.util.AbstractSet<Channel>
implements ChannelGroup

The default ChannelGroup implementation.

Constructor Summary

Constructors

Constructor	Description
DefaultChannelGroup(EventExecutor executor)	Creates a new group with a generated name and the provided EventExecutor to notify the ChannelGroupFutures.
DefaultChannelGroup(EventExecutor executor, boolean stayClosed)	Creates a new group with a generated name and the provided EventExecutor to notify the ChannelGroupFutures.
DefaultChannelGroup(java.lang.String name, EventExecutor executor)	Creates a new group with the specified name and EventExecutor to notify the ChannelGroupFutures.
DefaultChannelGroup(java.lang.String name, EventExecutor executor, boolean stayClosed)	Creates a new group with the specified name and EventExecutor to notify the ChannelGroupFutures.

Method Summary

Modifier and Type	Method	Description
boolean	add(Channel channel)
void	clear()
ChannelGroupFuture	close()	Closes all Channels in this group.
ChannelGroupFuture	close(ChannelMatcher matcher)	Closes all Channels in this group that are matched by the given ChannelMatcher.
int	compareTo(ChannelGroup o)
boolean	contains(java.lang.Object o)
ChannelGroupFuture	deregister()
ChannelGroupFuture	deregister(ChannelMatcher matcher)
ChannelGroupFuture	disconnect()	Disconnects all Channels in this group from their remote peers.
ChannelGroupFuture	disconnect(ChannelMatcher matcher)	Disconnects all Channels in this group from their remote peers, that are matched by the given ChannelMatcher.
boolean	equals(java.lang.Object o)
Channel	find(ChannelId id)	Returns the Channel which has the specified ChannelId.
ChannelGroup	flush()	Flush all Channels in this group.
ChannelGroup	flush(ChannelMatcher matcher)	Flush all Channels in this group that are matched by the given ChannelMatcher.
ChannelGroupFuture	flushAndWrite(java.lang.Object message)
ChannelGroupFuture	flushAndWrite(java.lang.Object message, ChannelMatcher matcher)
int	hashCode()
boolean	isEmpty()
java.util.Iterator<Channel>	iterator()
java.lang.String	name()	Returns the name of this group.
ChannelGroupFuture	newCloseFuture()	Returns the ChannelGroupFuture which will be notified when all Channels that are part of this ChannelGroup, at the time of calling, are closed.
ChannelGroupFuture	newCloseFuture(ChannelMatcher matcher)	Returns the ChannelGroupFuture which will be notified when all Channels that are part of this ChannelGroup, at the time of calling, are closed.
boolean	remove(java.lang.Object o)
int	size()
java.lang.Object[]	toArray()
<T> T[]	toArray(T[] a)
java.lang.String	toString()
ChannelGroupFuture	write(java.lang.Object message)	Writes the specified message to all Channels in this group.
ChannelGroupFuture	write(java.lang.Object message, ChannelMatcher matcher)	Writes the specified message to all Channels in this group that are matched by the given ChannelMatcher.
ChannelGroupFuture	write(java.lang.Object message, ChannelMatcher matcher, boolean voidPromise)	Writes the specified message to all Channels in this group that are matched by the given ChannelMatcher.
ChannelGroupFuture	writeAndFlush(java.lang.Object message)	Shortcut for calling ChannelGroup.write(Object) and ChannelGroup.flush().
ChannelGroupFuture	writeAndFlush(java.lang.Object message, ChannelMatcher matcher)	Shortcut for calling ChannelGroup.write(Object) and ChannelGroup.flush() and only act on Channels that are matched by the ChannelMatcher.
ChannelGroupFuture	writeAndFlush(java.lang.Object message, ChannelMatcher matcher, boolean voidPromise)	Shortcut for calling ChannelGroup.write(Object, ChannelMatcher, boolean) and ChannelGroup.flush() and only act on Channels that are matched by the ChannelMatcher.

Methods inherited from class java.util.AbstractSet

removeAll

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, retainAll

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

addAll, containsAll, removeAll, retainAll, spliterator

Constructor Detail

DefaultChannelGroup

public DefaultChannelGroup(EventExecutor executor)

Creates a new group with a generated name and the provided EventExecutor to notify the ChannelGroupFutures.

DefaultChannelGroup

public DefaultChannelGroup(java.lang.String name,
                           EventExecutor executor)

Creates a new group with the specified name and EventExecutor to notify the ChannelGroupFutures. Please note that different groups can have the same name, which means no duplicate check is done against group names.

DefaultChannelGroup

public DefaultChannelGroup(EventExecutor executor,
                           boolean stayClosed)

Creates a new group with a generated name and the provided EventExecutor to notify the ChannelGroupFutures. stayClosed defines whether or not, this group can be closed more than once. Adding channels to a closed group will immediately close them, too. This makes it easy, to shutdown server and child channels at once.

DefaultChannelGroup

public DefaultChannelGroup(java.lang.String name,
                           EventExecutor executor,
                           boolean stayClosed)

Creates a new group with the specified name and EventExecutor to notify the ChannelGroupFutures. stayClosed defines whether or not, this group can be closed more than once. Adding channels to a closed group will immediately close them, too. This makes it easy, to shutdown server and child channels at once. Please note that different groups can have the same name, which means no duplicate check is done against group names.

Method Detail

name

public java.lang.String name()

Description copied from interface: ChannelGroup

Returns the name of this group. A group name is purely for helping you to distinguish one group from others.

Specified by:

name in interface ChannelGroup

find

public Channel find(ChannelId id)

Description copied from interface: ChannelGroup

Returns the Channel which has the specified ChannelId.

Specified by:

find in interface ChannelGroup

Returns:

the matching Channel if found. null otherwise.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<Channel>

Specified by:

isEmpty in interface java.util.Set<Channel>

Overrides:

isEmpty in class java.util.AbstractCollection<Channel>

size

public int size()

Specified by:

size in interface java.util.Collection<Channel>

Specified by:

size in interface java.util.Set<Channel>

Specified by:

size in class java.util.AbstractCollection<Channel>

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<Channel>

Specified by:

contains in interface java.util.Set<Channel>

Overrides:

contains in class java.util.AbstractCollection<Channel>

add

public boolean add(Channel channel)

Specified by:

add in interface java.util.Collection<Channel>

Specified by:

add in interface java.util.Set<Channel>

Overrides:

add in class java.util.AbstractCollection<Channel>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<Channel>

Specified by:

remove in interface java.util.Set<Channel>

Overrides:

remove in class java.util.AbstractCollection<Channel>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<Channel>

Specified by:

clear in interface java.util.Set<Channel>

Overrides:

clear in class java.util.AbstractCollection<Channel>

iterator

public java.util.Iterator<Channel> iterator()

Specified by:

iterator in interface java.util.Collection<Channel>

Specified by:

iterator in interface java.lang.Iterable<Channel>

Specified by:

iterator in interface java.util.Set<Channel>

Specified by:

iterator in class java.util.AbstractCollection<Channel>

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<Channel>

Specified by:

toArray in interface java.util.Set<Channel>

Overrides:

toArray in class java.util.AbstractCollection<Channel>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface java.util.Collection<Channel>

Specified by:

toArray in interface java.util.Set<Channel>

Overrides:

toArray in class java.util.AbstractCollection<Channel>

close

public ChannelGroupFuture close()

Description copied from interface: ChannelGroup

Closes all Channels in this group. If the Channel is connected to a remote peer or bound to a local address, it is automatically disconnected and unbound.

Specified by:

close in interface ChannelGroup

Returns:

the ChannelGroupFuture instance that notifies when the operation is done for all channels

disconnect

public ChannelGroupFuture disconnect()

Description copied from interface: ChannelGroup

Disconnects all Channels in this group from their remote peers.

Specified by:

disconnect in interface ChannelGroup

Returns:

the ChannelGroupFuture instance that notifies when the operation is done for all channels

deregister

public ChannelGroupFuture deregister()

Specified by:

deregister in interface ChannelGroup

Returns:

the ChannelGroupFuture instance that notifies when the operation is done for all channels

write

public ChannelGroupFuture write(java.lang.Object message)

Description copied from interface: ChannelGroup

Writes the specified message to all Channels in this group. If the specified message is an instance of ByteBuf, it is automatically duplicated to avoid a race condition. The same is true for ByteBufHolder. Please note that this operation is asynchronous as Channel.write(Object) is.

Specified by:

write in interface ChannelGroup

Returns:

itself

write

public ChannelGroupFuture write(java.lang.Object message,
                                ChannelMatcher matcher)

Description copied from interface: ChannelGroup

Writes the specified message to all Channels in this group that are matched by the given ChannelMatcher. If the specified message is an instance of ByteBuf, it is automatically duplicated to avoid a race condition. The same is true for ByteBufHolder. Please note that this operation is asynchronous as Channel.write(Object) is.

Specified by:

write in interface ChannelGroup

Returns:

the ChannelGroupFuture instance that notifies when the operation is done for all channels

write

public ChannelGroupFuture write(java.lang.Object message,
                                ChannelMatcher matcher,
                                boolean voidPromise)

Description copied from interface: ChannelGroup

Writes the specified message to all Channels in this group that are matched by the given ChannelMatcher. If the specified message is an instance of ByteBuf, it is automatically duplicated to avoid a race condition. The same is true for ByteBufHolder. Please note that this operation is asynchronous as Channel.write(Object) is. If voidPromise is true Channel.voidPromise() is used for the writes and so the same restrictions to the returned ChannelGroupFuture apply as to a void promise.

Specified by:

write in interface ChannelGroup

Returns:

the ChannelGroupFuture instance that notifies when the operation is done for all channels

flush

public ChannelGroup flush()

Description copied from interface: ChannelGroup

Flush all Channels in this group. If the specified messages are an instance of ByteBuf, it is automatically duplicated to avoid a race condition. Please note that this operation is asynchronous as Channel.write(Object) is.

Specified by:

flush in interface ChannelGroup

Returns:

the ChannelGroupFuture instance that notifies when the operation is done for all channels

flushAndWrite

public ChannelGroupFuture flushAndWrite(java.lang.Object message)

Specified by:

flushAndWrite in interface ChannelGroup

writeAndFlush

public ChannelGroupFuture writeAndFlush(java.lang.Object message)

Description copied from interface: ChannelGroup

Shortcut for calling ChannelGroup.write(Object) and ChannelGroup.flush().

Specified by:

writeAndFlush in interface ChannelGroup

disconnect

public ChannelGroupFuture disconnect(ChannelMatcher matcher)

Description copied from interface: ChannelGroup

Disconnects all Channels in this group from their remote peers, that are matched by the given ChannelMatcher.

Specified by:

disconnect in interface ChannelGroup

Returns:

the ChannelGroupFuture instance that notifies when the operation is done for all channels

close

public ChannelGroupFuture close(ChannelMatcher matcher)

Description copied from interface: ChannelGroup

Closes all Channels in this group that are matched by the given ChannelMatcher. If the Channel is connected to a remote peer or bound to a local address, it is automatically disconnected and unbound.

Specified by:

close in interface ChannelGroup

Returns:

the ChannelGroupFuture instance that notifies when the operation is done for all channels

deregister

public ChannelGroupFuture deregister(ChannelMatcher matcher)

Specified by:

deregister in interface ChannelGroup

Returns:

the ChannelGroupFuture instance that notifies when the operation is done for all channels

flush

public ChannelGroup flush(ChannelMatcher matcher)

Description copied from interface: ChannelGroup

Flush all Channels in this group that are matched by the given ChannelMatcher. If the specified messages are an instance of ByteBuf, it is automatically duplicated to avoid a race condition. Please note that this operation is asynchronous as Channel.write(Object) is.

Specified by:

flush in interface ChannelGroup

Returns:

the ChannelGroupFuture instance that notifies when the operation is done for all channels

flushAndWrite

public ChannelGroupFuture flushAndWrite(java.lang.Object message,
                                        ChannelMatcher matcher)

Specified by:

flushAndWrite in interface ChannelGroup

writeAndFlush

public ChannelGroupFuture writeAndFlush(java.lang.Object message,
                                        ChannelMatcher matcher)

Description copied from interface: ChannelGroup

Shortcut for calling ChannelGroup.write(Object) and ChannelGroup.flush() and only act on Channels that are matched by the ChannelMatcher.

Specified by:

writeAndFlush in interface ChannelGroup

writeAndFlush

public ChannelGroupFuture writeAndFlush(java.lang.Object message,
                                        ChannelMatcher matcher,
                                        boolean voidPromise)

Description copied from interface: ChannelGroup

Shortcut for calling ChannelGroup.write(Object, ChannelMatcher, boolean) and ChannelGroup.flush() and only act on Channels that are matched by the ChannelMatcher.

Specified by:

writeAndFlush in interface ChannelGroup

newCloseFuture

public ChannelGroupFuture newCloseFuture()

Description copied from interface: ChannelGroup

Returns the ChannelGroupFuture which will be notified when all Channels that are part of this ChannelGroup, at the time of calling, are closed.

Specified by:

newCloseFuture in interface ChannelGroup

newCloseFuture

public ChannelGroupFuture newCloseFuture(ChannelMatcher matcher)

Description copied from interface: ChannelGroup

Returns the ChannelGroupFuture which will be notified when all Channels that are part of this ChannelGroup, at the time of calling, are closed.

Specified by:

newCloseFuture in interface ChannelGroup

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Collection<Channel>

Specified by:

hashCode in interface java.util.Set<Channel>

Overrides:

hashCode in class java.util.AbstractSet<Channel>

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface java.util.Collection<Channel>

Specified by:

equals in interface java.util.Set<Channel>

Overrides:

equals in class java.util.AbstractSet<Channel>

compareTo

public int compareTo(ChannelGroup o)

Specified by:

compareTo in interface java.lang.Comparable<ChannelGroup>

toString

public java.lang.String toString()

Overrides:

toString in class java.util.AbstractCollection<Channel>