217fb0de05
Motivation: There is no way for a ChannelHandler to check if the passed in ChannelPromise for a write(...) call is a VoidChannelPromise. This is a problem as some handlers need to add listeners to the ChannelPromise which is not possible in the case of a VoidChannelPromise. Modification: - Introduce ChannelFuture.isVoid() which will return true if it is not possible to add listeners or wait on the result. - Add ChannelPromise.unvoid() which allows to create a ChannelFuture out of a void ChannelFuture which supports all the operations. Result: It's now easy to write ChannelHandler implementations which also works when a void ChannelPromise is used.
69 lines
2.0 KiB
Java
69 lines
2.0 KiB
Java
/*
|
|
* Copyright 2012 The Netty Project
|
|
*
|
|
* The Netty Project licenses this file to you under the Apache License,
|
|
* version 2.0 (the "License"); you may not use this file except in compliance
|
|
* with the License. You may obtain a copy of the License at:
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
* License for the specific language governing permissions and limitations
|
|
* under the License.
|
|
*/
|
|
package io.netty.channel;
|
|
|
|
import io.netty.util.concurrent.Future;
|
|
import io.netty.util.concurrent.GenericFutureListener;
|
|
import io.netty.util.concurrent.Promise;
|
|
|
|
/**
|
|
* Special {@link ChannelFuture} which is writable.
|
|
*/
|
|
public interface ChannelPromise extends ChannelFuture, Promise<Void> {
|
|
|
|
@Override
|
|
Channel channel();
|
|
|
|
@Override
|
|
ChannelPromise setSuccess(Void result);
|
|
|
|
ChannelPromise setSuccess();
|
|
|
|
boolean trySuccess();
|
|
|
|
@Override
|
|
ChannelPromise setFailure(Throwable cause);
|
|
|
|
@Override
|
|
ChannelPromise addListener(GenericFutureListener<? extends Future<? super Void>> listener);
|
|
|
|
@Override
|
|
ChannelPromise addListeners(GenericFutureListener<? extends Future<? super Void>>... listeners);
|
|
|
|
@Override
|
|
ChannelPromise removeListener(GenericFutureListener<? extends Future<? super Void>> listener);
|
|
|
|
@Override
|
|
ChannelPromise removeListeners(GenericFutureListener<? extends Future<? super Void>>... listeners);
|
|
|
|
@Override
|
|
ChannelPromise sync() throws InterruptedException;
|
|
|
|
@Override
|
|
ChannelPromise syncUninterruptibly();
|
|
|
|
@Override
|
|
ChannelPromise await() throws InterruptedException;
|
|
|
|
@Override
|
|
ChannelPromise awaitUninterruptibly();
|
|
|
|
/**
|
|
* Returns a new {@link ChannelPromise} if {@link #isVoid()} returns {@code true} otherwise itself.
|
|
*/
|
|
ChannelPromise unvoid();
|
|
}
|