OFHTTPRequest.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015
 *   Jonathan Schleifer <js@webkeks.org>
 *
 * All rights reserved.
 *
 * This file is part of ObjFW. It may be distributed under the terms of the
 * Q Public License 1.0, which can be found in the file LICENSE.QPL included in
 * the packaging of this file.
 *
 * Alternatively, it may be distributed under the terms of the GNU General
 * Public License, either version 2 or 3, which can be found in the file
 * LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
 * file.
 */

#import "OFObject.h"
#import "OFString.h"

#ifndef OF_HAVE_SOCKETS
# error No sockets available!
#endif

OF_ASSUME_NONNULL_BEGIN

@class OFURL;
@class OFDictionary OF_GENERIC(KeyType, ObjectType);
@class OFDataArray;
@class OFString;

typedef enum {
    OF_HTTP_REQUEST_METHOD_OPTIONS,
    OF_HTTP_REQUEST_METHOD_GET,
    OF_HTTP_REQUEST_METHOD_HEAD,
    OF_HTTP_REQUEST_METHOD_POST,
    OF_HTTP_REQUEST_METHOD_PUT,
    OF_HTTP_REQUEST_METHOD_DELETE,
    OF_HTTP_REQUEST_METHOD_TRACE,
    OF_HTTP_REQUEST_METHOD_CONNECT
} of_http_request_method_t;

typedef struct {
    uint8_t major;
    uint8_t minor;
} of_http_request_protocol_version_t;

@interface OFHTTPRequest: OFObject <OFCopying>
{
    OFURL *_URL;
    of_http_request_method_t _method;
    of_http_request_protocol_version_t _protocolVersion;
    OFDictionary OF_GENERIC(OFString*, OFString*) *_headers;
    OFDataArray *_body;
    OFString *_remoteAddress;
}

#ifdef OF_HAVE_PROPERTIES
@property (copy) OFURL *URL;
@property of_http_request_method_t method;
@property of_http_request_protocol_version_t protocolVersion;
@property OF_NULLABLE_PROPERTY (copy)
    OFDictionary OF_GENERIC(OFString*, OFString*) *headers;
@property OF_NULLABLE_PROPERTY (retain) OFDataArray *body;
@property OF_NULLABLE_PROPERTY (copy) OFString *remoteAddress;
#endif

+ (instancetype)request;

+ (instancetype)requestWithURL: (OFURL*)URL;

- initWithURL: (OFURL*)URL;

- (void)setURL: (OFURL*)URL;

- (OFURL*)URL;

- (void)setMethod: (of_http_request_method_t)method;

- (of_http_request_method_t)method;

- (void)setProtocolVersion: (of_http_request_protocol_version_t)protocolVersion;

- (of_http_request_protocol_version_t)protocolVersion;

- (void)setProtocolVersionFromString: (OFString*)string;

- (OFString*)protocolVersionString;

- (void)setHeaders:
    (nullable OFDictionary OF_GENERIC(OFString*, OFString*)*)headers;

- (nullable OFDictionary OF_GENERIC(OFString*, OFString*)*)headers;

- (void)setBody: (nullable OFDataArray*)body;

- (void)setBodyFromString: (nullable OFString*)string;

- (void)setBodyFromString: (nullable OFString*)string
         encoding: (of_string_encoding_t)encoding;

- (nullable OFDataArray*)body;

- (void)setRemoteAddress: (nullable OFString*)remoteAddress;

- (nullable OFString*)remoteAddress;
@end

#ifdef __cplusplus
extern "C" {
#endif

extern const char *OF_NULLABLE of_http_request_method_to_string(
    of_http_request_method_t method);

extern of_http_request_method_t of_http_request_method_from_string(
    const char *string);
#ifdef __cplusplus
}
#endif

OF_ASSUME_NONNULL_END