xref: /aosp_15_r20/external/google-breakpad/src/common/mac/HTTPRequest.h (revision 9712c20fc9bbfbac4935993a2ca0b3958c5adad2)
1*9712c20fSFrederick Mayle // Copyright 2020 Google LLC
2*9712c20fSFrederick Mayle //
3*9712c20fSFrederick Mayle // Redistribution and use in source and binary forms, with or without
4*9712c20fSFrederick Mayle // modification, are permitted provided that the following conditions are
5*9712c20fSFrederick Mayle // met:
6*9712c20fSFrederick Mayle //
7*9712c20fSFrederick Mayle //     * Redistributions of source code must retain the above copyright
8*9712c20fSFrederick Mayle // notice, this list of conditions and the following disclaimer.
9*9712c20fSFrederick Mayle //     * Redistributions in binary form must reproduce the above
10*9712c20fSFrederick Mayle // copyright notice, this list of conditions and the following disclaimer
11*9712c20fSFrederick Mayle // in the documentation and/or other materials provided with the
12*9712c20fSFrederick Mayle // distribution.
13*9712c20fSFrederick Mayle //     * Neither the name of Google LLC nor the names of its
14*9712c20fSFrederick Mayle // contributors may be used to endorse or promote products derived from
15*9712c20fSFrederick Mayle // this software without specific prior written permission.
16*9712c20fSFrederick Mayle //
17*9712c20fSFrederick Mayle // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18*9712c20fSFrederick Mayle // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19*9712c20fSFrederick Mayle // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20*9712c20fSFrederick Mayle // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21*9712c20fSFrederick Mayle // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22*9712c20fSFrederick Mayle // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23*9712c20fSFrederick Mayle // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24*9712c20fSFrederick Mayle // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25*9712c20fSFrederick Mayle // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26*9712c20fSFrederick Mayle // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27*9712c20fSFrederick Mayle // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28*9712c20fSFrederick Mayle 
29*9712c20fSFrederick Mayle #import <Foundation/Foundation.h>
30*9712c20fSFrederick Mayle 
31*9712c20fSFrederick Mayle NS_ASSUME_NONNULL_BEGIN
32*9712c20fSFrederick Mayle /**
33*9712c20fSFrederick Mayle  Represents a single HTTP request. Sending the request is synchronous.
34*9712c20fSFrederick Mayle  Once the send is complete, the response will be set.
35*9712c20fSFrederick Mayle 
36*9712c20fSFrederick Mayle  This is a base interface that specific HTTP requests derive from.
37*9712c20fSFrederick Mayle  It is not intended to be instantiated directly.
38*9712c20fSFrederick Mayle  */
39*9712c20fSFrederick Mayle @interface HTTPRequest : NSObject {
40*9712c20fSFrederick Mayle  @protected
41*9712c20fSFrederick Mayle   NSURL* URL_;                   // The destination URL (STRONG)
42*9712c20fSFrederick Mayle   NSHTTPURLResponse* response_;  // The response from the send (STRONG)
43*9712c20fSFrederick Mayle }
44*9712c20fSFrederick Mayle 
45*9712c20fSFrederick Mayle /**
46*9712c20fSFrederick Mayle  Initializes the HTTPRequest and sets its URL.
47*9712c20fSFrederick Mayle  */
48*9712c20fSFrederick Mayle - (id)initWithURL:(NSURL*)URL;
49*9712c20fSFrederick Mayle 
50*9712c20fSFrederick Mayle - (NSURL*)URL;
51*9712c20fSFrederick Mayle 
52*9712c20fSFrederick Mayle - (NSHTTPURLResponse*)response;
53*9712c20fSFrederick Mayle 
54*9712c20fSFrederick Mayle - (NSString*)HTTPMethod;  // Internal, don't call outside class hierarchy.
55*9712c20fSFrederick Mayle 
56*9712c20fSFrederick Mayle - (NSString*)contentType;  // Internal, don't call outside class hierarchy.
57*9712c20fSFrederick Mayle 
58*9712c20fSFrederick Mayle - (NSData*)bodyData;  // Internal, don't call outside class hierarchy.
59*9712c20fSFrederick Mayle 
60*9712c20fSFrederick Mayle - (NSData*)send:(NSError**)error;
61*9712c20fSFrederick Mayle 
62*9712c20fSFrederick Mayle /**
63*9712c20fSFrederick Mayle  Appends a file to the HTTP request, either by filename or by file content
64*9712c20fSFrederick Mayle  (in the form of NSData).
65*9712c20fSFrederick Mayle  */
66*9712c20fSFrederick Mayle + (void)appendFileToBodyData:(NSMutableData*)data
67*9712c20fSFrederick Mayle                     withName:(NSString*)name
68*9712c20fSFrederick Mayle               withFileOrData:(id)fileOrData;
69*9712c20fSFrederick Mayle 
70*9712c20fSFrederick Mayle @end
71*9712c20fSFrederick Mayle 
72*9712c20fSFrederick Mayle NS_ASSUME_NONNULL_END
73