org.xnio.channels.SuspendableAcceptChannel Maven / Gradle / Ivy
Go to download
This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including
all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and
JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up
with different versions on classes on the class path).
/*
* JBoss, Home of Professional Open Source
*
* Copyright 2010 Red Hat, Inc. and/or its affiliates.
*
* Licensed 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 org.xnio.channels;
import java.io.IOException;
import java.io.InterruptedIOException;
import java.util.concurrent.TimeUnit;
import org.xnio.ChannelListener;
import org.xnio.XnioExecutor;
import org.xnio.XnioIoThread;
/**
* A suspendable accept channel. This type of channel is associated with a listener which can suspend and resume
* accepting connections as needed.
*
* @since 3.0
*/
public interface SuspendableAcceptChannel extends CloseableChannel {
/**
* Suspend further read notifications on this channel.
*/
void suspendAccepts();
/**
* Resume reads on this channel. The accept listener will be
* called as soon as there is a connection available to be accepted.
*/
void resumeAccepts();
/**
* Determine whether accepts are resumed.
*
* @return {@code true} if accepts are resumed, {@code false} if accepts are suspended
*/
boolean isAcceptResumed();
/**
* {@link #resumeAccepts()} Resume accepts} on this channel, and force the accept listener to be triggered even if the
* channel isn't actually ready.
*
* @deprecated Users should instead submit {@code Runnable} tasks to the channel thread when this functionality is needed.
*/
@Deprecated
void wakeupAccepts();
/**
* Block until this channel becomes acceptable again. This method may return spuriously
* before the channel becomes acceptable.
*
* @throws InterruptedIOException if the operation is interrupted; the thread's interrupt flag will be set as well
* @throws IOException if an I/O error occurs
*/
void awaitAcceptable() throws IOException;
/**
* Block until this channel becomes acceptable again, or until the timeout expires. This method may return spuriously
* before the channel becomes acceptable or the timeout expires.
*
* @param time the time to wait
* @param timeUnit the time unit
* @throws InterruptedIOException if the operation is interrupted; the thread's interrupt flag will be set as well
* @throws IOException if an I/O error occurs
*/
void awaitAcceptable(long time, TimeUnit timeUnit) throws IOException;
/**
* Get an accept thread for this channel. If more than one is configured, any of them may be returned.
*
* @return the thread
* @deprecated The {@link #getIoThread()} method should be used instead.
*/
@Deprecated
XnioExecutor getAcceptThread();
/**
* Get an accept thread for this channel. If more than one is configured, any of them may be returned.
*
* @return the thread
*/
XnioIoThread getIoThread();
/**
* Get the setter which can be used to change the accept listener for this channel.
*
* @return the setter
*/
ChannelListener.Setter getAcceptSetter();
/** {@inheritDoc} */
ChannelListener.Setter getCloseSetter();
}