OFHTTPRequest.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2024 Jonathan Schleifer <js@nil.im>
 *
 * All rights reserved.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3.0 only,
 * as published by the Free Software Foundation.
 *
 * This program 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 Lesser General Public License
 * version 3.0 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3.0 along with this program. If not, see
 * <https://www.gnu.org/licenses/>.
 */
 
#import "OFObject.h"
#import "OFSocket.h"
#import "OFString.h"
 
OF_ASSUME_NONNULL_BEGIN
 
@class OFData;
@class OFDictionary OF_GENERIC(KeyType, ObjectType);
@class OFIRI;
@class OFString;
 
typedef enum {
    OFHTTPRequestMethodOptions,
    OFHTTPRequestMethodGet,
    OFHTTPRequestMethodHead,
    OFHTTPRequestMethodPost,
    OFHTTPRequestMethodPut,
    OFHTTPRequestMethodDelete,
    OFHTTPRequestMethodTrace,
    OFHTTPRequestMethodConnect
} OFHTTPRequestMethod;
 
typedef struct OF_BOXABLE OFHTTPRequestProtocolVersion {
    unsigned char major;
    unsigned char minor;
} OFHTTPRequestProtocolVersion;
 
OF_SUBCLASSING_RESTRICTED
@interface OFHTTPRequest: OFObject <OFCopying>
{
    OFIRI *_IRI;
    OFHTTPRequestMethod _method;
    OFHTTPRequestProtocolVersion _protocolVersion;
    OFDictionary OF_GENERIC(OFString *, OFString *) *_Nullable _headers;
    OFSocketAddress _remoteAddress;
    bool _hasRemoteAddress;
}
 
@property (copy, nonatomic) OFIRI *IRI;
 
@property (nonatomic) OFHTTPRequestProtocolVersion protocolVersion;
 
@property (copy, nonatomic) OFString *protocolVersionString;
 
@property (nonatomic) OFHTTPRequestMethod method;
 
@property OF_NULLABLE_PROPERTY (copy, nonatomic)
    OFDictionary OF_GENERIC(OFString *, OFString *) *headers;
 
@property OF_NULLABLE_PROPERTY (nonatomic) const OFSocketAddress *remoteAddress;
 
+ (instancetype)requestWithIRI: (OFIRI *)IRI;
 
- (instancetype)initWithIRI: (OFIRI *)IRI;
 
- (instancetype)init OF_UNAVAILABLE;
@end
 
#ifdef __cplusplus
extern "C" {
#endif
extern OFString *_Nullable OFHTTPRequestMethodString(
    OFHTTPRequestMethod method);
 
extern OFHTTPRequestMethod OFHTTPRequestMethodParseString(OFString *string);
 
extern const char *_Nullable OFHTTPRequestMethodName(OFHTTPRequestMethod method)
    OF_DEPRECATED(ObjFW, 1, 1, "Use OFHTTPRequestMethodString instead");
 
extern OFHTTPRequestMethod OFHTTPRequestMethodParseName(OFString *string)
    OF_DEPRECATED(ObjFW, 1, 1, "Use OFHTTPRequestMethodParseString instead");
#ifdef __cplusplus
}
#endif
 
OF_ASSUME_NONNULL_END