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.write;
21  
22  import java.util.Collection;
23  
24  import org.apache.mina.core.session.IoSessionConfig;
25  
26  
27  /**
28   * An exception which is thrown when write buffer is not flushed for
29   * {@link IoSessionConfig#getWriteTimeout()} seconds.
30   *
31   * @author <a href="http://mina.apache.org">Apache MINA Project</a>
32   */
33  public class WriteTimeoutException extends WriteException {
34      private static final long serialVersionUID = 3906931157944579121L;
35  
36      /**
37       * Create a new WriteTimeoutException instance
38       * 
39       * @param requests The {@link WriteRequest}s for which we have had a timeout
40       * @param message The error message
41       * @param cause The original exception
42       */
43      public WriteTimeoutException(Collection<WriteRequest> requests, String message, Throwable cause) {
44          super(requests, message, cause);
45      }
46  
47      /**
48       * Create a new WriteTimeoutException instance
49       * 
50       * @param requests The {@link WriteRequest}s for which we have had a timeout
51       * @param message The error message
52       */
53      public WriteTimeoutException(Collection<WriteRequest> requests, String message) {
54          super(requests, message);
55      }
56  
57      /**
58       * Create a new WriteTimeoutException instance
59       * 
60       * @param requests The {@link WriteRequest}s for which we have had a timeout
61       * @param cause The original exception
62       */
63      public WriteTimeoutException(Collection<WriteRequest> requests, Throwable cause) {
64          super(requests, cause);
65      }
66  
67      /**
68       * Create a new WriteTimeoutException instance
69       * 
70       * @param requests The {@link WriteRequest}s for which we have had a timeout
71       */
72      public WriteTimeoutException(Collection<WriteRequest> requests) {
73          super(requests);
74      }
75  
76      /**
77       * Create a new WriteTimeoutException instance
78       * 
79       * @param request The {@link WriteRequest} for which we have had a timeout
80       * @param message The error message
81       * @param cause The original exception
82       */
83      public WriteTimeoutException(WriteRequest request, String message, Throwable cause) {
84          super(request, message, cause);
85      }
86  
87      /**
88       * Create a new WriteTimeoutException instance
89       * 
90       * @param request The {@link WriteRequest} for which we have had a timeout
91       * @param message The error message
92       */
93      public WriteTimeoutException(WriteRequest request, String message) {
94          super(request, message);
95      }
96  
97      /**
98       * Create a new WriteTimeoutException instance
99       * 
100      * @param request The {@link WriteRequest} for which we have had a timeout
101      * @param cause The original exception
102      */
103     public WriteTimeoutException(WriteRequest request, Throwable cause) {
104         super(request, cause);
105     }
106 
107     /**
108      * Create a new WriteTimeoutException instance
109      * 
110      * @param request The {@link WriteRequest} for which we have had a timeout
111      */
112     public WriteTimeoutException(WriteRequest request) {
113         super(request);
114     }
115 }