com.pdd.pop.ext.glassfish.grizzly.asyncqueue.AsyncQueue Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2008-2015 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.pdd.pop.ext.glassfish.grizzly.asyncqueue;
import com.pdd.pop.ext.glassfish.grizzly.Connection;
import com.pdd.pop.ext.glassfish.grizzly.Context;
import com.pdd.pop.ext.glassfish.grizzly.ProcessorResult;
/**
* Common interface for {@link AsyncQueue} processors.
*
* @author Alexey Stashok
*/
public interface AsyncQueue {
String EXPECTING_MORE_OPTION =
AsyncQueue.class.getName() + ".expectingMore";
enum AsyncResult {
COMPLETE(ProcessorResult.createLeave()),
INCOMPLETE(ProcessorResult.createComplete()),
EXPECTING_MORE(ProcessorResult.createComplete(EXPECTING_MORE_OPTION)),
TERMINATE(ProcessorResult.createTerminate());
private final ProcessorResult result;
AsyncResult(final ProcessorResult result) {
this.result = result;
}
public ProcessorResult toProcessorResult() {
return result;
}
}
/**
* Checks whether there is ready data in {@link AsyncQueue},
* associated with the {@link Connection}.
*
* @param connection {@link Connection}
* @return true, if there is ready data,
* or false otherwise.
*/
boolean isReady(Connection connection);
/**
* Callback method, which is called async. to process ready
* {@link AsyncQueue}, which are associated with the given
* {@link Connection}
*
* @param context {@link Context}
* @return {@link AsyncResult}, depending on async queue status.
*/
AsyncResult processAsync(Context context);
/**
* Callback method, which is called, when {@link Connection} has been closed,
* to let processor release a connection associated resources.
*
* @param connection {@link Connection}
*/
void onClose(Connection connection);
/**
* Close AsyncQueueProcessor and release associated resources
*/
void close();
}