View Javadoc

1   /*
2    *   @(#) $Id: ProtocolSession.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 org.apache.mina.common.Session;
22  
23  /***
24   * A {@link Session} which represents high-level protocol connection between two
25   * endpoints regardless of underlying transport types.
26   * 
27   * @author Trustin Lee (trustin@apache.org)
28   * @version $Rev: 210062 $, $Date: 2005-07-11 12:52:38 +0900 $
29   * 
30   * @see Session
31   */
32  public interface ProtocolSession extends Session
33  {
34      /***
35       * Returns the {@link ProtocolHandler} which handles this session.
36       */
37      ProtocolHandler getHandler();
38  
39      /***
40       * Returns the filter chain that only affects this session.
41       */
42      ProtocolFilterChain getFilterChain();
43  
44  
45      /***
46       * Returns the {@link ProtocolEncoder} for this session.
47       */
48      ProtocolEncoder getEncoder();
49  
50      /***
51       * Returns the {@link ProtocolDecoder} for this session.
52       */
53      ProtocolDecoder getDecoder();
54  
55      /***
56       * Writes the specified <code>message</code> to remote peer.  This operation
57       * is asynchronous; {@link ProtocolHandler#messageSent(ProtocolSession, Object)}
58       * will be invoked when the message is actually sent to remote peer.
59       */
60      void write( Object message );
61  }