| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023 |
- {
- File: CFNetwork/CFHTTPMessage.h
-
- Contains: CoreFoundation Network socket streams header
-
- Copyright: Copyright (c) 2001-2008, Apple Inc. All rights reserved.
-
- Bugs?: For bug reports, consult the following page on
- the World Wide Web:
-
- http://bugs.freepascal.org
-
- }
- { Pascal Translation: Peter N Lewis, <[email protected]>, 2004 }
- { Pascal Translation Updated: Gale R Paeper, <[email protected]>, 2008 }
- { Pascal Translation Updated: Jonas Maebe, <[email protected]>, October 2009 }
- { Pascal Translation Updated: Jonas Maebe, <[email protected]>, October 2012 }
- { Pascal Translation Updated: Jonas Maebe <[email protected]>, August 2015 }
- {
- Modified for use with Free Pascal
- Version 308
- Please report any bugs to <[email protected]>
- }
- {$ifc not defined MACOSALLINCLUDE or not MACOSALLINCLUDE}
- {$mode macpas}
- {$modeswitch cblocks}
- {$packenum 1}
- {$macro on}
- {$inline on}
- {$calling mwpascal}
- unit CFHTTPMessage;
- interface
- {$setc UNIVERSAL_INTERFACES_VERSION := $0400}
- {$setc GAP_INTERFACES_VERSION := $0308}
- {$ifc not defined USE_CFSTR_CONSTANT_MACROS}
- {$setc USE_CFSTR_CONSTANT_MACROS := TRUE}
- {$endc}
- {$ifc defined CPUPOWERPC and defined CPUI386}
- {$error Conflicting initial definitions for CPUPOWERPC and CPUI386}
- {$endc}
- {$ifc defined FPC_BIG_ENDIAN and defined FPC_LITTLE_ENDIAN}
- {$error Conflicting initial definitions for FPC_BIG_ENDIAN and FPC_LITTLE_ENDIAN}
- {$endc}
- {$ifc not defined __ppc__ and defined CPUPOWERPC32}
- {$setc __ppc__ := 1}
- {$elsec}
- {$setc __ppc__ := 0}
- {$endc}
- {$ifc not defined __ppc64__ and defined CPUPOWERPC64}
- {$setc __ppc64__ := 1}
- {$elsec}
- {$setc __ppc64__ := 0}
- {$endc}
- {$ifc not defined __i386__ and defined CPUI386}
- {$setc __i386__ := 1}
- {$elsec}
- {$setc __i386__ := 0}
- {$endc}
- {$ifc not defined __x86_64__ and defined CPUX86_64}
- {$setc __x86_64__ := 1}
- {$elsec}
- {$setc __x86_64__ := 0}
- {$endc}
- {$ifc not defined __arm__ and defined CPUARM}
- {$setc __arm__ := 1}
- {$elsec}
- {$setc __arm__ := 0}
- {$endc}
- {$ifc not defined __arm64__ and defined CPUAARCH64}
- {$setc __arm64__ := 1}
- {$elsec}
- {$setc __arm64__ := 0}
- {$endc}
- {$ifc defined cpu64}
- {$setc __LP64__ := 1}
- {$elsec}
- {$setc __LP64__ := 0}
- {$endc}
- {$ifc defined __ppc__ and __ppc__ and defined __i386__ and __i386__}
- {$error Conflicting definitions for __ppc__ and __i386__}
- {$endc}
- {$ifc defined __ppc__ and __ppc__}
- {$setc TARGET_CPU_PPC := TRUE}
- {$setc TARGET_CPU_PPC64 := FALSE}
- {$setc TARGET_CPU_X86 := FALSE}
- {$setc TARGET_CPU_X86_64 := FALSE}
- {$setc TARGET_CPU_ARM := FALSE}
- {$setc TARGET_CPU_ARM64 := FALSE}
- {$setc TARGET_OS_MAC := TRUE}
- {$setc TARGET_OS_IPHONE := FALSE}
- {$setc TARGET_IPHONE_SIMULATOR := FALSE}
- {$setc TARGET_OS_EMBEDDED := FALSE}
- {$elifc defined __ppc64__ and __ppc64__}
- {$setc TARGET_CPU_PPC := FALSE}
- {$setc TARGET_CPU_PPC64 := TRUE}
- {$setc TARGET_CPU_X86 := FALSE}
- {$setc TARGET_CPU_X86_64 := FALSE}
- {$setc TARGET_CPU_ARM := FALSE}
- {$setc TARGET_CPU_ARM64 := FALSE}
- {$setc TARGET_OS_MAC := TRUE}
- {$setc TARGET_OS_IPHONE := FALSE}
- {$setc TARGET_IPHONE_SIMULATOR := FALSE}
- {$setc TARGET_OS_EMBEDDED := FALSE}
- {$elifc defined __i386__ and __i386__}
- {$setc TARGET_CPU_PPC := FALSE}
- {$setc TARGET_CPU_PPC64 := FALSE}
- {$setc TARGET_CPU_X86 := TRUE}
- {$setc TARGET_CPU_X86_64 := FALSE}
- {$setc TARGET_CPU_ARM := FALSE}
- {$setc TARGET_CPU_ARM64 := FALSE}
- {$ifc defined(iphonesim)}
- {$setc TARGET_OS_MAC := FALSE}
- {$setc TARGET_OS_IPHONE := TRUE}
- {$setc TARGET_IPHONE_SIMULATOR := TRUE}
- {$elsec}
- {$setc TARGET_OS_MAC := TRUE}
- {$setc TARGET_OS_IPHONE := FALSE}
- {$setc TARGET_IPHONE_SIMULATOR := FALSE}
- {$endc}
- {$setc TARGET_OS_EMBEDDED := FALSE}
- {$elifc defined __x86_64__ and __x86_64__}
- {$setc TARGET_CPU_PPC := FALSE}
- {$setc TARGET_CPU_PPC64 := FALSE}
- {$setc TARGET_CPU_X86 := FALSE}
- {$setc TARGET_CPU_X86_64 := TRUE}
- {$setc TARGET_CPU_ARM := FALSE}
- {$setc TARGET_CPU_ARM64 := FALSE}
- {$ifc defined(iphonesim)}
- {$setc TARGET_OS_MAC := FALSE}
- {$setc TARGET_OS_IPHONE := TRUE}
- {$setc TARGET_IPHONE_SIMULATOR := TRUE}
- {$elsec}
- {$setc TARGET_OS_MAC := TRUE}
- {$setc TARGET_OS_IPHONE := FALSE}
- {$setc TARGET_IPHONE_SIMULATOR := FALSE}
- {$endc}
- {$setc TARGET_OS_EMBEDDED := FALSE}
- {$elifc defined __arm__ and __arm__}
- {$setc TARGET_CPU_PPC := FALSE}
- {$setc TARGET_CPU_PPC64 := FALSE}
- {$setc TARGET_CPU_X86 := FALSE}
- {$setc TARGET_CPU_X86_64 := FALSE}
- {$setc TARGET_CPU_ARM := TRUE}
- {$setc TARGET_CPU_ARM64 := FALSE}
- { will require compiler define when/if other Apple devices with ARM cpus ship }
- {$setc TARGET_OS_MAC := FALSE}
- {$setc TARGET_OS_IPHONE := TRUE}
- {$setc TARGET_IPHONE_SIMULATOR := FALSE}
- {$setc TARGET_OS_EMBEDDED := TRUE}
- {$elifc defined __arm64__ and __arm64__}
- {$setc TARGET_CPU_PPC := FALSE}
- {$setc TARGET_CPU_PPC64 := FALSE}
- {$setc TARGET_CPU_X86 := FALSE}
- {$setc TARGET_CPU_X86_64 := FALSE}
- {$setc TARGET_CPU_ARM := FALSE}
- {$setc TARGET_CPU_ARM64 := TRUE}
- { will require compiler define when/if other Apple devices with ARM cpus ship }
- {$setc TARGET_OS_MAC := FALSE}
- {$setc TARGET_OS_IPHONE := TRUE}
- {$setc TARGET_IPHONE_SIMULATOR := FALSE}
- {$setc TARGET_OS_EMBEDDED := TRUE}
- {$elsec}
- {$error __ppc__ nor __ppc64__ nor __i386__ nor __x86_64__ nor __arm__ nor __arm64__ is defined.}
- {$endc}
- {$ifc defined __LP64__ and __LP64__ }
- {$setc TARGET_CPU_64 := TRUE}
- {$elsec}
- {$setc TARGET_CPU_64 := FALSE}
- {$endc}
- {$ifc defined FPC_BIG_ENDIAN}
- {$setc TARGET_RT_BIG_ENDIAN := TRUE}
- {$setc TARGET_RT_LITTLE_ENDIAN := FALSE}
- {$elifc defined FPC_LITTLE_ENDIAN}
- {$setc TARGET_RT_BIG_ENDIAN := FALSE}
- {$setc TARGET_RT_LITTLE_ENDIAN := TRUE}
- {$elsec}
- {$error Neither FPC_BIG_ENDIAN nor FPC_LITTLE_ENDIAN are defined.}
- {$endc}
- {$setc ACCESSOR_CALLS_ARE_FUNCTIONS := TRUE}
- {$setc CALL_NOT_IN_CARBON := FALSE}
- {$setc OLDROUTINENAMES := FALSE}
- {$setc OPAQUE_TOOLBOX_STRUCTS := TRUE}
- {$setc OPAQUE_UPP_TYPES := TRUE}
- {$setc OTCARBONAPPLICATION := TRUE}
- {$setc OTKERNEL := FALSE}
- {$setc PM_USE_SESSION_APIS := TRUE}
- {$setc TARGET_API_MAC_CARBON := TRUE}
- {$setc TARGET_API_MAC_OS8 := FALSE}
- {$setc TARGET_API_MAC_OSX := TRUE}
- {$setc TARGET_CARBON := TRUE}
- {$setc TARGET_CPU_68K := FALSE}
- {$setc TARGET_CPU_MIPS := FALSE}
- {$setc TARGET_CPU_SPARC := FALSE}
- {$setc TARGET_OS_UNIX := FALSE}
- {$setc TARGET_OS_WIN32 := FALSE}
- {$setc TARGET_RT_MAC_68881 := FALSE}
- {$setc TARGET_RT_MAC_CFM := FALSE}
- {$setc TARGET_RT_MAC_MACHO := TRUE}
- {$setc TYPED_FUNCTION_POINTERS := TRUE}
- {$setc TYPE_BOOL := FALSE}
- {$setc TYPE_EXTENDED := FALSE}
- {$setc TYPE_LONGLONG := TRUE}
- uses MacTypes,CFString,CFURL,CFBase,CFData,CFDictionary;
- {$endc} {not MACOSALLINCLUDE}
- {$ALIGN POWER}
- {
- * kCFHTTPVersion1_0
- *
- * Discussion:
- * Version string for HTTP 1.0.
- *
- * Availability:
- * Mac OS X: in version 10.1 and later in CoreServices.framework
- * CarbonLib: not available
- * Non-Carbon CFM: not available
- }
- var kCFHTTPVersion1_0: CFStringRef; external name '_kCFHTTPVersion1_0'; (* attribute const *)
- (* __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_2_0) *)
- {
- * kCFHTTPVersion1_1
- *
- * Discussion:
- * Version string for HTTP 1.1.
- *
- * Availability:
- * Mac OS X: in version 10.1 and later in CoreServices.framework
- * CarbonLib: not available
- * Non-Carbon CFM: not available
- }
- var kCFHTTPVersion1_1: CFStringRef; external name '_kCFHTTPVersion1_1'; (* attribute const *)
- (* __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_2_0) *)
- {
- * kCFHTTPAuthenticationSchemeBasic
- *
- * Discussion:
- * HTTP Basic authentication scheme.
- *
- * Availability:
- * Mac OS X: in version 10.2 and later in CoreServices.framework
- * CarbonLib: not available
- * Non-Carbon CFM: not available
- }
- var kCFHTTPAuthenticationSchemeBasic: CFStringRef; external name '_kCFHTTPAuthenticationSchemeBasic'; (* attribute const *)
- (* __OSX_AVAILABLE_STARTING(__MAC_10_2,__IPHONE_2_0) *)
- {
- * kCFHTTPAuthenticationSchemeDigest
- *
- * Discussion:
- * HTTP Digest Access authentication scheme.
- *
- * Availability:
- * Mac OS X: in version 10.2 and later in CoreServices.framework
- * CarbonLib: not available
- * Non-Carbon CFM: not available
- }
- var kCFHTTPAuthenticationSchemeDigest: CFStringRef; external name '_kCFHTTPAuthenticationSchemeDigest'; (* attribute const *)
- (* __OSX_AVAILABLE_STARTING(__MAC_10_2,__IPHONE_2_0) *)
- {
- * kCFHTTPAuthenticationSchemeNTLM
- *
- * Discussion:
- * HTTP NTLM authentication scheme.
- *
- * Availability:
- * Mac OS X: in version 10.5 and later in CoreServices.framework
- * CarbonLib: not available
- * Non-Carbon CFM: not available
- }
- var kCFHTTPAuthenticationSchemeNTLM: CFStringRef; external name '_kCFHTTPAuthenticationSchemeNTLM'; (* attribute const *)
- (* __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0) *)
- {
- * kCFHTTPAuthenticationSchemeNegotiate
- *
- * Discussion:
- * HTTP Negotiate authentication scheme.
- *
- * Availability:
- * Mac OS X: in version 10.5 and later in CoreServices.framework
- * CarbonLib: not available
- * Non-Carbon CFM: not available
- }
- var kCFHTTPAuthenticationSchemeNegotiate: CFStringRef; external name '_kCFHTTPAuthenticationSchemeNegotiate'; (* attribute const *)
- (* __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0) *)
-
- {
- * kCFHTTPAuthenticationSchemeNegotiate2
- *
- * Discussion:
- * HTTP Negotiate v2 authentication scheme.
- *
- * Availability:
- * Mac OS X: in version 10.6 and later in CoreServices.framework
- * CarbonLib: not available
- * Non-Carbon CFM: not available
- }
- var kCFHTTPAuthenticationSchemeNegotiate2: CFStringRef; external name '_kCFHTTPAuthenticationSchemeNegotiate2'; (* attribute const *)
- (* __OSX_AVAILABLE_STARTING(__MAC_10_6,__IPHONE_3_0) *)
-
- {
- * kCFHTTPAuthenticationSchemeXMobileMeAuthToken
- *
- * Discussion:
- * HTTP XMobileMeAuthToken authentication scheme.
- *
- * Availability:
- * Mac OS X: in version 10.6 and later in CoreServices.framework
- * CarbonLib: not available
- * Non-Carbon CFM: not available
- }
- var kCFHTTPAuthenticationSchemeXMobileMeAuthToken: CFStringRef; external name '_kCFHTTPAuthenticationSchemeXMobileMeAuthToken'; (* attribute const *)
- (* __OSX_AVAILABLE_STARTING(__MAC_10_6,__IPHONE_4_3) *)
-
- {
- * kCFHTTPAuthenticationSchemeKerberos
- *
- * Discussion:
- * HTTP Negotiate authentication scheme.
- *
- * Availability:
- * Mac OS X: in version 10.7 and later in CoreServices.framework
- * CarbonLib: not available
- * Non-Carbon CFM: not available
- }
- var kCFHTTPAuthenticationSchemeKerberos: CFStringRef; external name '_kCFHTTPAuthenticationSchemeKerberos'; (* attribute const *)
- (* __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_2_0) *)
- {$ifc TARGET_OS_MAC}
- {
- * kCFHTTPAuthenticationSchemeOAuth1
- *
- * Discussion:
- * HTTP OAuth 1.0 authentication scheme.
- *
- * Availability:
- * Mac OS X: in version 10.9 and later in CoreServices.framework
- * CarbonLib: not available
- * Non-Carbon CFM: not available
- }
- var kCFHTTPAuthenticationSchemeOAuth1: CFStringRef; external name '_kCFHTTPAuthenticationSchemeOAuth1'; (* attribute const *)
- (* __OSX_AVAILABLE_STARTING(__MAC_10_9,__IPHONE_NA) *)
- {$endc}
-
- {
- * CFHTTPMessageRef
- *
- * Discussion:
- * This is the type of a reference to an HTTP message. An HTTP
- * message can be a request or a response.
- }
- type
- CFHTTPMessageRef = ^__CFHTTPMessage; { an opaque type }
- __CFHTTPMessage = record end;
- {
- * CFHTTPMessageGetTypeID()
- *
- * Discussion:
- * Return the unique type for this class.
- *
- * Mac OS X threading:
- * Thread safe
- *
- * Result:
- * A unique CFType for CFHTTPMessage.
- *
- * Availability:
- * Mac OS X: in version 10.1 and later in CoreServices.framework
- * CarbonLib: not available
- * Non-Carbon CFM: not available
- }
- function CFHTTPMessageGetTypeID: CFTypeID; external name '_CFHTTPMessageGetTypeID';
- (* __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_2_0) *)
- {
- * CFHTTPMessageCreateRequest()
- *
- * Discussion:
- * Create an HTTPMessage from an HTTP method, url and version.
- *
- * Mac OS X threading:
- * Thread safe
- *
- * Parameters:
- *
- * alloc:
- * A pointer to the CFAllocator which should be used to allocate
- * memory for the CF read stream and its storage for values. If
- * this reference is not a valid CFAllocator, the behavior is
- * undefined.
- *
- * requestMethod:
- * A pointer to a CFString indicating the method of request. For a
- * "GET" request, for example, the value would be CFSTR("GET").
- *
- * url:
- * A pointer to a CFURL structure created any of the several
- * CFURLCreate... functions. If this parameter is not a pointer
- * to a valid CFURL structure, the behavior is undefined.
- *
- * httpVersion:
- * A pointer to a CFString indicating the version of request.
- *
- * Result:
- * A pointer to the CFHTTPMessage created, or NULL if failed. It is
- * caller's responsibilty to release the memory allocated for the
- * message.
- *
- * Availability:
- * Mac OS X: in version 10.1 and later in CoreServices.framework
- * CarbonLib: not available
- * Non-Carbon CFM: not available
- }
- function CFHTTPMessageCreateRequest( alloc: CFAllocatorRef; requestMethod: CFStringRef; url: CFURLRef; httpVersion: CFStringRef ): CFHTTPMessageRef; external name '_CFHTTPMessageCreateRequest';
- (* __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_2_0) *)
- {
- * CFHTTPMessageCreateResponse()
- *
- * Discussion:
- * Create an HTTPMessage from an HTTP status code, description and
- * version.
- *
- * Mac OS X threading:
- * Thread safe
- *
- * Parameters:
- *
- * alloc:
- * A pointer to the CFAllocator which should be used to allocate
- * memory for the CF read stream and its storage for values. If
- * this reference is not a valid CFAllocator, the behavior is
- * undefined.
- *
- * statusCode:
- * An integer status code for the response.
- *
- * statusDescription:
- * A pointer to a CFString for the status. Pass NULL to use the
- * standard description for the given status code, as found in RFC
- * 2616.
- *
- * httpVersion:
- * A pointer to a CFString for the HTTP version.
- *
- * Result:
- * A pointer to the CFHTTPMessage created, or NULL if failed. It is
- * caller's responsibilty to release the memory allocated for the
- * message.
- *
- * Availability:
- * Mac OS X: in version 10.1 and later in CoreServices.framework
- * CarbonLib: not available
- * Non-Carbon CFM: not available
- }
- function CFHTTPMessageCreateResponse( alloc: CFAllocatorRef; statusCode: CFIndex; statusDescription: CFStringRef; httpVersion: CFStringRef ): CFHTTPMessageRef; external name '_CFHTTPMessageCreateResponse';
- (* __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_2_0) *)
- {
- * CFHTTPMessageCreateEmpty()
- *
- * Discussion:
- * Creates an empty request or response, which you can then append
- * bytes to via CFHTTPMessageAppendBytes().
- *
- * Mac OS X threading:
- * Thread safe
- *
- * Parameters:
- *
- * alloc:
- * A pointer to the CFAllocator which should be used to allocate
- * memory for the CF read stream and its storage for values. If
- * this reference is not a valid CFAllocator, the behavior is
- * undefined.
- *
- * isRequest:
- * A boolean. Pass kCFBooleanTrue if the message should be a
- * request.
- *
- * Result:
- * A pointer to the CFHTTPMessage created, or NULL if failed. It is
- * caller's responsibilty to release the memory allocated for the
- * message.
- *
- * Availability:
- * Mac OS X: in version 10.1 and later in CoreServices.framework
- * CarbonLib: not available
- * Non-Carbon CFM: not available
- }
- function CFHTTPMessageCreateEmpty( alloc: CFAllocatorRef; isRequest: Boolean ): CFHTTPMessageRef; external name '_CFHTTPMessageCreateEmpty';
- (* __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_2_0) *)
- {
- * CFHTTPMessageCreateCopy()
- *
- * Discussion:
- * Creates a copy of a CFHTTPMessage.
- *
- * Mac OS X threading:
- * Not thread safe
- *
- * Parameters:
- *
- * alloc:
- * A pointer to the CFAllocator which should be used to allocate
- * memory for the CF read stream and its storage for values. If
- * this reference is not a valid CFAllocator, the behavior is
- * undefined.
- *
- * message:
- * A pointer to the CFHTTPMessage to be copied. If the message is
- * NULL, the behavior is undefined.
- *
- * Result:
- * A pointer to the CFHTTPMessage created, or NULL if failed. It is
- * caller's responsibilty to release the memory allocated for the
- * message.
- *
- * Availability:
- * Mac OS X: in version 10.1 and later in CoreServices.framework
- * CarbonLib: not available
- * Non-Carbon CFM: not available
- }
- function CFHTTPMessageCreateCopy( alloc: CFAllocatorRef; message: CFHTTPMessageRef ): CFHTTPMessageRef; external name '_CFHTTPMessageCreateCopy';
- (* __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_2_0) *)
- {
- * CFHTTPMessageIsRequest()
- *
- * Discussion:
- * Returns whether the CFHTTPMessage is a request or a response.
- *
- * Mac OS X threading:
- * Not thread safe
- *
- * Parameters:
- *
- * message:
- * A pointer to the CFHTTPMessage to be copied. If the message is
- * NULL, the behavior is undefined.
- *
- * Result:
- * A Boolean. A value of kCFBooleanTrue indicates the message is a
- * request. A value of kCFBooleanFalse indicates the message is a
- * response.
- *
- * Availability:
- * Mac OS X: in version 10.1 and later in CoreServices.framework
- * CarbonLib: not available
- * Non-Carbon CFM: not available
- }
- function CFHTTPMessageIsRequest( message: CFHTTPMessageRef ): Boolean; external name '_CFHTTPMessageIsRequest';
- (* __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_2_0) *)
- {
- * CFHTTPMessageCopyVersion()
- *
- * Discussion:
- * Returns the HTTP version.
- *
- * Mac OS X threading:
- * Not thread safe
- *
- * Parameters:
- *
- * message:
- * A pointer to the CFHTTPMessage to be copied. If the message is
- * NULL, the behavior is undefined.
- *
- * Result:
- * A pointer to a CFString, or NULL if failed. It is caller's
- * responsibilty to release the memory allocated for the string.
- *
- * Availability:
- * Mac OS X: in version 10.1 and later in CoreServices.framework
- * CarbonLib: not available
- * Non-Carbon CFM: not available
- }
- function CFHTTPMessageCopyVersion( message: CFHTTPMessageRef ): CFStringRef; external name '_CFHTTPMessageCopyVersion';
- (* __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_2_0) *)
- {
- * CFHTTPMessageCopyBody()
- *
- * Discussion:
- * Returns the body of the message.
- *
- * Mac OS X threading:
- * Not thread safe
- *
- * Parameters:
- *
- * message:
- * A pointer to the CFHTTPMessage to be copied. If the message is
- * NULL, the behavior is undefined.
- *
- * Result:
- * A pointer to a CFData, or NULL if failed. It is caller's
- * responsibilty to release the memory allocated for the data.
- *
- * Availability:
- * Mac OS X: in version 10.1 and later in CoreServices.framework
- * CarbonLib: not available
- * Non-Carbon CFM: not available
- }
- function CFHTTPMessageCopyBody( message: CFHTTPMessageRef ): CFDataRef; external name '_CFHTTPMessageCopyBody';
- (* __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_2_0) *)
- {
- * CFHTTPMessageSetBody()
- *
- * Discussion:
- * Sets the body of the message from a CFData.
- *
- * Mac OS X threading:
- * Not thread safe
- *
- * Parameters:
- *
- * message:
- * A pointer to the CFHTTPMessage to be copied. If the message is
- * NULL, the behavior is undefined.
- *
- * bodyData:
- * A pointer to a CFData containing the body to be set. If the
- * bodyData is NULL, the behavior is undefined.
- *
- * Availability:
- * Mac OS X: in version 10.1 and later in CoreServices.framework
- * CarbonLib: not available
- * Non-Carbon CFM: not available
- }
- procedure CFHTTPMessageSetBody( message: CFHTTPMessageRef; bodyData: CFDataRef ); external name '_CFHTTPMessageSetBody';
- (* __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_2_0) *)
- {
- * CFHTTPMessageCopyHeaderFieldValue()
- *
- * Discussion:
- * Returns the specified header field.
- *
- * Mac OS X threading:
- * Not thread safe
- *
- * Parameters:
- *
- * message:
- * A pointer to the CFHTTPMessage to be copied. If the message is
- * NULL, the behavior is undefined.
- *
- * headerField:
- * A pointer to the CFString. If the headerField is NULL, the
- * behavior is undefined.
- *
- * Result:
- * A pointer to a CFString, or NULL if failed. It is caller's
- * responsibilty to release the memory allocated for the string.
- *
- * Availability:
- * Mac OS X: in version 10.1 and later in CoreServices.framework
- * CarbonLib: not available
- * Non-Carbon CFM: not available
- }
- function CFHTTPMessageCopyHeaderFieldValue( message: CFHTTPMessageRef; headerField: CFStringRef ): CFStringRef; external name '_CFHTTPMessageCopyHeaderFieldValue';
- (* __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_2_0) *)
- {
- * CFHTTPMessageCopyAllHeaderFields()
- *
- * Discussion:
- * Returns a CFDictionary containing all of the header fields.
- *
- * Mac OS X threading:
- * Not thread safe
- *
- * Parameters:
- *
- * message:
- * A pointer to the CFHTTPMessage to be copied. If the message is
- * NULL, the behavior is undefined.
- *
- * Result:
- * A pointer to a CFDictionary, or NULL if failed. It is caller's
- * responsibilty to release the memory allocated for the dictionary.
- *
- * Availability:
- * Mac OS X: in version 10.1 and later in CoreServices.framework
- * CarbonLib: not available
- * Non-Carbon CFM: not available
- }
- function CFHTTPMessageCopyAllHeaderFields( message: CFHTTPMessageRef ): CFDictionaryRef; external name '_CFHTTPMessageCopyAllHeaderFields';
- (* __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_2_0) *)
- {
- * CFHTTPMessageSetHeaderFieldValue()
- *
- * Discussion:
- * Sets the value of the specified header field.
- *
- * Mac OS X threading:
- * Not thread safe
- *
- * Parameters:
- *
- * message:
- * A pointer to the CFHTTPMessage to be copied. If the message is
- * NULL, the behavior is undefined.
- *
- * headerField:
- * A pointer to the CFString. If headerField is NULL, the behavior
- * is undefined.
- *
- * value:
- * A pointer to the CFString containing the value to set. Set the
- * value to NULL to remove the header field.
- *
- * Availability:
- * Mac OS X: in version 10.1 and later in CoreServices.framework
- * CarbonLib: not available
- * Non-Carbon CFM: not available
- }
- procedure CFHTTPMessageSetHeaderFieldValue( message: CFHTTPMessageRef; headerField: CFStringRef; value: CFStringRef ); external name '_CFHTTPMessageSetHeaderFieldValue';
- (* __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_2_0) *)
- {
- * CFHTTPMessageAppendBytes()
- *
- * Discussion:
- * Appends the given bytes to the message given (parsing out any
- * control information if appropriate). Returns kCFBooleanFalse if
- * a parsing error occurs while processing the new data.
- *
- * Mac OS X threading:
- * Not thread safe
- *
- * Parameters:
- *
- * message:
- * A pointer to the CFHTTPMessage to be copied. If the message is
- * NULL, the behavior is undefined.
- *
- * newBytes:
- * A pointer to the bytes. If newBytes is NULL, the behavior is
- * undefined.
- *
- * numBytes:
- * A CFIndex of the number of bytes to append.
- *
- * Result:
- * A Boolean indicating success or failure.
- *
- * Availability:
- * Mac OS X: in version 10.1 and later in CoreServices.framework
- * CarbonLib: not available
- * Non-Carbon CFM: not available
- }
- function CFHTTPMessageAppendBytes( message: CFHTTPMessageRef; newBytes: UnivPtr; numBytes: CFIndex ): Boolean; external name '_CFHTTPMessageAppendBytes';
- (* __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_2_0) *)
- {
- * CFHTTPMessageIsHeaderComplete()
- *
- * Discussion:
- * Returns whether further header data is expected by the message.
- *
- * Mac OS X threading:
- * Not thread safe
- *
- * Parameters:
- *
- * message:
- * A pointer to the CFHTTPMessage to be copied. If the message is
- * NULL, the behavior is undefined.
- *
- * Result:
- * A Boolean. A value of kCFBooleanTrue indicates the header is
- * complete and no further data is expected.
- *
- * Availability:
- * Mac OS X: in version 10.1 and later in CoreServices.framework
- * CarbonLib: not available
- * Non-Carbon CFM: not available
- }
- function CFHTTPMessageIsHeaderComplete( message: CFHTTPMessageRef ): Boolean; external name '_CFHTTPMessageIsHeaderComplete';
- (* __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_2_0) *)
- {
- * CFHTTPMessageCopySerializedMessage()
- *
- * Discussion:
- * Creates a self-contained copy of a CFHTTPMessage. This would be
- * suitable for persistant storage or for transmitting over the
- * network independently.
- *
- * Mac OS X threading:
- * Not thread safe
- *
- * Parameters:
- *
- * request:
- * A pointer to the CFHTTPMessage to be seralized.
- *
- * Result:
- * A pointer to a CFData, or NULL if failed. It is caller's
- * responsibilty to release the memory allocated for the data.
- *
- * Availability:
- * Mac OS X: in version 10.1 and later in CoreServices.framework
- * CarbonLib: not available
- * Non-Carbon CFM: not available
- }
- function CFHTTPMessageCopySerializedMessage( request: CFHTTPMessageRef ): CFDataRef; external name '_CFHTTPMessageCopySerializedMessage';
- (* __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_2_0) *)
- {*******************}
- { Request functions }
- {*******************}
- {
- * CFHTTPMessageCopyRequestURL()
- *
- * Discussion:
- * Creates a copy of the request URL.
- *
- * Mac OS X threading:
- * Not thread safe
- *
- * Parameters:
- *
- * request:
- * A pointer to the CFHTTPMessage.
- *
- * Result:
- * A pointer to a CFURL, or NULL if failed. It is caller's
- * responsibilty to release the memory allocated for the url.
- *
- * Availability:
- * Mac OS X: in version 10.1 and later in CoreServices.framework
- * CarbonLib: not available
- * Non-Carbon CFM: not available
- }
- function CFHTTPMessageCopyRequestURL( request: CFHTTPMessageRef ): CFURLRef; external name '_CFHTTPMessageCopyRequestURL';
- (* __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_2_0) *)
- {
- * CFHTTPMessageCopyRequestMethod()
- *
- * Discussion:
- * Creates a copy of the request method.
- *
- * Mac OS X threading:
- * Not thread safe
- *
- * Parameters:
- *
- * request:
- * A pointer to the CFHTTPMessage.
- *
- * Result:
- * A pointer to a CFString, or NULL if failed. It is caller's
- * responsibilty to release the memory allocated for the string.
- *
- * Availability:
- * Mac OS X: in version 10.1 and later in CoreServices.framework
- * CarbonLib: not available
- * Non-Carbon CFM: not available
- }
- function CFHTTPMessageCopyRequestMethod( request: CFHTTPMessageRef ): CFStringRef; external name '_CFHTTPMessageCopyRequestMethod';
- (* __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_2_0) *)
- {
- * CFHTTPMessageAddAuthentication()
- *
- * Discussion:
- * Adds authentication to the request. Tries to modify request to
- * contain the authentication information requested by the failed
- * response (which presumably is a 401 or 407 response).
- *
- * Mac OS X threading:
- * Not thread safe
- *
- * Parameters:
- *
- * request:
- * A pointer to a CFHTTPMessage request.
- *
- * authenticationFailureResponse:
- * A pointer to a CFHTTPMessage of the failed response.
- *
- * username:
- * A pointer to a CFString containing the user name to
- * authenticate.
- *
- * password:
- * A pointer to a CFString containing the password of the user.
- *
- * authenticationScheme:
- * A pointer to a CFString containing the authentication scheme to
- * use to authenticate. If authenticationScheme is NULL, strongest
- * supported scheme listed authenticationFailureResponse will be
- * used.
- *
- * forProxy:
- * A boolean indicating whether the authentication applies to a
- * proxy or not.
- *
- * Result:
- * A pointer to a CFString, or NULL if failed. It is caller's
- * responsibilty to release the memory allocated for the string.
- *
- * Availability:
- * Mac OS X: in version 10.1 and later in CoreServices.framework
- * CarbonLib: not available
- * Non-Carbon CFM: not available
- }
- function CFHTTPMessageAddAuthentication( request: CFHTTPMessageRef; authenticationFailureResponse: CFHTTPMessageRef; username: CFStringRef; password: CFStringRef; authenticationScheme: CFStringRef; forProxy: Boolean ): Boolean; external name '_CFHTTPMessageAddAuthentication';
- (* __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_2_0) *)
- {********************}
- { Response functions }
- {********************}
- {
- * CFHTTPMessageGetResponseStatusCode()
- *
- * Discussion:
- * Returns the status code for the response.
- *
- * Mac OS X threading:
- * Not thread safe
- *
- * Parameters:
- *
- * response:
- * A pointer to the CFHTTPMessage to be copied. If the message is
- * NULL, the behavior is undefined.
- *
- * Result:
- * A UInt32 indicating the status code.
- *
- * Availability:
- * Mac OS X: in version 10.1 and later in CoreServices.framework
- * CarbonLib: not available
- * Non-Carbon CFM: not available
- }
- function CFHTTPMessageGetResponseStatusCode( response: CFHTTPMessageRef ): CFIndex; external name '_CFHTTPMessageGetResponseStatusCode';
- (* __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_2_0) *)
- {
- * CFHTTPMessageCopyResponseStatusLine()
- *
- * Discussion:
- * Returns the status line for the response.
- *
- * Mac OS X threading:
- * Not thread safe
- *
- * Parameters:
- *
- * response:
- * A pointer to the CFHTTPMessage to be copied. If the message is
- * NULL, the behavior is undefined.
- *
- * Result:
- * A CFString indicating the status code, or NULL if failed. It is
- * caller's responsibilty to release the memory allocated for the
- * string.
- *
- * Availability:
- * Mac OS X: in version 10.1 and later in CoreServices.framework
- * CarbonLib: not available
- * Non-Carbon CFM: not available
- }
- function CFHTTPMessageCopyResponseStatusLine( response: CFHTTPMessageRef ): CFStringRef; external name '_CFHTTPMessageCopyResponseStatusLine';
- (* __OSX_AVAILABLE_STARTING(__MAC_10_1,__IPHONE_2_0) *)
- {$ifc not defined MACOSALLINCLUDE or not MACOSALLINCLUDE}
- end.
- {$endc} {not MACOSALLINCLUDE}
|