Modifier and Type	Class and Description
private static class	VertxEventLoopGroup.EventLoopHolder
private static class	VertxEventLoopGroup.EventLoopIterator

Modifier and Type	Field and Description
private final Set<EventExecutor>	children
private int	pos
private final List<VertxEventLoopGroup.EventLoopHolder>	workers

Access	Constructor and Description
public	VertxEventLoopGroup()

Method Summary

Modifier and Type	Method and Description
public synchronized void	addWorker(EventLoop worker)
public synchronized boolean	awaitTermination(long the maximum time to wait timeout, TimeUnit the time unit of the timeout argument unit) Implements java.util.concurrent.ExecutorService.awaitTermination. Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.
private void	checkPos()
private VertxEventLoopGroup.EventLoopHolder	findHolder(EventLoop worker)
public boolean	isShutdown() Implements java.util.concurrent.ExecutorService.isShutdown. Returns `true` if this executor has been shut down.
public boolean	isShuttingDown() Implements io.netty.util.concurrent.EventExecutorGroup.isShuttingDown. Returns `true` if and only if all `EventExecutor`s managed by this `EventExecutorGroup` are being shut down gracefully or was shut down.
public boolean	isTerminated() Implements java.util.concurrent.ExecutorService.isTerminated. Returns `true` if all tasks have completed following shut down.
public Iterator<EventExecutor>	iterator() Implements io.netty.util.concurrent.EventExecutorGroup.iterator. Returns an iterator over elements of type `T`.
public synchronized EventLoop	next() Implements io.netty.channel.EventLoopGroup.next, io.netty.util.concurrent.EventExecutorGroup.next. Return the next `EventLoop` to use
public ChannelFuture	register(Channel channel) Implements io.netty.channel.EventLoopGroup.register. Register a `Channel` with this `EventLoop`.
public ChannelFuture	register(Channel channel, ChannelPromise promise) Implements io.netty.channel.EventLoopGroup.register. Register a `Channel` with this `EventLoop`.
public ChannelFuture	register(ChannelPromise promise) Implements io.netty.channel.EventLoopGroup.register. Register a `Channel` with this `EventLoop` using a `ChannelFuture`.
public synchronized void	removeWorker(EventLoop worker)
public synchronized void	shutdown() Implements abstract io.netty.util.concurrent.AbstractEventExecutorGroup.shutdown. Implements io.netty.util.concurrent.EventExecutorGroup.shutdown. Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted.
public Future<?>	shutdownGracefully(long the quiet period as described in the documentation quietPeriod, long the maximum amount of time to wait until the executor is shutdown() regardless if a task was submitted during the quiet period timeout, TimeUnit the unit of `quietPeriod` and `timeout` unit) Implements io.netty.util.concurrent.EventExecutorGroup.shutdownGracefully. Signals this executor that the caller wants the executor to be shut down.
public Future<?>	terminationFuture() Implements io.netty.util.concurrent.EventExecutorGroup.terminationFuture. Returns the `Future` which is notified when all `EventExecutor`s managed by this `EventExecutorGroup` have been terminated.
public synchronized int	workerCount()

Inherited from io.netty.util.concurrent.AbstractEventExecutorGroup:: execute invokeAll invokeAll invokeAny invokeAny schedule schedule scheduleAtFixedRate scheduleWithFixedDelay shutdownGracefully shutdownNow submit submit submit

Field Detail

children	back to summary
private final Set<EventExecutor> children

pos	back to summary
private int pos

workers	back to summary
private final List<VertxEventLoopGroup.EventLoopHolder> workers

Constructor Detail

VertxEventLoopGroup	back to summary
public VertxEventLoopGroup()

Method Detail

addWorker	back to summary
public synchronized void addWorker(EventLoop worker)

awaitTermination back to summary

awaitTermination	back to summary
public synchronized boolean awaitTermination(long timeout, TimeUnit unit) Implements java.util.concurrent.ExecutorService.awaitTermination. Doc from java.util.concurrent.ExecutorService.awaitTermination. Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first. Parameters timeout:long the maximum time to wait unit:TimeUnit the time unit of the timeout argument Returns:boolean `true` if this executor terminated and `false` if the timeout elapsed before termination Annotations @Override

