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.core.session;
    21
    22  import java.util.Comparator;
    23
    24  import org.apache.mina.core.write.WriteRequest;
    25  import org.apache.mina.core.write.WriteRequestQueue;
    26
    27  /**
    28   * Provides data structures to a newly created session.
    29   *
    30   * @author <a href="http://mina.apache.org">Apache MINA Project</a>
    31   */
    32  public interface IoSessionDataStructureFactory {
    33      /**
    34       * Returns an {@link IoSessionAttributeMap} which is going to be associated
    35       * with the specified <tt>session</tt>.  Please note that the returned
    36       * implementation must be thread-safe.
    37       */
    38      IoSessionAttributeMap getAttributeMap(IoSession session) throws Exception;
    39
    40      /**
    41       * Returns an {@link WriteRequest} which is going to be associated with
    42       * the specified <tt>session</tt>.  Please note that the returned
    43       * implementation must be thread-safe and robust enough to deal
    44       * with various messages types (even what you didn't expect at all),
    45       * especially when you are going to implement a priority queue which
    46       * involves {@link Comparator}.
    47       */
    48      WriteRequestQueue getWriteRequestQueue(IoSession session) throws Exception;
    49  }