OFHTTPClient.h

/*
 * Copyright (c) 2008-2026 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 "OFRunLoop.h"
 
#ifndef OF_HAVE_SOCKETS
# error No sockets available!
#endif
 
OF_ASSUME_NONNULL_BEGIN
 
@class OFDictionary OF_GENERIC(KeyType, ObjectType);
@class OFHTTPClient;
@class OFHTTPClientResponse;
@class OFHTTPRequest;
@class OFHTTPResponse;
@class OFIRI;
@class OFStream;
@class OFTCPSocket;
@class OFTLSStream;

@protocol OFHTTPClientDelegate <OFObject>
-      (void)client: (OFHTTPClient *)client
  didPerformRequest: (OFHTTPRequest *)request
       response: (nullable OFHTTPResponse *)response
      exception: (nullable id)exception;
 
@optional
-   (void)client: (OFHTTPClient *)client
  didCreateTCPSocket: (OFTCPSocket *)TCPSocket
         request: (OFHTTPRequest *)request;

-   (void)client: (OFHTTPClient *)client
  didCreateTLSStream: (OFTLSStream *)TLSStream
         request: (OFHTTPRequest *)request;

-     (void)client: (OFHTTPClient *)client
  wantsRequestBody: (OFStream *)requestBody
       request: (OFHTTPRequest *)request;

-      (void)client: (OFHTTPClient *)client
  didReceiveHeaders: (OFDictionary OF_GENERIC(OFString *, OFString *) *)headers
     statusCode: (short)statusCode
        request: (OFHTTPRequest *)request;

-          (bool)client: (OFHTTPClient *)client
  shouldFollowRedirectToIRI: (OFIRI *)IRI
         statusCode: (short)statusCode
            request: (OFHTTPRequest *)request
           response: (OFHTTPResponse *)response;
@end

OF_SUBCLASSING_RESTRICTED
@interface OFHTTPClient: OFObject
{
#ifdef OF_HTTP_CLIENT_M
@public
#endif
    OFObject <OFHTTPClientDelegate> *_Nullable _delegate;
    bool _allowsInsecureRedirects, _inProgress;
    OFStream *_Nullable _stream;
    OFIRI *_Nullable _lastIRI;
    bool _lastWasHEAD;
    OFHTTPClientResponse *_Nullable _lastResponse;
}

@property OF_NULLABLE_PROPERTY (assign, nonatomic)
    OFObject <OFHTTPClientDelegate> *delegate;

@property (nonatomic) bool allowsInsecureRedirects;

+ (instancetype)client;

- (OFHTTPResponse *)performRequest: (OFHTTPRequest *)request;

- (OFHTTPResponse *)performRequest: (OFHTTPRequest *)request
             redirects: (unsigned int)redirects;

- (void)asyncPerformRequest: (OFHTTPRequest *)request;

- (void)asyncPerformRequest: (OFHTTPRequest *)request
          redirects: (unsigned int)redirects;

- (void)asyncPerformRequest: (OFHTTPRequest *)request
          redirects: (unsigned int)redirects
        runLoopMode: (OFRunLoopMode)runLoopMode;

- (void)close;
@end
 
OF_ASSUME_NONNULL_END