WaitByte


1   /**
2    * Dream
3    * Copyright (C) 2003-2004 INRIA Rhone-Alpes
4    *
5    * This library is free software; you can redistribute it and/or
6    * modify it under the terms of the GNU Lesser General Public
7    * License as published by the Free Software Foundation; either
8    * version 2 of the License, or (at your option) any later version.
9    *
10   * This library is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13   * Lesser General Public License for more details.
14   *
15   * You should have received a copy of the GNU Lesser General Public
16   * License along with this library; if not, write to the Free Software
17   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18   *
19   * Contact: dream@objectweb.org
20   *
21   * Initial developer(s): Matthieu Leclercq
22   * Contributor(s): 
23   */
24  
25  package org.objectweb.dream.channel;
26  
27  import java.io.IOException  ;
28  
29  /**
30   * Interface provided by component that can be used to wait for a byte over a
31   * socket. Such component can be used to wait for an acknowledgment or for a
32   * message request.
33   */
34  public interface WaitByte
35  {
36    /** The default name for interface of this type. */
37    String   ITF_NAME = "wait-byte";
38  
39    /**
40     * Wait until a byte can be read on the given input.
41     * 
42     * @param input an input.
43     * @return the byte read.
44     * @throws IOException If an I/O error occurs
45     * @see java.io.InputStream#read()
46     */
47    int waitByte(Object   input) throws IOException  ;
48  }

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags