View Javadoc

1   /*
2    * Copyright  2004-2005 Stefan Reuter
3    *
4    *  Licensed under the Apache License, Version 2.0 (the "License");
5    *  you may not use this file except in compliance with the License.
6    *  You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   *  Unless required by applicable law or agreed to in writing, software
11   *  distributed under the License is distributed on an "AS IS" BASIS,
12   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   *  See the License for the specific language governing permissions and
14   *  limitations under the License.
15   *
16   */
17  package net.sf.asterisk.fastagi;
18  
19  import net.sf.asterisk.fastagi.reply.AGIReply;
20  
21  /***
22   * The AGIReader reads the replies from the network and parses them using a
23   * ReplyBuilder.
24   * 
25   * @author srt
26   * @version $Id: AGIReader.java,v 1.5 2005/03/11 09:37:37 srt Exp $
27   */
28  public interface AGIReader
29  {
30      /***
31       * Reads the initial request data from Asterisk.
32       * 
33       * @return the request read.
34       * @throws AGIException if the request can't be read.
35       */
36      AGIRequest readRequest() throws AGIException;
37  
38      /***
39       * Reads one reply to an AGICommand from Asterisk.
40       * 
41       * @return the reply read.
42       * @throws AGIException if the reply can't be read.
43       */
44      AGIReply readReply() throws AGIException;
45  }