/usr/include/GNUstep/Foundation/NSURLHandle.h is in libgnustep-base-dev 1.25.1-2ubuntu3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 | /* NSURLHandle.h - Class NSURLHandle
Copyright (C) 1999 Free Software Foundation, Inc.
Written by: Manuel Guesdon <mguesdon@sbuilders.com>
Date: Jan 1999
This file is part of the GNUstep Library.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free
Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02111 USA.
*/
#ifndef __NSURLHandle_h_GNUSTEP_BASE_INCLUDE
#define __NSURLHandle_h_GNUSTEP_BASE_INCLUDE
#import <GNUstepBase/GSVersionMacros.h>
#if OS_API_VERSION(GS_API_MACOSX, GS_API_LATEST)
#import <Foundation/NSObject.h>
#if defined(__cplusplus)
extern "C" {
#endif
@class NSData;
@class NSString;
@class NSMutableArray;
@class NSMutableData;
@class NSURLHandle;
@class NSURL;
/**
* Key for passing to [NSURLHandle]'s <code>propertyForKey..</code> methods to
* obtain status code.
*/
GS_EXPORT NSString * const NSHTTPPropertyStatusCodeKey;
/**
* Key for passing to [NSURLHandle]'s <code>propertyForKey..</code> methods to
* obtain status reason.
*/
GS_EXPORT NSString * const NSHTTPPropertyStatusReasonKey;
/**
* Key for passing to [NSURLHandle]'s <code>propertyForKey..</code> methods to
* obtain HTTP version supported by server.
*/
GS_EXPORT NSString * const NSHTTPPropertyServerHTTPVersionKey;
/**
* Key for passing to [NSURLHandle]'s <code>propertyForKey..</code> methods to
* obtain redirection headers.
*/
GS_EXPORT NSString * const NSHTTPPropertyRedirectionHeadersKey;
/**
* Key for passing to [NSURLHandle]'s <code>propertyForKey..</code> methods to
* obtain error page data.
*/
GS_EXPORT NSString * const NSHTTPPropertyErrorPageDataKey;
#if OS_API_VERSION(GS_API_NONE, GS_API_NONE)
/**
* Key for passing to [NSURLHandle]'s <code>propertyForKey..</code> methods to
* obtain local host.
*/
GS_EXPORT NSString * const GSHTTPPropertyLocalHostKey;
/**
* Key for passing to [NSURLHandle]'s <code>propertyForKey..</code> methods to
* obtain method (GET, POST, etc.).
*/
GS_EXPORT NSString * const GSHTTPPropertyMethodKey;
/**
* Key for passing to [NSURLHandle]'s <code>propertyForKey..</code> methods to
* obtain proxy host.
*/
GS_EXPORT NSString * const GSHTTPPropertyProxyHostKey;
/**
* Key for passing to [NSURLHandle]'s <code>propertyForKey..</code> methods to
* obtain proxy port.
*/
GS_EXPORT NSString * const GSHTTPPropertyProxyPortKey;
/**
* Key for passing to [NSURLHandle]'s <code>propertyForKey..</code> methods to
* specify the location of an SSL certificate file.
*/
GS_EXPORT NSString * const GSHTTPPropertyCertificateFileKey;
/**
* Key for passing to [NSURLHandle]'s <code>propertyForKey..</code> methods to
* specify the location of an SSL key file.
*/
GS_EXPORT NSString * const GSHTTPPropertyKeyFileKey;
/**
* Key for passing to [NSURLHandle]'s <code>propertyForKey..</code> methods to
* specify the password for an SSL key file.
*/
GS_EXPORT NSString * const GSHTTPPropertyPasswordKey;
#endif
/**
* Enumerated type returned by [NSURLHandle-status]:
<example>
{
NSURLHandleNotLoaded
NSURLHandleLoadSucceeded,
NSURLHandleLoadInProgress,
NSURLHandleLoadFailed
}
</example>
*/
enum
{
NSURLHandleNotLoaded = 0,
NSURLHandleLoadSucceeded,
NSURLHandleLoadInProgress,
NSURLHandleLoadFailed
};
typedef NSUInteger NSURLHandleStatus;
/**
* A protocol to which clients of a handle must conform in order to
* receive notification of events on the handle.
*/
@protocol NSURLHandleClient
/**
* Sent by the NSURLHandle object when some data becomes available
* from the handle. Note that this does not mean that all data has become
* available, only that a chunk of data has arrived.
*/
- (void) URLHandle: (NSURLHandle*)sender
resourceDataDidBecomeAvailable: (NSData*)newData;
/**
* Sent by the NSURLHandle object on resource load failure.
* Supplies a human readable failure reason.
*/
- (void) URLHandle: (NSURLHandle*)sender
resourceDidFailLoadingWithReason: (NSString*)reason;
/**
* Sent by the NSURLHandle object when it begins loading
* resource data.
*/
- (void) URLHandleResourceDidBeginLoading: (NSURLHandle*)sender;
/**
* Sent by the NSURLHandle object when resource loading is cancelled
* by programmatic request (rather than by failure).
*/
- (void) URLHandleResourceDidCancelLoading: (NSURLHandle*)sender;
/**
* Sent by the NSURLHandle object when it completes loading
* resource data.
*/
- (void) URLHandleResourceDidFinishLoading: (NSURLHandle*)sender;
@end
@interface NSURLHandle : NSObject
{
#if GS_EXPOSE(NSURLHandle)
@protected
id _data;
NSMutableArray *_clients;
NSString *_failure;
NSURLHandleStatus _status;
#endif
}
+ (NSURLHandle*) cachedHandleForURL: (NSURL*)url;
+ (BOOL) canInitWithURL: (NSURL*)url;
+ (void) registerURLHandleClass: (Class)urlHandleSubclass;
+ (Class) URLHandleClassForURL: (NSURL*)url;
- (void) addClient: (id <NSURLHandleClient>)client;
- (NSData*) availableResourceData;
- (void) backgroundLoadDidFailWithReason: (NSString*)reason;
- (void) beginLoadInBackground;
- (void) cancelLoadInBackground;
- (void) didLoadBytes: (NSData*)newData
loadComplete: (BOOL)loadComplete;
- (void) endLoadInBackground;
- (NSString*) failureReason;
- (void) flushCachedData;
- (id) initWithURL: (NSURL*)url
cached: (BOOL)cached;
- (void) loadInBackground;
- (NSData*) loadInForeground;
- (id) propertyForKey: (NSString*)propertyKey;
- (id) propertyForKeyIfAvailable: (NSString*)propertyKey;
- (void) removeClient: (id <NSURLHandleClient>)client;
- (NSData*) resourceData;
- (NSURLHandleStatus) status;
- (BOOL) writeData: (NSData*)data;
- (BOOL) writeProperty: (id)propertyValue
forKey: (NSString*)propertyKey;
@end
#if defined(__cplusplus)
}
#endif
#endif
#endif /* __NSURLHandle_h_GNUSTEP_BASE_INCLUDE */
|