View Javadoc

1   /***
2    *
3    * Copyright 2004 Hiram Chirino
4    *
5    *  Licensed under the Apache License, Version 2.0 (the "License");
6    *  you may not use this file except in compliance with the License.
7    *  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   *  Unless required by applicable law or agreed to in writing, software
12   *  distributed under the License is distributed on an "AS IS" BASIS,
13   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   *  See the License for the specific language governing permissions and
15   *  limitations under the License.
16   */
17  
18  package org.activeio;
19  
20  import java.io.IOException;
21  
22  
23  /***
24   * SynchChannel objets allow threadd to synchronously block on the <code>read</code>
25   * method to get {@see org.activeio.channel.Packet} objects when they arrive from the peer.
26   * 
27   * @version $Revision$
28   */
29  public interface InputSynchChannel extends Channel {
30      
31  	/***
32  	 * Used to synchonously receive a packet of information going 'up' the channel.
33  	 * This method blocks until a packet is received or the operation experiences timeout.
34  	 * 
35  	 * @param timeout
36  	 * @return the packet recived or null if the timeout occured.
37  	 * @throws IOException
38  	 */
39  	Packet read(long timeout) throws IOException;
40  }