001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 *
019 */
020package org.apache.mina.core.session;
021
022import java.util.Comparator;
023
024import org.apache.mina.core.write.WriteRequest;
025import org.apache.mina.core.write.WriteRequestQueue;
026
027/**
028 * Provides data structures to a newly created session.
029 * 
030 * @author <a href="http://mina.apache.org">Apache MINA Project</a>
031 */
032public interface IoSessionDataStructureFactory {
033    /**
034     * @return an {@link IoSessionAttributeMap} which is going to be associated
035     * with the specified <tt>session</tt>.  Please note that the returned
036     * implementation must be thread-safe.
037     * 
038     * @param session The session for which we want the Attribute Map
039     * @throws Exception If an error occured while retrieving the map
040     */
041    IoSessionAttributeMap getAttributeMap(IoSession session) throws Exception;
042
043    /**
044     * @return an {@link WriteRequest} which is going to be associated with
045     * the specified <tt>session</tt>.  Please note that the returned
046     * implementation must be thread-safe and robust enough to deal
047     * with various messages types (even what you didn't expect at all),
048     * especially when you are going to implement a priority queue which
049     * involves {@link Comparator}.
050     * 
051     * @param session The session for which we want the WriteRequest queue
052     * @throws Exception If an error occured while retrieving the queue
053     */
054    WriteRequestQueue getWriteRequestQueue(IoSession session) throws Exception;
055}