public synchronized boolean awaitTermination(long timeout, TimeUnit unit)

Implements java.util.concurrent.ExecutorService.awaitTermination.

Doc from java.util.concurrent.ExecutorService.awaitTermination.

Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.

Parameters

timeout:long: the maximum time to wait
unit:TimeUnit: the time unit of the timeout argument

Returns:boolean

true if this executor terminated and false if the timeout elapsed before termination

Annotations

@Override

checkPos	back to summary
private void checkPos()

findHolder	back to summary
private VertxEventLoopGroup.EventLoopHolder findHolder(EventLoop worker)

isShutdown back to summary

isShutdown	back to summary
public boolean isShutdown() Implements java.util.concurrent.ExecutorService.isShutdown. Doc from java.util.concurrent.ExecutorService.isShutdown. Returns `true` if this executor has been shut down. Returns:boolean `true` if this executor has been shut down Annotations @Override

public boolean isShutdown()

Implements java.util.concurrent.ExecutorService.isShutdown.

Doc from java.util.concurrent.ExecutorService.isShutdown.

Returns true if this executor has been shut down.

Returns:boolean

true if this executor has been shut down

Annotations

@Override

isShuttingDown back to summary

isShuttingDown	back to summary
public boolean isShuttingDown() Implements io.netty.util.concurrent.EventExecutorGroup.isShuttingDown. Doc from io.netty.util.concurrent.EventExecutorGroup.isShuttingDown. Returns `true` if and only if all `EventExecutor`s managed by this `EventExecutorGroup` are being shut down gracefully or was shut down. Annotations @Override

public boolean isShuttingDown()

Implements io.netty.util.concurrent.EventExecutorGroup.isShuttingDown.

Doc from io.netty.util.concurrent.EventExecutorGroup.isShuttingDown.

Returns true if and only if all EventExecutors managed by this EventExecutorGroup are being shut down gracefully or was shut down.

Annotations

@Override

isTerminated back to summary

isTerminated	back to summary
public boolean isTerminated() Implements java.util.concurrent.ExecutorService.isTerminated. Doc from java.util.concurrent.ExecutorService.isTerminated. Returns `true` if all tasks have completed following shut down. Note that `isTerminated` is never `true` unless either `shutdown` or `shutdownNow` was called first. Returns:boolean `true` if all tasks have completed following shut down Annotations @Override

public boolean isTerminated()

Implements java.util.concurrent.ExecutorService.isTerminated.

Doc from java.util.concurrent.ExecutorService.isTerminated.

Returns true if all tasks have completed following shut down. Note that isTerminated is never true unless either shutdown or shutdownNow was called first.

Returns:boolean

true if all tasks have completed following shut down

Annotations

@Override

iterator back to summary

iterator	back to summary
public Iterator<EventExecutor> iterator() Implements io.netty.util.concurrent.EventExecutorGroup.iterator. Doc from java.lang.Iterable.iterator. Returns an iterator over elements of type `T`. Returns:Iterator<EventExecutor> an Iterator. Annotations @Override

public Iterator<EventExecutor> iterator()

Implements io.netty.util.concurrent.EventExecutorGroup.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Returns:Iterator<EventExecutor>

an Iterator.

Annotations

@Override

next back to summary

next	back to summary
public synchronized EventLoop next() Implements io.netty.channel.EventLoopGroup.next, io.netty.util.concurrent.EventExecutorGroup.next. Doc from io.netty.channel.EventLoopGroup.next. Return the next `EventLoop` to use Annotations @Override

public synchronized EventLoop next()

Implements io.netty.channel.EventLoopGroup.next, io.netty.util.concurrent.EventExecutorGroup.next.

Doc from io.netty.channel.EventLoopGroup.next.

Return the next EventLoop to use

Annotations

@Override

register	back to summary
public ChannelFuture register(Channel channel) Implements io.netty.channel.EventLoopGroup.register. Doc from io.netty.channel.EventLoopGroup.register. Register a `Channel` with this `EventLoop`. The returned `ChannelFuture` will get notified once the registration was complete. Annotations @Override

