View Javadoc

1   /*
2    *   @(#) $Id: IoSession.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.io;
20  
21  import org.apache.mina.common.ByteBuffer;
22  import org.apache.mina.common.Session;
23  
24  /***
25   * A {@link Session} that represents low-level I/O connection between two
26   * endpoints regardless of underlying transport types.
27   *   
28   * @author Trustin Lee (trustin@apache.org)
29   * @version $Rev: 210062 $, $Date: 2005-07-11 12:52:38 +0900 $
30   * 
31   * @see Session
32   */
33  public interface IoSession extends Session
34  {
35      /***
36       * Returns the event handler for this session.
37       */
38      IoHandler getHandler();
39      
40      /***
41       * Returns the filter chain that only affects this session.
42       */
43      IoFilterChain getFilterChain();
44  
45      /***
46       * Writes the content of the specified <code>buf</code>.
47       * This operation is asynchronous, and you'll get notified by
48       * {@link IoHandler#dataWritten(IoSession, Object)} event.
49       * The specified <code>marker</code> will be passes as a parameter.
50       */
51      void write( ByteBuffer buf, Object marker );
52  }