Server : Apache/2.4.41 (Ubuntu) System : Linux absol.cf 5.4.0-198-generic #218-Ubuntu SMP Fri Sep 27 20:18:53 UTC 2024 x86_64 User : www-data ( 33) PHP Version : 7.4.33 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, Directory : /usr/include/GNUstep/Foundation/
Upload File :
Current File : //usr/include/GNUstep/Foundation/NSURLRequest.h
/* Interface for NSURLRequest for GNUstep
Copyright (C) 2006 Software Foundation, Inc.
Written by: Richard Frith-Macdonald <frm@gnu.org>
Date: 2006
This file is part of the GNUstep Base 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 __NSURLRequest_h_GNUSTEP_BASE_INCLUDE
#define __NSURLRequest_h_GNUSTEP_BASE_INCLUDE
#import <GNUstepBase/GSVersionMacros.h>
#if OS_API_VERSION(MAC_OS_X_VERSION_10_2,GS_API_LATEST) && GS_API_VERSION( 11300,GS_API_LATEST)
#import <Foundation/NSObject.h>
#if defined(__cplusplus)
extern "C" {
#endif
@class NSData;
@class NSDate;
@class NSDictionary;
@class NSInputStream;
@class NSString;
@class NSURL;
enum {
NSURLRequestUseProtocolCachePolicy = 0,
NSURLRequestReloadIgnoringLocalCacheData = 1,
NSURLRequestReloadIgnoringLocalAndRemoteCacheData = 4,
NSURLRequestReloadIgnoringCacheData = NSURLRequestReloadIgnoringLocalCacheData,
NSURLRequestReturnCacheDataElseLoad = 2,
NSURLRequestReturnCacheDataDontLoad = 3,
NSURLRequestReloadRevalidatingCacheData = 5
};
/**
* <deflist>
* <term>NSURLRequestUseProtocolCachePolicy</term>
* <desc>
* Says that any protocol specific cache policy should be
* used ... this is the default.
* </desc>
* <term>NSURLRequestReloadIgnoringCacheData</term>
* <desc>
* Says the data should be re-loaded from source rather
* than any cached data being used, irrespective of any
* protocol standard.
* </desc>
* <term>NSURLRequestReturnCacheDataElseLoad</term>
* <desc>
* Says to use cached data if any is available, but to
* load from source if the cache is empty. Ignores any
* protocol specific logic (like cache aging).
* </desc>
* <term>NSURLRequestReturnCacheDataDontLoad</term>
* <desc>
* Says to use cached data if any is available, but to
* return nil without loading if the cache is empty.
* </desc>
* </deflist>
*/
typedef NSUInteger NSURLRequestCachePolicy;
/**
* This class encapsulates information about a request to load a
* URL, how to cache the results, and when to deal with a slow/hung
* load process by timing out.
*/
@interface NSURLRequest : NSObject <NSCoding, NSCopying, NSMutableCopying>
{
#if GS_EXPOSE(NSURLRequest)
void *_NSURLRequestInternal;
#endif
}
/*
* Returns an autoreleased instance initialised with the specified URL
* and with the default cache policy (NSURLRequestUseProtocolCachePolicy)
* and a sixty second timeout.
*/
+ (id) requestWithURL: (NSURL *)URL;
/**
* Returns an autoreleased instance initialised with the specified URL,
* cachePolicy, and timeoutInterval.
*/
+ (id) requestWithURL: (NSURL *)URL
cachePolicy: (NSURLRequestCachePolicy)cachePolicy
timeoutInterval: (NSTimeInterval)timeoutInterval;
/**
* Returns the cache policy associated with the receiver.
*/
- (NSURLRequestCachePolicy) cachePolicy;
/**
* Initialises the reveiver with the specified URL
* and with the default cache policy (NSURLRequestUseProtocolCachePolicy)
* and a sixty second timeout.
*/
- (id) initWithURL: (NSURL *)URL;
/**
* Initialises the receiver with the specified URL,
* cachePolicy, and timeoutInterval.
*/
- (id) initWithURL: (NSURL *)URL
cachePolicy: (NSURLRequestCachePolicy)cachePolicy
timeoutInterval: (NSTimeInterval)timeoutInterval;
/**
* Returns the main document URL for the receiver.<br />
* Currently unused.<br />
* This is intended for use with frames and similar situations where
* a main document has a large number of subsidiary documents.
*/
- (NSURL *) mainDocumentURL;
/**
* Returns the timeout interval associated with the receiver.<br />
* This is a value in seconds specifying how long the load process
* may be inactive (waiting for data to arrive from the server)
* before the load is mconsidered to have failed due to a timeout.
*/
- (NSTimeInterval) timeoutInterval;
/**
* Returns the URL associated with the receiver.
*/
- (NSURL *) URL;
@end
/**
*/
@interface NSMutableURLRequest : NSURLRequest
/**
* Sets the receiver's cache policy.
*/
- (void) setCachePolicy: (NSURLRequestCachePolicy)cachePolicy;
/**
* Sets the receiver's main document.
*/
- (void) setMainDocumentURL: (NSURL *)URL;
/**
* Sets the receiver's timeout policy.
*/
- (void) setTimeoutInterval: (NSTimeInterval)seconds;
/**
* Sets the receiver's URL
*/
- (void) setURL: (NSURL *)URL;
@end
/**
* HTTP specific additions to NSURLRequest
*/
@interface NSURLRequest (NSHTTPURLRequest)
/**
* Returns a dictionary of the HTTP header fields associated with the
* receiver.
*/
- (NSDictionary *) allHTTPHeaderFields;
/**
* Returns the body of the reques ... this is the data sent in a POST
* request.
*/
- (NSData *) HTTPBody;
#if OS_API_VERSION(MAC_OS_X_VERSION_10_4,GS_API_LATEST)
/**
* Returns the currently set stream (if any) to be used to provide data
* to send as the request body.<br />
* Of course, any attempt to modify this stream may mess up the load
* operation in progress.
*/
- (NSInputStream *) HTTPBodyStream;
#endif
/**
* Returns the HTTP method assiciated with the receiver.
*/
- (NSString *) HTTPMethod;
/**
* Returns a flag indicating whether this request should use standard
* cookie handling (sending of cookies with the request and storing
* any cookies returned in the response.
*/
- (BOOL) HTTPShouldHandleCookies;
/**
* Returns the value for a particular HTTP header field (by case
* insensitive comparison) or nil if no such header is set.
*/
- (NSString *) valueForHTTPHeaderField: (NSString *)field;
@end
/**
*/
@interface NSMutableURLRequest (NSMutableHTTPURLRequest)
/**
* Appends the value to the specified header field, automatically inserting
* a comman field delimiter if necessary.
*/
- (void) addValue: (NSString *)value forHTTPHeaderField: (NSString *)field;
/**
* Sets all the string values in the supplied headerFields
* dictionary as header values in the receiver.<br />
* Non-string values are ignored.
*/
- (void) setAllHTTPHeaderFields: (NSDictionary *)headerFields;
#if OS_API_VERSION(MAC_OS_X_VERSION_10_4,GS_API_LATEST)
/**
* Sets the request body to be the contents of the given stream.<br />
* The stream should be unopened when it is set, and the load process
* for the request will open the stream and read its entire content
* forwarding it to the remote server.<br />
* Clears any value previously set by -setHTTPBody: or -setHTTPBodyStream:
*/
- (void) setHTTPBodyStream: (NSInputStream *)inputStream;
#endif
/**
* Sets the data to be sent as the body of the HTTP request.<br />
* Clears any value previously set by -setHTTPBodyStream: or -setHTTPBody:
*/
- (void) setHTTPBody: (NSData *)data;
/**
* Sets the method of the receiver.
*/
- (void) setHTTPMethod: (NSString *)method;
/**
* Sets a flag to say whether cookies should automatically be added
* to the request and whether cookies in the response should be used.
*/
- (void) setHTTPShouldHandleCookies: (BOOL)should;
/**
* Sets the value for the sapecified header field, replacing any
* previously set value.
*/
- (void) setValue: (NSString *)value forHTTPHeaderField: (NSString *)field;
@end
#if defined(__cplusplus)
}
#endif
#endif
#endif
Server : Apache/2.4.41 (Ubuntu)