io.netty.channel.group

类 DefaultChannelGroup

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<Channel>

io.netty.channel.group.DefaultChannelGroup

所有已实现的接口:

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.

构造器概要

构造器

构造器和说明
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.

方法概要

限定符和类型	方法和说明
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.

从类继承的方法 java.util.AbstractSet

removeAll

从类继承的方法 java.util.AbstractCollection

addAll, containsAll, retainAll

从类继承的方法 java.lang.Object

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

从接口继承的方法 java.util.Set

addAll, containsAll, removeAll, retainAll, spliterator

从接口继承的方法 java.util.Collection

parallelStream, removeIf, stream

从接口继承的方法 java.lang.Iterable

forEach

构造器详细资料

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.

方法详细资料

name

public java.lang.String name()

从接口复制的说明: ChannelGroup

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

指定者:

name 在接口中 ChannelGroup

find

public Channel find(ChannelId id)

从接口复制的说明: ChannelGroup

Returns the Channel which has the specified ChannelId.

指定者:

find 在接口中 ChannelGroup

返回:

the matching Channel if found. null otherwise.

isEmpty

public boolean isEmpty()

指定者:

isEmpty 在接口中 java.util.Collection<Channel>

指定者:

isEmpty 在接口中 java.util.Set<Channel>

覆盖:

isEmpty 在类中 java.util.AbstractCollection<Channel>

size

public int size()

指定者:

size 在接口中 java.util.Collection<Channel>

指定者:

size 在接口中 java.util.Set<Channel>

指定者:

size 在类中 java.util.AbstractCollection<Channel>

contains

public boolean contains(java.lang.Object o)

指定者:

contains 在接口中 java.util.Collection<Channel>

指定者:

contains 在接口中 java.util.Set<Channel>

覆盖:

contains 在类中 java.util.AbstractCollection<Channel>

add

public boolean add(Channel channel)

指定者:

add 在接口中 java.util.Collection<Channel>

指定者:

add 在接口中 java.util.Set<Channel>

覆盖:

add 在类中 java.util.AbstractCollection<Channel>

remove

public boolean remove(java.lang.Object o)

指定者:

remove 在接口中 java.util.Collection<Channel>

指定者:

remove 在接口中 java.util.Set<Channel>

覆盖:

remove 在类中 java.util.AbstractCollection<Channel>

clear

public void clear()

指定者:

clear 在接口中 java.util.Collection<Channel>

指定者:

clear 在接口中 java.util.Set<Channel>

覆盖:

clear 在类中 java.util.AbstractCollection<Channel>

iterator

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

指定者:

iterator 在接口中 java.lang.Iterable<Channel>

指定者:

iterator 在接口中 java.util.Collection<Channel>

指定者:

iterator 在接口中 java.util.Set<Channel>

指定者:

iterator 在类中 java.util.AbstractCollection<Channel>

toArray

public java.lang.Object[] toArray()

指定者:

toArray 在接口中 java.util.Collection<Channel>

指定者:

toArray 在接口中 java.util.Set<Channel>

覆盖:

toArray 在类中 java.util.AbstractCollection<Channel>

toArray

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

指定者:

toArray 在接口中 java.util.Collection<Channel>

指定者:

toArray 在接口中 java.util.Set<Channel>

覆盖:

toArray 在类中 java.util.AbstractCollection<Channel>

close

public ChannelGroupFuture close()

从接口复制的说明: 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.

指定者:

close 在接口中 ChannelGroup

返回:

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

disconnect

public ChannelGroupFuture disconnect()

从接口复制的说明: ChannelGroup

Disconnects all Channels in this group from their remote peers.

指定者:

disconnect 在接口中 ChannelGroup

返回:

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

deregister

public ChannelGroupFuture deregister()

指定者:

deregister 在接口中 ChannelGroup

返回:

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

write

public ChannelGroupFuture write(java.lang.Object message)

从接口复制的说明: 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 ChannelOutboundInvoker.write(Object) is.

指定者:

write 在接口中 ChannelGroup

返回:

itself

write

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

从接口复制的说明: 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 ChannelOutboundInvoker.write(Object) is.

指定者:

write 在接口中 ChannelGroup

返回:

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)

从接口复制的说明: 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 ChannelOutboundInvoker.write(Object) is. If voidPromise is true ChannelOutboundInvoker.voidPromise() is used for the writes and so the same restrictions to the returned ChannelGroupFuture apply as to a void promise.

指定者:

write 在接口中 ChannelGroup

返回:

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

flush

public ChannelGroup flush()

从接口复制的说明: 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 ChannelOutboundInvoker.write(Object) is.

指定者:

flush 在接口中 ChannelGroup

返回:

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

flushAndWrite

public ChannelGroupFuture flushAndWrite(java.lang.Object message)

指定者:

flushAndWrite 在接口中 ChannelGroup

writeAndFlush

public ChannelGroupFuture writeAndFlush(java.lang.Object message)

从接口复制的说明: ChannelGroup

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

指定者:

writeAndFlush 在接口中 ChannelGroup

disconnect

public ChannelGroupFuture disconnect(ChannelMatcher matcher)

从接口复制的说明: ChannelGroup

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

指定者:

disconnect 在接口中 ChannelGroup

返回:

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

close

public ChannelGroupFuture close(ChannelMatcher matcher)

从接口复制的说明: 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.

指定者:

close 在接口中 ChannelGroup

返回:

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

deregister

public ChannelGroupFuture deregister(ChannelMatcher matcher)

指定者:

deregister 在接口中 ChannelGroup

返回:

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

flush

public ChannelGroup flush(ChannelMatcher matcher)

从接口复制的说明: 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 ChannelOutboundInvoker.write(Object) is.

指定者:

flush 在接口中 ChannelGroup

返回:

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

flushAndWrite

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

指定者:

flushAndWrite 在接口中 ChannelGroup

writeAndFlush

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

从接口复制的说明: ChannelGroup

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

指定者:

writeAndFlush 在接口中 ChannelGroup

writeAndFlush

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

从接口复制的说明: ChannelGroup

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

指定者:

writeAndFlush 在接口中 ChannelGroup

newCloseFuture

public ChannelGroupFuture newCloseFuture()

从接口复制的说明: ChannelGroup

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

指定者:

newCloseFuture 在接口中 ChannelGroup

newCloseFuture

public ChannelGroupFuture newCloseFuture(ChannelMatcher matcher)

从接口复制的说明: ChannelGroup

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

指定者:

newCloseFuture 在接口中 ChannelGroup

hashCode

public int hashCode()

指定者:

hashCode 在接口中 java.util.Collection<Channel>

指定者:

hashCode 在接口中 java.util.Set<Channel>

覆盖:

hashCode 在类中 java.util.AbstractSet<Channel>

equals

public boolean equals(java.lang.Object o)

指定者:

equals 在接口中 java.util.Collection<Channel>

指定者:

equals 在接口中 java.util.Set<Channel>

覆盖:

equals 在类中 java.util.AbstractSet<Channel>

compareTo

public int compareTo(ChannelGroup o)

指定者:

compareTo 在接口中 java.lang.Comparable<ChannelGroup>

toString

public java.lang.String toString()

覆盖:

toString 在类中 java.util.AbstractCollection<Channel>