OFHTTPServer.h

/*
 * Copyright (c) 2008-2025 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"
 
#ifndef OF_HAVE_SOCKETS
# error No sockets available!
#endif
 
OF_ASSUME_NONNULL_BEGIN
 
@class OFArray OF_GENERIC(ObjectType);
@class OFHTTPRequest;
@class OFHTTPResponse;
@class OFHTTPServer;
@class OFStream;
@class OFTCPSocket;
@class OFX509Certificate;
 
@protocol OFHTTPServerDelegate <OFObject>
-      (void)server: (OFHTTPServer *)server
  didReceiveRequest: (OFHTTPRequest *)request
    requestBody: (nullable OFStream *)requestBody
       response: (OFHTTPResponse *)response;
 
@optional
-      (void)server: (OFHTTPServer *)server
  didEncounterException: (id)exception
        request: (nullable OFHTTPRequest *)request
           response: (nullable OFHTTPResponse *)response;
 
-             (bool)server: (OFHTTPServer *)server
  didReceiveExceptionOnListeningSocket: (id)exception
    OF_DEPRECATED(ObjFW, 1, 3,
    "Use -[server:didEncounterException:request:response:] instead");
 
-           (void)server: (OFHTTPServer *)server
  didReceiveExceptionForResponse: (OFHTTPResponse *)response
             request: (OFHTTPRequest *)request
               exception: (id)exception
    OF_DEPRECATED(ObjFW, 1, 3,
    "Use -[server:didEncounterException:request:response:] instead");
@end
 
OF_SUBCLASSING_RESTRICTED
@interface OFHTTPServer: OFObject
{
    OFString *_Nullable _host;
    uint16_t _port;
    id <OFHTTPServerDelegate> _Nullable _delegate;
    OFString *_Nullable _name;
    OFTCPSocket *_Nullable _listeningSocket;
    bool _usesTLS;
    OFArray OF_GENERIC(OFX509Certificate *) *_Nullable _certificateChain;
#ifdef OF_HAVE_THREADS
    size_t _numberOfThreads, _nextThreadIndex;
    OFArray *_threadPool;
#endif
}
 
@property OF_NULLABLE_PROPERTY (copy, nonatomic) OFString *host;
 
@property (nonatomic) uint16_t port;
 
@property (nonatomic) bool usesTLS;
 
@property OF_NULLABLE_PROPERTY (copy, nonatomic)
    OFArray OF_GENERIC(OFX509Certificate *) *certificateChain;
 
@property OF_NULLABLE_PROPERTY (assign, nonatomic)
    id <OFHTTPServerDelegate> delegate;
 
#ifdef OF_HAVE_THREADS
@property (nonatomic) size_t numberOfThreads;
#endif
 
@property OF_NULLABLE_PROPERTY (copy, nonatomic) OFString *name;
 
+ (instancetype)server;
 
- (void)start;
 
- (void)stop;
@end
 
OF_ASSUME_NONNULL_END