DefaultChannelGroup (Netty API Reference (5.0.0.Alpha2))

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractSet<Channel>
  - - io.netty.channel.group.DefaultChannelGroup

All Implemented Interfaces:

ChannelGroup, Comparable<ChannelGroup>, Iterable<Channel>, Collection<Channel>, Set<Channel>
```
public class DefaultChannelGroup
extends AbstractSet<Channel>
implements ChannelGroup
```
The default ChannelGroup implementation.

Constructor Summary

Constructors
Constructor and Description
`DefaultChannelGroup(EventExecutor executor)` Creates a new group with a generated name and the provided `EventExecutor` to notify the `ChannelGroupFuture`s.
`DefaultChannelGroup(String name, EventExecutor executor)` Creates a new group with the specified `name` and `EventExecutor` to notify the `ChannelGroupFuture`s.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`add(Channel channel)`
`void`	`clear()`
`ChannelGroupFuture`	`close()` Closes all `Channel`s in this group.
`ChannelGroupFuture`	`close(ChannelMatcher matcher)` Closes all `Channel`s in this group that match the given `ChannelMatcher`.
`int`	`compareTo(ChannelGroup o)`
`boolean`	`contains(Object o)`
`ChannelGroupFuture`	`deregister()` Deregister all `Channel`s in this group from their `EventLoop`.
`ChannelGroupFuture`	`deregister(ChannelMatcher matcher)` Deregister all `Channel`s in this group from their `EventLoop` that match the given `ChannelMatcher`.
`ChannelGroupFuture`	`disconnect()` Disconnects all `Channel`s in this group from their remote peers.
`ChannelGroupFuture`	`disconnect(ChannelMatcher matcher)` Disconnects all `Channel`s in this group from their remote peers, that match the given `ChannelMatcher`.
`boolean`	`equals(Object o)`
`Channel`	`find(ChannelId id)` Returns the `Channel` which has the specified `ChannelId`.
`ChannelGroup`	`flush()` Flush all `Channel`s in this group.
`ChannelGroup`	`flush(ChannelMatcher matcher)` Flush all `Channel`s in this group that match the given `ChannelMatcher`.
`int`	`hashCode()`
`boolean`	`isEmpty()`
`Iterator<Channel>`	`iterator()`
`String`	`name()` Returns the name of this group.
`boolean`	`remove(Object o)`
`int`	`size()`
`Object[]`	`toArray()`
`<T> T[]`	`toArray(T[] a)`
`String`	`toString()`
`ChannelGroupFuture`	`write(Object message)` Writes the specified `message` to all `Channel`s in this group.
`ChannelGroupFuture`	`write(Object message, ChannelMatcher matcher)` Writes the specified `message` to all `Channel`s in this group that match the given `ChannelMatcher`.
`ChannelGroupFuture`	`writeAndFlush(Object message)` Shortcut for calling `ChannelGroup.write(Object)` and `ChannelGroup.flush()`.
`ChannelGroupFuture`	`writeAndFlush(Object message, ChannelMatcher matcher)` Shortcut for calling `ChannelGroup.write(Object)` and `ChannelGroup.flush()` and only act on `Channel`s that match 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.Set
addAll, containsAll, removeAll, retainAll

- 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(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.
- Method Detail
  - name
```
public 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 Collection<Channel>
    
    Specified by:
    
    isEmpty in interface Set<Channel>
    
    Overrides:
    
    isEmpty in class AbstractCollection<Channel>
  - size
```
public int size()
```
    Specified by:
    
    size in interface Collection<Channel>
    
    Specified by:
    
    size in interface Set<Channel>
    
    Specified by:
    
    size in class AbstractCollection<Channel>
  - contains
```
public boolean contains(Object o)
```
    Specified by:
    
    contains in interface Collection<Channel>
    
    Specified by:
    
    contains in interface Set<Channel>
    
    Overrides:
    
    contains in class AbstractCollection<Channel>
  - add
```
public boolean add(Channel channel)
```
    Specified by:
    
    add in interface Collection<Channel>
    
    Specified by:
    
    add in interface Set<Channel>
    
    Overrides:
    
    add in class AbstractCollection<Channel>
  - remove
```
public boolean remove(Object o)
```
    Specified by:
    
    remove in interface Collection<Channel>
    
    Specified by:
    
    remove in interface Set<Channel>
    
    Overrides:
    
    remove in class AbstractCollection<Channel>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Collection<Channel>
    
    Specified by:
    
    clear in interface Set<Channel>
    
    Overrides:
    
    clear in class AbstractCollection<Channel>
  - iterator
```
public Iterator<Channel> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Channel>
    
    Specified by:
    
    iterator in interface Collection<Channel>
    
    Specified by:
    
    iterator in interface Set<Channel>
    
    Specified by:
    
    iterator in class AbstractCollection<Channel>
  - toArray
```
public Object[] toArray()
```
    Specified by:
    
    toArray in interface Collection<Channel>
    
    Specified by:
    
    toArray in interface Set<Channel>
    
    Overrides:
    
    toArray in class AbstractCollection<Channel>
  - toArray
```
public <T> T[] toArray(T[] a)
```
    Specified by:
    
    toArray in interface Collection<Channel>
    
    Specified by:
    
    toArray in interface Set<Channel>
    
    Overrides:
    
    toArray in class 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()
```
    Description copied from interface: ChannelGroup
    
    Deregister all Channels in this group from their EventLoop. Please note that this operation is asynchronous as Channel.deregister() is.
    
    Specified by:
    
    deregister in interface ChannelGroup
    
    Returns:
    the ChannelGroupFuture instance that notifies when the operation is done for all channels
  - write
```
public ChannelGroupFuture write(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(Object message,
                       ChannelMatcher matcher)
```
    Description copied from interface: ChannelGroup
    
    Writes the specified message to all Channels in this group that match 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
  - 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
  - writeAndFlush
```
public ChannelGroupFuture writeAndFlush(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 match 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 match 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)
```
    Description copied from interface: ChannelGroup
    
    Deregister all Channels in this group from their EventLoop that match the given ChannelMatcher. Please note that this operation is asynchronous as Channel.deregister() is.
    
    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 match 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
  - writeAndFlush
```
public ChannelGroupFuture writeAndFlush(Object message,
                               ChannelMatcher matcher)
```
    Description copied from interface: ChannelGroup
    
    Shortcut for calling ChannelGroup.write(Object) and ChannelGroup.flush() and only act on Channels that match the ChannelMatcher.
    
    Specified by:
    
    writeAndFlush in interface ChannelGroup
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Collection<Channel>
    
    Specified by:
    
    hashCode in interface Set<Channel>
    
    Overrides:
    
    hashCode in class AbstractSet<Channel>
  - equals
```
public boolean equals(Object o)
```
    Specified by:
    
    equals in interface Collection<Channel>
    
    Specified by:
    
    equals in interface Set<Channel>
    
    Overrides:
    
    equals in class AbstractSet<Channel>
  - compareTo
```
public int compareTo(ChannelGroup o)
```
    Specified by:
    
    compareTo in interface Comparable<ChannelGroup>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AbstractCollection<Channel>

Class DefaultChannelGroup

Constructor Summary

Method Summary

Methods inherited from class java.util.AbstractSet

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Set

Constructor Detail

DefaultChannelGroup

DefaultChannelGroup

Method Detail

name

find

isEmpty

size

contains

add

remove

clear

iterator

toArray

toArray

close

disconnect

deregister

write

write

flush

writeAndFlush

disconnect

close

deregister

flush

writeAndFlush

hashCode

equals

compareTo

toString