View Javadoc

1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  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,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License.
18   *
19   */
20  package org.apache.mina.common;
21  
22  import java.util.Comparator;
23  
24  /**
25   * Provides data structures to a newly created session.
26   * 
27   * @author The Apache MINA Project (dev@mina.apache.org)
28   * @version $Rev: 592697 $, $Date: 2007-11-07 04:01:58 -0700 (Wed, 07 Nov 2007) $
29   */
30  public interface IoSessionDataStructureFactory {
31      /**
32       * Returns an {@link IoSessionAttributeMap} which is going to be associated
33       * with the specified <tt>session</tt>.  Please note that the returned
34       * implementation must be thread-safe.
35       */
36      IoSessionAttributeMap getAttributeMap(IoSession session) throws Exception;
37      
38      /**
39       * Returns an {@link WriteRequest} which is going to be associated with
40       * the specified <tt>session</tt>.  Please note that the returned
41       * implementation must be thread-safe and robust enough to deal
42       * with various messages types (even what you didn't expect at all),
43       * especially when you are going to implement a priority queue which
44       * involves {@link Comparator}.
45       */
46      WriteRequestQueue getWriteRequestQueue(IoSession session) throws Exception;
47  }