1 /*
2 * Copyright (C) 2009, 2013 Google Inc.
3 * and other copyright owners as documented in the project's IP log.
4 *
5 * This program and the accompanying materials are made available
6 * under the terms of the Eclipse Distribution License v1.0 which
7 * accompanies this distribution, is reproduced below, and is
8 * available at http://www.eclipse.org/org/documents/edl-v10.php
9 *
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
14 * conditions are met:
15 *
16 * - Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials provided
22 * with the distribution.
23 *
24 * - Neither the name of the Eclipse Foundation, Inc. nor the
25 * names of its contributors may be used to endorse or promote
26 * products derived from this software without specific prior
27 * written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43
44 package org.eclipse.jgit.util.io;
45
46 import java.io.FilterInputStream;
47 import java.io.IOException;
48 import java.io.InputStream;
49 import java.io.InterruptedIOException;
50 import java.text.MessageFormat;
51
52 import org.eclipse.jgit.internal.JGitText;
53
54 /** InputStream with a configurable timeout. */
55 public class TimeoutInputStream extends FilterInputStream {
56 private final InterruptTimer myTimer;
57
58 private int timeout;
59
60 /**
61 * Wrap an input stream with a timeout on all read operations.
62 *
63 * @param src
64 * base input stream (to read from). The stream must be
65 * interruptible (most socket streams are).
66 * @param timer
67 * timer to manage the timeouts during reads.
68 */
69 public TimeoutInputStream(final InputStream src,
70 final InterruptTimer timer) {
71 super(src);
72 myTimer = timer;
73 }
74
75 /** @return number of milliseconds before aborting a read. */
76 public int getTimeout() {
77 return timeout;
78 }
79
80 /**
81 * @param millis
82 * number of milliseconds before aborting a read. Must be > 0.
83 */
84 public void setTimeout(final int millis) {
85 if (millis < 0)
86 throw new IllegalArgumentException(MessageFormat.format(
87 JGitText.get().invalidTimeout, Integer.valueOf(millis)));
88 timeout = millis;
89 }
90
91 @Override
92 public int read() throws IOException {
93 try {
94 beginRead();
95 return super.read();
96 } catch (InterruptedIOException e) {
97 throw readTimedOut();
98 } finally {
99 endRead();
100 }
101 }
102
103 @Override
104 public int read(byte[] buf) throws IOException {
105 return read(buf, 0, buf.length);
106 }
107
108 @Override
109 public int read(byte[] buf, int off, int cnt) throws IOException {
110 try {
111 beginRead();
112 return super.read(buf, off, cnt);
113 } catch (InterruptedIOException e) {
114 throw readTimedOut();
115 } finally {
116 endRead();
117 }
118 }
119
120 @Override
121 public long skip(long cnt) throws IOException {
122 try {
123 beginRead();
124 return super.skip(cnt);
125 } catch (InterruptedIOException e) {
126 throw readTimedOut();
127 } finally {
128 endRead();
129 }
130 }
131
132 private void beginRead() {
133 myTimer.begin(timeout);
134 }
135
136 private void endRead() {
137 myTimer.end();
138 }
139
140 private InterruptedIOException readTimedOut() {
141 return new InterruptedIOException(MessageFormat.format(
142 JGitText.get().readTimedOut, Integer.valueOf(timeout)));
143 }
144 }