View Javadoc

1   /*
2    *   @(#) $Id: ProtocolProvider.java 210062 2005-07-11 03:52:38Z trustin $
3    *
4    *   Copyright 2004 The Apache Software Foundation
5    *
6    *   Licensed under the Apache License, Version 2.0 (the "License");
7    *   you may not use this file except in compliance with the License.
8    *   You may obtain a copy of the License at
9    *
10   *       http://www.apache.org/licenses/LICENSE-2.0
11   *
12   *   Unless required by applicable law or agreed to in writing, software
13   *   distributed under the License is distributed on an "AS IS" BASIS,
14   *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   *   See the License for the specific language governing permissions and
16   *   limitations under the License.
17   *
18   */
19  package org.apache.mina.protocol;
20  
21  import java.net.SocketAddress;
22  
23  /***
24   * Provides a required information to implement high-level protocols.
25   * It consists of:
26   * <ul>
27   *   <li>{@link ProtocolCodecFactory} - provides {@link ProtocolEncoder} and
28   *       {@link ProtocolDecoder} which translates binary or protocol specific
29   *       data into message object and vice versa.</li>
30   *   <li>{@link ProtocolHandler} - handles high-leve protocol events.</li>
31   * </ul>
32   * <p>
33   * If once you implement {@link ProtocolProvider} for your protocol, you can
34   * connect to or bind on {@link SocketAddress} using {@link ProtocolAcceptor}
35   * and {@link ProtocolConnector}.
36   * <p>
37   * Please refer to
38   * <a href="../../../../../xref-examples/org/apache/mina/examples/reverser/ReverseProtocolProvider.html"><code>ReverserProtocolProvider</code></a>
39   * example. 
40   * 
41   * @author Trustin Lee (trustin@apache.org)
42   * @version $Rev: 210062 $, $Date: 2005-07-11 12:52:38 +0900 $
43   */
44  public interface ProtocolProvider
45  {
46      ProtocolCodecFactory getCodecFactory();
47  
48      ProtocolHandler getHandler();
49  }