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.write; 21 22 import org.apache.mina.core.session.IoSession; 23 24 25 /** 26 * Stores {@link WriteRequest}s which are queued to an {@link IoSession}. 27 * 28 * @author The Apache MINA Project (dev@mina.apache.org) 29 * @version $Rev: 751504 $, $Date: 2009-03-08 20:24:58 +0100 (Sun, 08 Mar 2009) $ 30 */ 31 public interface WriteRequestQueue { 32 33 /** 34 * Get the first request available in the queue for a session. 35 * @param session The session 36 * @return The first available request, if any. 37 */ 38 WriteRequest poll(IoSession session); 39 40 /** 41 * Add a new WriteRequest to the session write's queue 42 * @param session The session 43 * @param writeRequest The writeRequest to add 44 */ 45 void offer(IoSession session, WriteRequest writeRequest); 46 47 /** 48 * Tells if the WriteRequest queue is empty or not for a session 49 * @param session The session to check 50 * @return <code>true</code> if the writeRequest is empty 51 */ 52 boolean isEmpty(IoSession session); 53 54 /** 55 * Removes all the requests from this session's queue. 56 * @param session The associated session 57 */ 58 void clear(IoSession session); 59 60 /** 61 * Disposes any releases associated with the specified session. 62 * This method is invoked on disconnection. 63 * @param session The associated session 64 */ 65 void dispose(IoSession session); 66 }