Coverage Report - com.sun.grizzly.async.AsyncQueueReader
 
Classes in this File Line Coverage Branch Coverage Complexity
AsyncQueueReader
N/A
N/A
1
 
 1  
 /*
 2  
  * 
 3  
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 4  
  * 
 5  
  * Copyright 2007-2008 Sun Microsystems, Inc. All rights reserved.
 6  
  * 
 7  
  * The contents of this file are subject to the terms of either the GNU
 8  
  * General Public License Version 2 only ("GPL") or the Common Development
 9  
  * and Distribution License("CDDL") (collectively, the "License").  You
 10  
  * may not use this file except in compliance with the License. You can obtain
 11  
  * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 12  
  * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 13  
  * language governing permissions and limitations under the License.
 14  
  * 
 15  
  * When distributing the software, include this License Header Notice in each
 16  
  * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 17  
  * Sun designates this particular file as subject to the "Classpath" exception
 18  
  * as provided by Sun in the GPL Version 2 section of the License file that
 19  
  * accompanied this code.  If applicable, add the following below the License
 20  
  * Header, with the fields enclosed by brackets [] replaced by your own
 21  
  * identifying information: "Portions Copyrighted [year]
 22  
  * [name of copyright owner]"
 23  
  * 
 24  
  * Contributor(s):
 25  
  * 
 26  
  * If you wish your version of this file to be governed by only the CDDL or
 27  
  * only the GPL Version 2, indicate your decision by adding "[Contributor]
 28  
  * elects to include this software in this distribution under the [CDDL or GPL
 29  
  * Version 2] license."  If you don't indicate a single choice of license, a
 30  
  * recipient has the option to distribute your version of this file under
 31  
  * either the CDDL, the GPL Version 2 or to extend the choice of license to
 32  
  * its licensees as provided above.  However, if you add GPL Version 2 code
 33  
  * and therefore, elected the GPL Version 2 license, then the option applies
 34  
  * only if the new code is made subject to such option by the copyright
 35  
  * holder.
 36  
  *
 37  
  */
 38  
 
 39  
 package com.sun.grizzly.async;
 40  
 
 41  
 import java.io.IOException;
 42  
 import java.nio.ByteBuffer;
 43  
 import java.nio.channels.SelectableChannel;
 44  
 import java.nio.channels.SelectionKey;
 45  
 
 46  
 /**
 47  
  *
 48  
  * @author Alexey Stashok
 49  
  */
 50  
 public interface AsyncQueueReader {
 51  
     public void read(SelectionKey key, ByteBuffer buffer, 
 52  
             AsyncReadCallbackHandler callbackHandler) throws IOException;
 53  
 
 54  
     public void read(SelectionKey key, ByteBuffer buffer, 
 55  
             AsyncReadCallbackHandler callbackHandler, 
 56  
             AsyncReadCondition condition) throws IOException;
 57  
     
 58  
     public void read(SelectionKey key, ByteBuffer buffer, 
 59  
             AsyncReadCallbackHandler callbackHandler, 
 60  
             AsyncReadCondition condition, 
 61  
             AsyncQueueDataProcessor readPostProcessor) throws IOException;
 62  
 
 63  
     /**
 64  
      * Checks whether {@link AsyncQueueReader} is registered
 65  
      * for the {@link SelectableChannel}, associated with the given 
 66  
      * {@link SelectionKey}
 67  
      * 
 68  
      * @param key {@link SelectionKey} associated with {@link SelectableChannel}
 69  
      * @return true, if there is ready data. False otherwise.
 70  
      */
 71  
     public boolean isAsyncQueueReaderEnabledFor(SelectionKey key);
 72  
     
 73  
     /**
 74  
      * Callback method, which should be called by {@link SelectorHandler} to
 75  
      * notify, that {@link SelectableChannel}, associated with the given
 76  
      * {@link SelectableChannel} has ready data for reading.
 77  
      * 
 78  
      * @param key {@link SelectionKey} associated with {@link SelectableChannel}
 79  
      * @throws <code>java.io.IOException</code>
 80  
      */
 81  
     public void onRead(SelectionKey key) throws IOException;
 82  
     
 83  
     /**
 84  
      * Callback method, which should be called by {@link SelectorHandler} to
 85  
      * notify, that given {@link SelectableChannel} is going to be closed, so
 86  
      * related data could be released from 
 87  
      * {@link AsyncQueueReader}
 88  
      * 
 89  
      * @param {@link SelectableChannel}
 90  
      * @throws java.io.IOException
 91  
      */
 92  
     public void onClose(SelectableChannel channel);
 93  
     
 94  
     /**
 95  
      * Close {@link AsyncQueueReader} and release its resources
 96  
      */
 97  
     public void close();
 98  
     
 99  
 }