← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/monodevelop/oneiric

« back to all changes in this revision

Viewing changes to contrib/NGit/NGit.Util.IO/TimeoutInputStream.cs

  • Committer: Bazaar Package Importer
  • Author(s): Jo Shields
  • Date: 2011-06-27 17:03:13 UTC
  • mto: (1.8.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 54.
  • Revision ID: james.westby@ubuntu.com-20110627170313-6cvz3s19x6e9hqe9
Import upstream version 2.5.92+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
contrib/NGit/NGit.Util.IO/TimeoutInputStream.cs
 
1
/*
 
2
This code is derived from jgit (http://eclipse.org/jgit).
 
3
Copyright owners are documented in jgit'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
using System;
 
45
using System.Threading;
 
46
using NGit;
 
47
using NGit.Util.IO;
 
48
using Sharpen;
 
49
 
 
50
namespace NGit.Util.IO
 
51
{
 
52
        /// <summary>InputStream with a configurable timeout.</summary>
 
53
        /// <remarks>InputStream with a configurable timeout.</remarks>
 
54
        public class TimeoutInputStream : FilterInputStream
 
55
        {
 
56
                private readonly InterruptTimer myTimer;
 
57
 
 
58
                private int timeout;
 
59
 
 
60
                /// <summary>Wrap an input stream with a timeout on all read operations.</summary>
 
61
                /// <remarks>Wrap an input stream with a timeout on all read operations.</remarks>
 
62
                /// <param name="src">
 
63
                /// base input stream (to read from). The stream must be
 
64
                /// interruptible (most socket streams are).
 
65
                /// </param>
 
66
                /// <param name="timer">timer to manage the timeouts during reads.</param>
 
67
                public TimeoutInputStream(InputStream src, InterruptTimer timer) : base(src)
 
68
                {
 
69
                        myTimer = timer;
 
70
                }
 
71
 
 
72
                /// <returns>number of milliseconds before aborting a read.</returns>
 
73
                public virtual int GetTimeout()
 
74
                {
 
75
                        return timeout;
 
76
                }
 
77
 
 
78
                /// <param name="millis">number of milliseconds before aborting a read. Must be &gt; 0.
 
79
                ///     </param>
 
80
                public virtual void SetTimeout(int millis)
 
81
                {
 
82
                        if (millis < 0)
 
83
                        {
 
84
                                throw new ArgumentException(MessageFormat.Format(JGitText.Get().invalidTimeout, millis
 
85
                                        ));
 
86
                        }
 
87
                        timeout = millis;
 
88
                }
 
89
 
 
90
                /// <exception cref="System.IO.IOException"></exception>
 
91
                public override int Read()
 
92
                {
 
93
                        try
 
94
                        {
 
95
                                BeginRead();
 
96
                                return base.Read();
 
97
                        }
 
98
                        catch (ThreadInterruptedException)
 
99
                        {
 
100
                                throw ReadTimedOut();
 
101
                        }
 
102
                        finally
 
103
                        {
 
104
                                EndRead();
 
105
                        }
 
106
                }
 
107
 
 
108
                /// <exception cref="System.IO.IOException"></exception>
 
109
                public override int Read(byte[] buf)
 
110
                {
 
111
                        return Read(buf, 0, buf.Length);
 
112
                }
 
113
 
 
114
                /// <exception cref="System.IO.IOException"></exception>
 
115
                public override int Read(byte[] buf, int off, int cnt)
 
116
                {
 
117
                        try
 
118
                        {
 
119
                                BeginRead();
 
120
                                return base.Read(buf, off, cnt);
 
121
                        }
 
122
                        catch (ThreadInterruptedException)
 
123
                        {
 
124
                                throw ReadTimedOut();
 
125
                        }
 
126
                        finally
 
127
                        {
 
128
                                EndRead();
 
129
                        }
 
130
                }
 
131
 
 
132
                /// <exception cref="System.IO.IOException"></exception>
 
133
                public override long Skip(long cnt)
 
134
                {
 
135
                        try
 
136
                        {
 
137
                                BeginRead();
 
138
                                return base.Skip(cnt);
 
139
                        }
 
140
                        catch (ThreadInterruptedException)
 
141
                        {
 
142
                                throw ReadTimedOut();
 
143
                        }
 
144
                        finally
 
145
                        {
 
146
                                EndRead();
 
147
                        }
 
148
                }
 
149
 
 
150
                private void BeginRead()
 
151
                {
 
152
                        myTimer.Begin(timeout);
 
153
                }
 
154
 
 
155
                private void EndRead()
 
156
                {
 
157
                        myTimer.End();
 
158
                }
 
159
 
 
160
                private static ThreadInterruptedException ReadTimedOut()
 
161
                {
 
162
                        return new ThreadInterruptedException(JGitText.Get().readTimedOut);
 
163
                }
 
164
        }
 
165
}