OFDNSResolver.h

/*
 * 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 "OFDNSQuery.h"
#import "OFDNSResourceRecord.h"
#import "OFDNSResponse.h"
#import "OFRunLoop.h"
#import "OFString.h"
 
OF_ASSUME_NONNULL_BEGIN
 
#define OFDNSResolverBufferLength 512
 
@class OFArray OF_GENERIC(ObjectType);
@class OFDNSResolver;
@class OFDNSResolverContext;
@class OFDNSResolverSettings;
@class OFDate;
@class OFDictionary OF_GENERIC(KeyType, ObjectType);
@class OFMutableArray OF_GENERIC(ObjectType);
@class OFMutableDictionary OF_GENERIC(KeyType, ObjectType);
@class OFNumber;
@class OFPair OF_GENERIC(FirstType, SecondType);
@class OFTCPSocket;
@class OFUDPSocket;
 
typedef enum {
    OFDNSResolverErrorCodeUnknown,
    OFDNSResolverErrorCodeTimeout,
    OFDNSResolverErrorCodeCanceled,
    OFDNSResolverErrorCodeNoResult,
    OFDNSResolverErrorCodeServerInvalidFormat,
    OFDNSResolverErrorCodeServerFailure,
    OFDNSResolverErrorCodeServerNameError,
    OFDNSResolverErrorCodeServerNotImplemented,
    OFDNSResolverErrorCodeServerRefused,
    OFDNSResolverErrorCodeNoNameServer
} OFDNSResolverErrorCode;
 
@protocol OFDNSResolverQueryDelegate <OFObject>
-  (void)resolver: (OFDNSResolver *)resolver
  didPerformQuery: (OFDNSQuery *)query
     response: (nullable OFDNSResponse *)response
    exception: (nullable id)exception;
@end
 
@protocol OFDNSResolverHostDelegate <OFObject>
- (void)resolver: (OFDNSResolver *)resolver
  didResolveHost: (OFString *)host
       addresses: (nullable OFData *)addresses
       exception: (nullable id)exception;
@end
 
OF_SUBCLASSING_RESTRICTED
@interface OFDNSResolver: OFObject
{
    OFDNSResolverSettings *_settings;
    OFUDPSocket *_IPv4Socket;
#ifdef OF_HAVE_IPV6
    OFUDPSocket *_IPv6Socket;
#endif
    char _buffer[OFDNSResolverBufferLength];
    OFMutableDictionary OF_GENERIC(OFNumber *, OFDNSResolverContext *)
        *_queries;
    OFMutableDictionary OF_GENERIC(OFTCPSocket *, OFDNSResolverContext *)
        *_TCPQueries;
    OFMutableDictionary OF_GENERIC(OFDNSQuery *,
        OFPair OF_GENERIC(OFDate *, OFDNSResponse *) *) *_cache;
    OFMutableArray OF_GENERIC(OFString *) *_lastNameServers;
    OFTimeInterval _lastCacheCleanup;
}
 
@property (copy, nonatomic) OFDictionary OF_GENERIC(OFString *,
    OFArray OF_GENERIC(OFString *) *) *staticHosts;
 
@property (copy, nonatomic) OFArray OF_GENERIC(OFString *) *nameServers;
 
@property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFString *localDomain;
 
@property (copy, nonatomic) OFArray OF_GENERIC(OFString *) *searchDomains;
 
@property (nonatomic) OFTimeInterval timeout;
 
@property (nonatomic) unsigned int maxAttempts;
 
@property (nonatomic) unsigned int minNumberOfDotsInAbsoluteName;
 
@property (nonatomic) bool forcesTCP;
 
@property (nonatomic) OFTimeInterval configReloadInterval;
 
+ (instancetype)resolver;
 
- (instancetype)init;
 
- (void)asyncPerformQuery: (OFDNSQuery *)query
         delegate: (id <OFDNSResolverQueryDelegate>)delegate;
 
- (void)asyncPerformQuery: (OFDNSQuery *)query
          runLoopMode: (OFRunLoopMode)runLoopMode
         delegate: (id <OFDNSResolverQueryDelegate>)delegate;
 
- (void)asyncResolveAddressesForHost: (OFString *)host
                delegate: (id <OFDNSResolverHostDelegate>)delegate;
 
- (void)asyncResolveAddressesForHost: (OFString *)host
               addressFamily: (OFSocketAddressFamily)addressFamily
                delegate: (id <OFDNSResolverHostDelegate>)delegate;
 
- (void)asyncResolveAddressesForHost: (OFString *)host
               addressFamily: (OFSocketAddressFamily)addressFamily
             runLoopMode: (OFRunLoopMode)runLoopMode
                delegate: (id <OFDNSResolverHostDelegate>)delegate;
 
- (OFData *)resolveAddressesForHost: (OFString *)host
              addressFamily: (OFSocketAddressFamily)addressFamily;
 
- (void)close;
@end
 
OF_ASSUME_NONNULL_END