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  
23  /**
24   * Stores {@link WriteRequest}s which are queued to an {@link IoSession}.
25   * 
26   * @author The Apache MINA Project (dev@mina.apache.org)
27   * @version $Rev: 592697 $, $Date: 2007-11-07 04:01:58 -0700 (Wed, 07 Nov 2007) $
28   */
29  public interface WriteRequestQueue {
30  
31      WriteRequest poll(IoSession session);
32      void offer(IoSession session, WriteRequest writeRequest);
33      boolean isEmpty(IoSession session);
34      void clear(IoSession session);
35      
36      /**
37       * Disposes any releases associated with the specified session.
38       * This method is invoked on disconnection.
39       */
40      void dispose(IoSession session);
41  }