org.xnio.netty.transport

Class XnioChannelCloseFuture

java.lang.Object

org.xnio.netty.transport.XnioChannelCloseFuture

All Implemented Interfaces:

io.netty.channel.ChannelFuture, Future<Void>, EventListener, org.xnio.ChannelListener<org.xnio.conduits.ConduitStreamSourceChannel>

Direct Known Subclasses:

XnioChannelPromiseCloseFuture

public class XnioChannelCloseFuture
extends Object
implements io.netty.channel.ChannelFuture, org.xnio.ChannelListener<org.xnio.conduits.ConduitStreamSourceChannel>

ChannelFuture to be provided when shutting down channels, performs as a close listener on the Xnio side.

Author:

Flavia Rainone

Nested Class Summary

Nested classes/interfaces inherited from interface org.xnio.ChannelListener

org.xnio.ChannelListener.Setter<T extends Channel>, org.xnio.ChannelListener.SimpleSetter<T extends Channel>

Constructor Summary

Constructors

Constructor and Description
XnioChannelCloseFuture(org.xnio.netty.transport.AbstractXnioSocketChannel channel)

Method Summary

Modifier and Type	Method and Description
io.netty.channel.ChannelFuture	addListener(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>> listener)
io.netty.channel.ChannelFuture	addListeners(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>>... listeners)
io.netty.channel.ChannelFuture	await()
boolean	await(long timeoutMillis)
boolean	await(long timeout, TimeUnit unit)
io.netty.channel.ChannelFuture	awaitUninterruptibly()
boolean	awaitUninterruptibly(long timeoutMillis)
boolean	awaitUninterruptibly(long timeout, TimeUnit unit)
boolean	cancel(boolean mayInterruptIfRunning)
Throwable	cause()
io.netty.channel.Channel	channel()
Void	get()
Void	get(long timeout, TimeUnit unit)
Void	getNow()
void	handleEvent(org.xnio.conduits.ConduitStreamSourceChannel channel)
boolean	isCancellable()
boolean	isCancelled()
boolean	isDone()
boolean	isSuccess()
boolean	isVoid()
io.netty.channel.ChannelFuture	removeListener(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>> listener)
io.netty.channel.ChannelFuture	removeListeners(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>>... listeners)
void	setError(IOException error)
io.netty.channel.ChannelFuture	sync()
io.netty.channel.ChannelFuture	syncUninterruptibly()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XnioChannelCloseFuture

public XnioChannelCloseFuture(org.xnio.netty.transport.AbstractXnioSocketChannel channel)

Method Detail

setError

public void setError(IOException error)

isSuccess

public boolean isSuccess()

isCancellable

public boolean isCancellable()

cause

public Throwable cause()

await

public boolean await(long timeout,
                     TimeUnit unit)
              throws InterruptedException

Throws:

InterruptedException

await

public boolean await(long timeoutMillis)
              throws InterruptedException

Throws:

InterruptedException

awaitUninterruptibly

public boolean awaitUninterruptibly(long timeout,
                                    TimeUnit unit)

awaitUninterruptibly

public boolean awaitUninterruptibly(long timeoutMillis)

getNow

public Void getNow()

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<Void>

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<Void>

isDone

public boolean isDone()

Specified by:

isDone in interface Future<Void>

get

public Void get()
         throws InterruptedException,
                ExecutionException

Specified by:

get in interface Future<Void>

Throws:

InterruptedException

ExecutionException

get

public Void get(long timeout,
                TimeUnit unit)
         throws InterruptedException,
                ExecutionException,
                TimeoutException

Specified by:

get in interface Future<Void>

Throws:

InterruptedException

ExecutionException

TimeoutException

channel

public io.netty.channel.Channel channel()

Specified by:

channel in interface io.netty.channel.ChannelFuture

addListener

public io.netty.channel.ChannelFuture addListener(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>> listener)

Specified by:

addListener in interface io.netty.channel.ChannelFuture

addListeners

public io.netty.channel.ChannelFuture addListeners(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>>... listeners)

Specified by:

addListeners in interface io.netty.channel.ChannelFuture

removeListener

public io.netty.channel.ChannelFuture removeListener(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>> listener)

Specified by:

removeListener in interface io.netty.channel.ChannelFuture

removeListeners

public io.netty.channel.ChannelFuture removeListeners(io.netty.util.concurrent.GenericFutureListener<? extends io.netty.util.concurrent.Future<? super Void>>... listeners)

Specified by:

removeListeners in interface io.netty.channel.ChannelFuture

sync

public io.netty.channel.ChannelFuture sync()
                                    throws InterruptedException

Specified by:

sync in interface io.netty.channel.ChannelFuture

Throws:

InterruptedException

syncUninterruptibly

public io.netty.channel.ChannelFuture syncUninterruptibly()

Specified by:

syncUninterruptibly in interface io.netty.channel.ChannelFuture

await

public io.netty.channel.ChannelFuture await()
                                     throws InterruptedException

Specified by:

await in interface io.netty.channel.ChannelFuture

Throws:

InterruptedException

awaitUninterruptibly

public io.netty.channel.ChannelFuture awaitUninterruptibly()

Specified by:

awaitUninterruptibly in interface io.netty.channel.ChannelFuture

isVoid

public boolean isVoid()

Specified by:

isVoid in interface io.netty.channel.ChannelFuture

handleEvent

public void handleEvent(org.xnio.conduits.ConduitStreamSourceChannel channel)

Specified by:

handleEvent in interface org.xnio.ChannelListener<org.xnio.conduits.ConduitStreamSourceChannel>