← Back to branch summary

~ubuntu-branches/ubuntu/karmic/gears/karmic

« back to all changes in this revision

Viewing changes to gears/localserver/safari/progress_input_stream.h

  • Committer: Bazaar Package Importer
  • Author(s): Stefan Lesicnik
  • Date: 2009-04-30 19:15:25 UTC
  • Revision ID: james.westby@ubuntu.com-20090430191525-0790sb5wzg8ou0xb
Tags: upstream-0.5.21.0~svn3334+dfsg
Import upstream version 0.5.21.0~svn3334+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
gears/localserver/safari/progress_input_stream.h
 
1
// Copyright 2008, Google Inc.
 
2
//
 
3
// Redistribution and use in source and binary forms, with or without 
 
4
// modification, are permitted provided that the following conditions are met:
 
5
//
 
6
//  1. Redistributions of source code must retain the above copyright notice, 
 
7
//     this list of conditions and the following disclaimer.
 
8
//  2. Redistributions in binary form must reproduce the above copyright notice,
 
9
//     this list of conditions and the following disclaimer in the documentation
 
10
//     and/or other materials provided with the distribution.
 
11
//  3. Neither the name of Google Inc. nor the names of its contributors may be
 
12
//     used to endorse or promote products derived from this software without
 
13
//     specific prior written permission.
 
14
//
 
15
// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
 
16
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
 
17
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
 
18
// EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
 
19
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 
20
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 
21
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 
22
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 
 
23
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 
 
24
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
25
 
 
26
#ifndef GEARS_LOCALSERVER_SAFARI_PROGRESS_INPUT_STREAM_H__
 
27
#define GEARS_LOCALSERVER_SAFARI_PROGRESS_INPUT_STREAM_H__
 
28
 
 
29
#import <Foundation/NSStream.h>
 
30
#import "gears/base/common/basictypes.h"
 
31
 
 
32
class SFHttpRequest;
 
33
 
 
34
// ProgressInputStream is a wrapper around an NSInputStream that provides
 
35
// notification to the native HttpRequest object as the stream is read.
 
36
//
 
37
// This class should only be created by a SFHttpRequest, and that SFHttpRequest
 
38
// should call OnSFHttpRequestDetached whenever the SFHttpRequest no longer
 
39
// points to this ProgressInputStream (e.g. during SFHttpRequest's destructor).
 
40
// This constraint is in order to let the two objects point to each other
 
41
// without causing a reference cycle that prohibits deleting them after use.
 
42
@interface ProgressInputStream: NSInputStream {
 
43
 @private
 
44
  SFHttpRequest *request_;
 
45
  NSInputStream *input_stream_;
 
46
  int64 position_;
 
47
  int64 total_;
 
48
}
 
49
 
 
50
#pragma mark Public instance methods
 
51
 
 
52
// Initializes a ProgressInputStream.  |total| is the total number of bytes
 
53
// contained within |input_stream|.
 
54
- (id)initFromStream:(NSInputStream *)input_stream
 
55
             request:(SFHttpRequest *)request
 
56
               total:(int64)total;
 
57
 
 
58
- (void)onSFHttpRequestDetached:(SFHttpRequest *)request;
 
59
 
 
60
@end
 
61
#endif  // GEARS_LOCALSERVER_SAFARI_PROGRESS_INPUT_STREAM_H__