Fix types in javadocs
This commit is contained in:
parent
25f96b1644
commit
ada07cb9e0
@ -19,7 +19,7 @@ package io.netty.buffer;
|
|||||||
import io.netty.util.internal.PlatformDependent;
|
import io.netty.util.internal.PlatformDependent;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Skeltal {@link ByteBufAllocator} implementation to extend.
|
* Skeletal {@link ByteBufAllocator} implementation to extend.
|
||||||
*/
|
*/
|
||||||
public abstract class AbstractByteBufAllocator implements ByteBufAllocator {
|
public abstract class AbstractByteBufAllocator implements ByteBufAllocator {
|
||||||
private static final int DEFAULT_INITIAL_CAPACITY = 256;
|
private static final int DEFAULT_INITIAL_CAPACITY = 256;
|
||||||
|
@ -1687,7 +1687,7 @@ public abstract class ByteBuf implements ReferenceCounted, Comparable<ByteBuf> {
|
|||||||
* or {@link #nioBuffers(int, int)} might return a less number of {@link ByteBuffer}s.
|
* or {@link #nioBuffers(int, int)} might return a less number of {@link ByteBuffer}s.
|
||||||
*
|
*
|
||||||
* @return {@code -1} if this buffer has no underlying {@link ByteBuffer}.
|
* @return {@code -1} if this buffer has no underlying {@link ByteBuffer}.
|
||||||
* the number of the underlying {@link ByteBuffer}s if this buffer has at least one undelying
|
* the number of the underlying {@link ByteBuffer}s if this buffer has at least one underlying
|
||||||
* {@link ByteBuffer}. Note that this method does not return {@code 0} to avoid confusion.
|
* {@link ByteBuffer}. Note that this method does not return {@code 0} to avoid confusion.
|
||||||
*
|
*
|
||||||
* @see #nioBuffer()
|
* @see #nioBuffer()
|
||||||
|
@ -102,7 +102,7 @@ public final class Unpooled {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates a new big-endian direct buffer with resaonably small initial capacity, which
|
* Creates a new big-endian direct buffer with reasonably small initial capacity, which
|
||||||
* expands its capacity boundlessly on demand.
|
* expands its capacity boundlessly on demand.
|
||||||
*/
|
*/
|
||||||
public static ByteBuf directBuffer() {
|
public static ByteBuf directBuffer() {
|
||||||
|
@ -162,7 +162,7 @@ public interface Future<V> extends java.util.concurrent.Future<V> {
|
|||||||
/**
|
/**
|
||||||
* {@inheritDoc}
|
* {@inheritDoc}
|
||||||
*
|
*
|
||||||
* If the cancelation was successful it will fail the future with an {@link CancellationException}.
|
* If the cancellation was successful it will fail the future with an {@link CancellationException}.
|
||||||
*/
|
*/
|
||||||
@Override
|
@Override
|
||||||
boolean cancel(boolean mayInterruptIfRunning);
|
boolean cancel(boolean mayInterruptIfRunning);
|
||||||
|
@ -126,7 +126,7 @@ public abstract class MultithreadEventExecutorGroup extends AbstractEventExecuto
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Create a new EventExecutor which will later then accessable via the {@link #next()} method. This method will be
|
* Create a new EventExecutor which will later then accessible via the {@link #next()} method. This method will be
|
||||||
* called for each thread that will serve this {@link MultithreadEventExecutorGroup}.
|
* called for each thread that will serve this {@link MultithreadEventExecutorGroup}.
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
@ -379,7 +379,7 @@ public abstract class SingleThreadEventExecutor extends AbstractEventExecutor {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the ammount of time left until the scheduled task with the closest dead line is executed.
|
* Returns the amount of time left until the scheduled task with the closest dead line is executed.
|
||||||
*/
|
*/
|
||||||
protected long delayNanos(long currentTimeNanos) {
|
protected long delayNanos(long currentTimeNanos) {
|
||||||
ScheduledFutureTask<?> delayedTask = delayedTaskQueue.peek();
|
ScheduledFutureTask<?> delayedTask = delayedTaskQueue.peek();
|
||||||
|
@ -615,7 +615,7 @@ public abstract class AbstractChannel extends DefaultAttributeMap implements Cha
|
|||||||
@Override
|
@Override
|
||||||
public void write(Object msg, ChannelPromise promise) {
|
public void write(Object msg, ChannelPromise promise) {
|
||||||
if (!isActive()) {
|
if (!isActive()) {
|
||||||
// Mark the write request as failure if the channl is inactive.
|
// Mark the write request as failure if the channel is inactive.
|
||||||
if (isOpen()) {
|
if (isOpen()) {
|
||||||
promise.tryFailure(NOT_YET_CONNECTED_EXCEPTION);
|
promise.tryFailure(NOT_YET_CONNECTED_EXCEPTION);
|
||||||
} else {
|
} else {
|
||||||
|
@ -121,13 +121,13 @@ public interface ChannelConfig {
|
|||||||
/**
|
/**
|
||||||
* Returns the maximum number of messages to read per read loop.
|
* Returns the maximum number of messages to read per read loop.
|
||||||
* a {@link ChannelInboundHandler#channelRead(ChannelHandlerContext, Object) channelRead()} event.
|
* a {@link ChannelInboundHandler#channelRead(ChannelHandlerContext, Object) channelRead()} event.
|
||||||
* If this value is greater than 1, an event loop might attempt to read multiple times to procude multiple messages.
|
* If this value is greater than 1, an event loop might attempt to read multiple times to procure multiple messages.
|
||||||
*/
|
*/
|
||||||
int getMaxMessagesPerRead();
|
int getMaxMessagesPerRead();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sets the maximum number of messages to read per read loop.
|
* Sets the maximum number of messages to read per read loop.
|
||||||
* If this value is greater than 1, an event loop might attempt to read multiple times toprocude multiple messages.
|
* If this value is greater than 1, an event loop might attempt to read multiple times to procure multiple messages.
|
||||||
*/
|
*/
|
||||||
ChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead);
|
ChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead);
|
||||||
|
|
||||||
@ -215,7 +215,7 @@ public interface ChannelConfig {
|
|||||||
* Sets the low water mark of the write buffer. Once the number of bytes
|
* Sets the low water mark of the write buffer. Once the number of bytes
|
||||||
* queued in the write buffer exceeded the
|
* queued in the write buffer exceeded the
|
||||||
* {@linkplain #setWriteBufferHighWaterMark(int) high water mark} and then
|
* {@linkplain #setWriteBufferHighWaterMark(int) high water mark} and then
|
||||||
* dropped down below this value, {@link Channel#isWritable()} will start toreturn
|
* dropped down below this value, {@link Channel#isWritable()} will start to return
|
||||||
* {@code true} again.
|
* {@code true} again.
|
||||||
*/
|
*/
|
||||||
ChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark);
|
ChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark);
|
||||||
|
@ -93,7 +93,7 @@ public final class ChannelFlushPromiseNotifier {
|
|||||||
* their pendingDatasize is smaller after the the current writeCounter returned by {@link #writeCounter()}.
|
* their pendingDatasize is smaller after the the current writeCounter returned by {@link #writeCounter()}.
|
||||||
*
|
*
|
||||||
* After a {@link ChannelFuture} was notified it will be removed from this {@link ChannelFlushPromiseNotifier} and
|
* After a {@link ChannelFuture} was notified it will be removed from this {@link ChannelFlushPromiseNotifier} and
|
||||||
* so not receive anymore notificiation.
|
* so not receive anymore notification.
|
||||||
*/
|
*/
|
||||||
public ChannelFlushPromiseNotifier notifyFlushFutures() {
|
public ChannelFlushPromiseNotifier notifyFlushFutures() {
|
||||||
notifyFlushFutures0(null);
|
notifyFlushFutures0(null);
|
||||||
@ -105,7 +105,7 @@ public final class ChannelFlushPromiseNotifier {
|
|||||||
* their pendingDatasize isis smaller then the current writeCounter returned by {@link #writeCounter()}.
|
* their pendingDatasize isis smaller then the current writeCounter returned by {@link #writeCounter()}.
|
||||||
*
|
*
|
||||||
* After a {@link ChannelFuture} was notified it will be removed from this {@link ChannelFlushPromiseNotifier} and
|
* After a {@link ChannelFuture} was notified it will be removed from this {@link ChannelFlushPromiseNotifier} and
|
||||||
* so not receive anymore notificiation.
|
* so not receive anymore notification.
|
||||||
*
|
*
|
||||||
* The rest of the remaining {@link ChannelFuture}s will be failed with the given {@link Throwable}.
|
* The rest of the remaining {@link ChannelFuture}s will be failed with the given {@link Throwable}.
|
||||||
*
|
*
|
||||||
@ -133,7 +133,7 @@ public final class ChannelFlushPromiseNotifier {
|
|||||||
* the given cause1.
|
* the given cause1.
|
||||||
*
|
*
|
||||||
* After a {@link ChannelFuture} was notified it will be removed from this {@link ChannelFlushPromiseNotifier} and
|
* After a {@link ChannelFuture} was notified it will be removed from this {@link ChannelFlushPromiseNotifier} and
|
||||||
* so not receive anymore notificiation.
|
* so not receive anymore notification.
|
||||||
*
|
*
|
||||||
* The rest of the remaining {@link ChannelFuture}s will be failed with the given {@link Throwable}.
|
* The rest of the remaining {@link ChannelFuture}s will be failed with the given {@link Throwable}.
|
||||||
*
|
*
|
||||||
|
@ -133,8 +133,8 @@ public interface ChannelHandlerContext
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* The {@link EventExecutor} that is used to dispatch the events. This can also be used to directly
|
* The {@link EventExecutor} that is used to dispatch the events. This can also be used to directly
|
||||||
* submit tasks that get executed in the event loop. For more informations please refer to the
|
* submit tasks that get executed in the event loop. For more information please refer to the
|
||||||
* {@link EventExecutor} javadocs.
|
* {@link EventExecutor} javadoc.
|
||||||
*/
|
*/
|
||||||
EventExecutor executor();
|
EventExecutor executor();
|
||||||
|
|
||||||
|
@ -56,7 +56,7 @@ public abstract class ChannelInitializer<C extends Channel> extends ChannelInbou
|
|||||||
* will be removed from the {@link ChannelPipeline} of the {@link Channel}.
|
* will be removed from the {@link ChannelPipeline} of the {@link Channel}.
|
||||||
*
|
*
|
||||||
* @param ch the {@link Channel} which was registered.
|
* @param ch the {@link Channel} which was registered.
|
||||||
* @throws Exception is thrown if an error occours. In that case the {@link Channel} will be closed.
|
* @throws Exception is thrown if an error occurs. In that case the {@link Channel} will be closed.
|
||||||
*/
|
*/
|
||||||
protected abstract void initChannel(C ch) throws Exception;
|
protected abstract void initChannel(C ch) throws Exception;
|
||||||
|
|
||||||
|
@ -64,7 +64,7 @@ interface ChannelOutboundInvoker {
|
|||||||
ChannelFuture connect(SocketAddress remoteAddress, SocketAddress localAddress);
|
ChannelFuture connect(SocketAddress remoteAddress, SocketAddress localAddress);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Request to discconect from the remote peer and notify the {@link ChannelFuture} once the operation completes,
|
* Request to disconnect from the remote peer and notify the {@link ChannelFuture} once the operation completes,
|
||||||
* either because the operation was successful or because of an error.
|
* either because the operation was successful or because of an error.
|
||||||
* <p>
|
* <p>
|
||||||
* This will result in having the
|
* This will result in having the
|
||||||
@ -146,7 +146,7 @@ interface ChannelOutboundInvoker {
|
|||||||
ChannelFuture connect(SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise);
|
ChannelFuture connect(SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Request to discconect from the remote peer and notify the {@link ChannelFuture} once the operation completes,
|
* Request to disconnect from the remote peer and notify the {@link ChannelFuture} once the operation completes,
|
||||||
* either because the operation was successful or because of an error.
|
* either because the operation was successful or because of an error.
|
||||||
*
|
*
|
||||||
* The given {@link ChannelPromise} will be notified.
|
* The given {@link ChannelPromise} will be notified.
|
||||||
|
@ -29,7 +29,7 @@ import java.util.NoSuchElementException;
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A list of {@link ChannelHandler}s which handles or intercepts inbound events and outbount operations of a
|
* A list of {@link ChannelHandler}s which handles or intercepts inbound events and outbound operations of a
|
||||||
* {@link Channel}. {@link ChannelPipeline} implements an advanced form of the
|
* {@link Channel}. {@link ChannelPipeline} implements an advanced form of the
|
||||||
* <a href="http://www.oracle.com/technetwork/java/interceptingfilter-142169.html">Intercepting Filter</a> pattern
|
* <a href="http://www.oracle.com/technetwork/java/interceptingfilter-142169.html">Intercepting Filter</a> pattern
|
||||||
* to give a user full control over how an event is handled and how the {@link ChannelHandler}s in a pipeline
|
* to give a user full control over how an event is handled and how the {@link ChannelHandler}s in a pipeline
|
||||||
|
@ -17,7 +17,7 @@ package io.netty.channel;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Special {@link ChannelException} which will be thrown by {@link EventLoop} and {@link EventLoopGroup}
|
* Special {@link ChannelException} which will be thrown by {@link EventLoop} and {@link EventLoopGroup}
|
||||||
* implementations when an error accours.
|
* implementations when an error occurs.
|
||||||
*/
|
*/
|
||||||
public class EventLoopException extends ChannelException {
|
public class EventLoopException extends ChannelException {
|
||||||
|
|
||||||
|
@ -113,7 +113,7 @@ public abstract class SimpleChannelInboundHandler<I> extends ChannelInboundHandl
|
|||||||
* @param ctx the {@link ChannelHandlerContext} which this {@link SimpleChannelInboundHandler}
|
* @param ctx the {@link ChannelHandlerContext} which this {@link SimpleChannelInboundHandler}
|
||||||
* belongs to
|
* belongs to
|
||||||
* @param msg the message to handle
|
* @param msg the message to handle
|
||||||
* @throws Exception is thrown if an error accour
|
* @throws Exception is thrown if an error occurred
|
||||||
*/
|
*/
|
||||||
protected abstract void channelRead0(ChannelHandlerContext ctx, I msg) throws Exception;
|
protected abstract void channelRead0(ChannelHandlerContext ctx, I msg) throws Exception;
|
||||||
}
|
}
|
||||||
|
@ -187,7 +187,7 @@ public abstract class AbstractOioByteChannel extends AbstractOioChannel {
|
|||||||
* @param buf the {@link ByteBuf} into which the read bytes will be written
|
* @param buf the {@link ByteBuf} into which the read bytes will be written
|
||||||
* @return amount the number of bytes read. This may return a negative amount if the underlying
|
* @return amount the number of bytes read. This may return a negative amount if the underlying
|
||||||
* Socket was closed
|
* Socket was closed
|
||||||
* @throws Exception is thrown if an error accoured
|
* @throws Exception is thrown if an error occurred
|
||||||
*/
|
*/
|
||||||
protected abstract int doReadBytes(ByteBuf buf) throws Exception;
|
protected abstract int doReadBytes(ByteBuf buf) throws Exception;
|
||||||
|
|
||||||
@ -195,7 +195,7 @@ public abstract class AbstractOioByteChannel extends AbstractOioChannel {
|
|||||||
* Write the data which is hold by the {@link ByteBuf} to the underlying Socket.
|
* Write the data which is hold by the {@link ByteBuf} to the underlying Socket.
|
||||||
*
|
*
|
||||||
* @param buf the {@link ByteBuf} which holds the data to transfer
|
* @param buf the {@link ByteBuf} which holds the data to transfer
|
||||||
* @throws Exception is thrown if an error accoured
|
* @throws Exception is thrown if an error occurred
|
||||||
*/
|
*/
|
||||||
protected abstract void doWriteBytes(ByteBuf buf) throws Exception;
|
protected abstract void doWriteBytes(ByteBuf buf) throws Exception;
|
||||||
|
|
||||||
@ -203,7 +203,7 @@ public abstract class AbstractOioByteChannel extends AbstractOioChannel {
|
|||||||
* Write the data which is hold by the {@link FileRegion} to the underlying Socket.
|
* Write the data which is hold by the {@link FileRegion} to the underlying Socket.
|
||||||
*
|
*
|
||||||
* @param region the {@link FileRegion} which holds the data to transfer
|
* @param region the {@link FileRegion} which holds the data to transfer
|
||||||
* @throws Exception is thrown if an error accoured
|
* @throws Exception is thrown if an error occurred
|
||||||
*/
|
*/
|
||||||
protected abstract void doWriteFileRegion(FileRegion region) throws Exception;
|
protected abstract void doWriteFileRegion(FileRegion region) throws Exception;
|
||||||
}
|
}
|
||||||
|
Loading…
x
Reference in New Issue
Block a user