public ChannelFuture register(Channel channel)

Implements io.netty.channel.EventLoopGroup.register.

Doc from io.netty.channel.EventLoopGroup.register.

Register a Channel with this EventLoop. The returned ChannelFuture will get notified once the registration was complete.

Annotations

@Override

register	back to summary
public ChannelFuture register(Channel channel, ChannelPromise promise) Implements io.netty.channel.EventLoopGroup.register. Doc from io.netty.channel.EventLoopGroup.register. Register a `Channel` with this `EventLoop`. The passed `ChannelFuture` will get notified once the registration was complete and also will get returned. Annotations @Override

public ChannelFuture register(Channel channel, ChannelPromise promise)

Implements io.netty.channel.EventLoopGroup.register.

Doc from io.netty.channel.EventLoopGroup.register.

Register a Channel with this EventLoop. The passed ChannelFuture will get notified once the registration was complete and also will get returned.

Annotations

@Override

register	back to summary
public ChannelFuture register(ChannelPromise promise) Implements io.netty.channel.EventLoopGroup.register. Doc from io.netty.channel.EventLoopGroup.register. Register a `Channel` with this `EventLoop` using a `ChannelFuture`. The passed `ChannelFuture` will get notified once the registration was complete and also will get returned. Annotations @Override

public ChannelFuture register(ChannelPromise promise)

Implements io.netty.channel.EventLoopGroup.register.

Doc from io.netty.channel.EventLoopGroup.register.

Register a Channel with this EventLoop using a ChannelFuture. The passed ChannelFuture will get notified once the registration was complete and also will get returned.

Annotations

@Override

removeWorker	back to summary
public synchronized void removeWorker(EventLoop worker)

shutdown back to summary

shutdown	back to summary
public synchronized void shutdown() Implements abstract io.netty.util.concurrent.AbstractEventExecutorGroup.shutdown. Implements io.netty.util.concurrent.EventExecutorGroup.shutdown. Doc from java.util.concurrent.ExecutorService.shutdown. Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted. Invocation has no additional effect if already shut down. This method does not wait for previously submitted tasks to complete execution. Use `awaitTermination` to do that.

public synchronized void shutdown()

Implements abstract io.netty.util.concurrent.AbstractEventExecutorGroup.shutdown.

Implements io.netty.util.concurrent.EventExecutorGroup.shutdown.

Doc from java.util.concurrent.ExecutorService.shutdown.

Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted. Invocation has no additional effect if already shut down.

This method does not wait for previously submitted tasks to complete execution. Use awaitTermination to do that.

shutdownGracefully back to summary

shutdownGracefully	back to summary
public Future<?> shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit) Implements io.netty.util.concurrent.EventExecutorGroup.shutdownGracefully. Doc from io.netty.util.concurrent.EventExecutorGroup.shutdownGracefully. Signals this executor that the caller wants the executor to be shut down. Once this method is called, `isShuttingDown()` starts to return `true`, and the executor prepares to shut itself down. Unlike `shutdown()`, graceful shutdown ensures that no tasks are submitted for 'the quiet period' (usually a couple seconds) before it shuts itself down. If a task is submitted during the quiet period, it is guaranteed to be accepted and the quiet period will start over. Parameters quietPeriod:long the quiet period as described in the documentation timeout:long the maximum amount of time to wait until the executor is shutdown() regardless if a task was submitted during the quiet period unit:TimeUnit the unit of `quietPeriod` and `timeout` Returns:Future<?> the `terminationFuture()` Annotations @Override

public Future<?> shutdownGracefully(long quietPeriod, long timeout, TimeUnit unit)

Implements io.netty.util.concurrent.EventExecutorGroup.shutdownGracefully.

Doc from io.netty.util.concurrent.EventExecutorGroup.shutdownGracefully.

Signals this executor that the caller wants the executor to be shut down. Once this method is called, isShuttingDown() starts to return true, and the executor prepares to shut itself down. Unlike shutdown(), graceful shutdown ensures that no tasks are submitted for 'the quiet period' (usually a couple seconds) before it shuts itself down. If a task is submitted during the quiet period, it is guaranteed to be accepted and the quiet period will start over.

