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 */
30 public interface WriteRequestQueue {
31
32 /**
33 * Get the first request available in the queue for a session.
34 * @param session The session
35 * @return The first available request, if any.
36 */
37 WriteRequest poll(IoSession session);
38
39 /**
40 * Add a new WriteRequest to the session write's queue
41 * @param session The session
42 * @param writeRequest The writeRequest to add
43 */
44 void offer(IoSession session, WriteRequest writeRequest);
45
46 /**
47 * Tells if the WriteRequest queue is empty or not for a session
48 * @param session The session to check
49 * @return <code>true</code> if the writeRequest is empty
50 */
51 boolean isEmpty(IoSession session);
52
53 /**
54 * Removes all the requests from this session's queue.
55 * @param session The associated session
56 */
57 void clear(IoSession session);
58
59 /**
60 * Disposes any releases associated with the specified session.
61 * This method is invoked on disconnection.
62 * @param session The associated session
63 */
64 void dispose(IoSession session);
65 }