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.manager;
18  
19  import net.sf.asterisk.io.SocketConnectionFacade;
20  
21  /***
22   * The ManagerReader reads events and responses from the asterisk server, parses
23   * them using EventBuilderImpl and ResponseBuilder and dispatches them to the
24   * associated ManagerConnection.<br>
25   * Do not use this interface in your code, it is intended to be used only by the
26   * DefaultManagerConnection.
27   * 
28   * @see net.sf.asterisk.manager.EventBuilder
29   * @see net.sf.asterisk.manager.ResponseBuilder
30   * @see net.sf.asterisk.manager.DefaultManagerConnection
31   * @author srt
32   * @version $Id: ManagerReader.java,v 1.13 2005/10/25 22:49:56 srt Exp $
33   */
34  
35  public interface ManagerReader extends Runnable
36  {
37  
38      /***
39       * Sets the socket to use for reading from the asterisk server.
40       * 
41       * @param socket the socket to use for reading from the asterisk server.
42       */
43      void setSocket(final SocketConnectionFacade socket);
44  
45      /***
46       * Registers a new event type with the underlying EventBuilderImpl.<br>
47       * The eventClass must extend ManagerEvent.
48       * 
49       * @see EventBuilder
50       * @see ManagerEvent
51       * @param event class of the event to register.
52       */
53      void registerEventClass(Class event);
54  
55      void die();
56  
57  }