Parameters

quietPeriod:long: the quiet period as described in the documentation
timeout:long: the maximum amount of time to wait until the executor is shutdown() regardless if a task was submitted during the quiet period
unit:TimeUnit: the unit of quietPeriod and timeout

Returns:Future<?>

the terminationFuture()

Annotations

@Override

terminationFuture back to summary

terminationFuture	back to summary
public Future<?> terminationFuture() Implements io.netty.util.concurrent.EventExecutorGroup.terminationFuture. Doc from io.netty.util.concurrent.EventExecutorGroup.terminationFuture. Returns the `Future` which is notified when all `EventExecutor`s managed by this `EventExecutorGroup` have been terminated. Annotations @Override

public Future<?> terminationFuture()

Implements io.netty.util.concurrent.EventExecutorGroup.terminationFuture.

Doc from io.netty.util.concurrent.EventExecutorGroup.terminationFuture.

Returns the Future which is notified when all EventExecutors managed by this EventExecutorGroup have been terminated.

Annotations

@Override

workerCount	back to summary
public synchronized int workerCount()

io.vertx.core.net.impl back to summary

private Class VertxEventLoopGroup.EventLoopHolder

Class Inheritance

extends Object

java.lang.Object
io.vertx.core.net.impl.VertxEventLoopGroup.EventLoopHolder

Field Summary

Modifier and Type	Field and Description
pack-priv int	count
pack-priv final EventLoop	worker

Constructor Summary

Access	Constructor and Description
pack-priv	EventLoopHolder(EventLoop worker)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

Field Detail

count	back to summary
pack-priv int count

worker	back to summary
pack-priv final EventLoop worker

Constructor Detail

EventLoopHolder	back to summary
pack-priv EventLoopHolder(EventLoop worker)

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

io.vertx.core.net.impl back to summary

private final Class VertxEventLoopGroup.EventLoopIterator

Class Inheritance

extends Object
implements Iterator<EventExecutor>

java.lang.Object
io.vertx.core.net.impl.VertxEventLoopGroup.EventLoopIterator

All Implemented Interfaces

java.util.Iterator

Field Summary

Modifier and Type	Field and Description
private final Iterator<VertxEventLoopGroup.EventLoopHolder>	holderIt

Constructor Summary

Access	Constructor and Description
public	EventLoopIterator(Iterator<VertxEventLoopGroup.EventLoopHolder> holderIt)

Method Summary

Modifier and Type	Method and Description
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public EventExecutor	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
public void	remove() Overrides default java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation).

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

holderIt	back to summary
private final Iterator<VertxEventLoopGroup.EventLoopHolder> holderIt

Constructor Detail

EventLoopIterator	back to summary
public EventLoopIterator(Iterator<VertxEventLoopGroup.EventLoopHolder> holderIt)

Method Detail

hasNext back to summary

hasNext	back to summary
public boolean hasNext() Implements java.util.Iterator.hasNext. Doc from java.util.Iterator.hasNext. Returns `true` if the iteration has more elements. (In other words, returns `true` if `next` would return an element rather than throwing an exception.) Returns:boolean `true` if the iteration has more elements Annotations @Override

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean

true if the iteration has more elements

Annotations

@Override

next	back to summary
public EventExecutor next() Implements java.util.Iterator.next. Doc from java.util.Iterator.next. Returns the next element in the iteration. Returns:EventExecutor the next element in the iteration Annotations @Override

back to summary

public EventExecutor next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:EventExecutor

the next element in the iteration

Annotations

@Override

remove back to summary

remove	back to summary
public void remove() Overrides default java.util.Iterator.remove. Doc from java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to `next`. The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy. The behavior of an iterator is unspecified if this method is called after a call to the `forEachRemaining` method. Annotations @Override

public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

Annotations

@Override

public final Class VertxEventLoopGroup

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class VertxEventLoopGroup.EventLoopHolder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class VertxEventLoopGroup.EventLoopIterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail