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 /**
55 * InputStream with a configurable timeout.
56 */
57 public class TimeoutInputStream extends FilterInputStream {
58 private final InterruptTimer myTimer;
59
60 private int timeout;
61
62 /**
63 * Wrap an input stream with a timeout on all read operations.
64 *
65 * @param src
66 * base input stream (to read from). The stream must be
67 * interruptible (most socket streams are).
68 * @param timer
69 * timer to manage the timeouts during reads.
70 */
71 public TimeoutInputStream(final InputStream src,
72 final InterruptTimer timer) {
73 super(src);
74 myTimer = timer;
75 }
76
77 /**
78 * Get number of milliseconds before aborting a read.
79 *
80 * @return number of milliseconds before aborting a read.
81 */
82 public int getTimeout() {
83 return timeout;
84 }
85
86 /**
87 * Set number of milliseconds before aborting a read.
88 *
89 * @param millis
90 * number of milliseconds before aborting a read. Must be > 0.
91 */
92 public void setTimeout(int millis) {
93 if (millis < 0)
94 throw new IllegalArgumentException(MessageFormat.format(
95 JGitText.get().invalidTimeout, Integer.valueOf(millis)));
96 timeout = millis;
97 }
98
99 /** {@inheritDoc} */
100 @Override
101 public int read() throws IOException {
102 try {
103 beginRead();
104 return super.read();
105 } catch (InterruptedIOException e) {
106 throw readTimedOut();
107 } finally {
108 endRead();
109 }
110 }
111
112 /** {@inheritDoc} */
113 @Override
114 public int read(byte[] buf) throws IOException {
115 return read(buf, 0, buf.length);
116 }
117
118 /** {@inheritDoc} */
119 @Override
120 public int read(byte[] buf, int off, int cnt) throws IOException {
121 try {
122 beginRead();
123 return super.read(buf, off, cnt);
124 } catch (InterruptedIOException e) {
125 throw readTimedOut();
126 } finally {
127 endRead();
128 }
129 }
130
131 /** {@inheritDoc} */
132 @Override
133 public long skip(long cnt) throws IOException {
134 try {
135 beginRead();
136 return super.skip(cnt);
137 } catch (InterruptedIOException e) {
138 throw readTimedOut();
139 } finally {
140 endRead();
141 }
142 }
143
144 private void beginRead() {
145 myTimer.begin(timeout);
146 }
147
148 private void endRead() {
149 myTimer.end();
150 }
151
152 private InterruptedIOException readTimedOut() {
153 return new InterruptedIOException(MessageFormat.format(
154 JGitText.get().readTimedOut, Integer.valueOf(timeout)));
155 }
156 }