Source for gnu.inet.http.ResponseBodyReader

   1: /*
   2:  * ResponseBodyReader.java
   3:  * Copyright (C) 2004 The Free Software Foundation
   4:  * 
   5:  * This file is part of GNU inetlib, a library.
   6:  * 
   7:  * GNU inetlib is free software; you can redistribute it and/or modify
   8:  * it under the terms of the GNU General Public License as published by
   9:  * the Free Software Foundation; either version 2 of the License, or
  10:  * (at your option) any later version.
  11:  * 
  12:  * GNU inetlib is distributed in the hope that it will be useful,
  13:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15:  * GNU General Public License for more details.
  16:  * 
  17:  * You should have received a copy of the GNU General Public License
  18:  * along with this library; if not, write to the Free Software
  19:  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20:  * 
  21:  * Linking this library statically or dynamically with other modules is
  22:  * making a combined work based on this library.  Thus, the terms and
  23:  * conditions of the GNU General Public License cover the whole
  24:  * combination.
  25:  *
  26:  * As a special exception, the copyright holders of this library give you
  27:  * permission to link this library with independent modules to produce an
  28:  * executable, regardless of the license terms of these independent
  29:  * modules, and to copy and distribute the resulting executable under
  30:  * terms of your choice, provided that you also meet, for each linked
  31:  * independent module, the terms and conditions of the license of that
  32:  * module.  An independent module is a module which is not derived from
  33:  * or based on this library.  If you modify this library, you may extend
  34:  * this exception to your version of the library, but you are not
  35:  * obliged to do so.  If you do not wish to do so, delete this
  36:  * exception statement from your version.
  37:  */
  38: 
  39: package gnu.inet.http;
  40: 
  41: /**
  42:  * Callback interface for receiving notification of response body content.
  43:  *
  44:  * @author <a href='mailto:dog@gnu.org'>Chris Burdess</a>
  45:  */
  46: public interface ResponseBodyReader
  47: {
  48: 
  49:   /**
  50:    * Indicate whether this reader is interested in the specified response.
  51:    * If it returns false, it will not receive body content notifications for
  52:    * that response.
  53:    */ 
  54:   boolean accept(Request request, Response response);
  55: 
  56:   /**
  57:    * Receive notification of body content.
  58:    * @param buffer the content buffer
  59:    * @param offset the offset within the buffer that content starts
  60:    * @param length the length of the content
  61:    */
  62:   void read(byte[] buffer, int offset, int length);
  63: 
  64:   /**
  65:    * Notifies the reader that the end of the content was reached.
  66:    */
  67:   void close();
  68:   
  69: }