GDNETiOS.h

Go to the documentation of this file.

/*
 * Copyright 2023 BlackBerry Limited. All rights reserved.
 *
 */
 
#pragma once
 
#import <Foundation/Foundation.h>
#import "GDURLLoadingSystem.h"
#import "GDNET.h"
 
typedef NS_ENUM(NSInteger, GDSocketErrorType)
{
    GDSocketErrorNone=0,
    
    GDSocketErrorNetworkUnvailable,
 
    GDSocketErrorServiceTimeOut
};
 
NS_ASSUME_NONNULL_BEGIN
 
@protocol GDSocketDelegate
 
@required
- (void)onOpen:(id) socket;
 
@required
- (void)onRead:(id) socket;
 
@required
- (void)onClose:(id) socket;
 
@required
- (void)onErr:(int)error inSocket:(id) socket;
 
@end
 
 
@interface GDDirectByteBuffer : NSObject {
    @private
    void* m_dbbInternal;
}
 
- (instancetype)init;
 
- (void)write:(const char*)data;
 
- (void)writeData:(NSData*)data;
 
- (void)write:(const char*)data withLength:(int)length;
 
- (int)bytesUnread;
 
- (int)read:(char*)data toMaxLength:(int)maxLength;
 
- (nullable NSMutableString*)unreadDataAsString;
 
- (nullable NSMutableData*)unreadData;
 
@end
 
@interface GDSocket : NSObject {
    __weak id <GDSocketDelegate> _Nullable delegate;
    @private
    void* m_socketInternal;
    GDDirectByteBuffer* writeStream;
    GDDirectByteBuffer* readStream;
}
 
- (instancetype)init:(const char*)url onPort:(int)port andUseSSL:(BOOL)ssl;
 
- (BOOL)disableHostVerification;
 
- (BOOL)disablePeerVerification;
 
- (void)connect;
 
- (void)write;
 
- (void)disconnect;
 
@property (nullable, nonatomic, weak) id<GDSocketDelegate> delegate;
 
@property (nullable, nonatomic, strong) GDDirectByteBuffer* writeStream;
 
@property (nullable, nonatomic, strong) GDDirectByteBuffer* readStream;
 
@end
 
/* \cond DOXYGEN_IGNORE */
#if __has_extension(attribute_deprecated_with_message)
#   define DEPRECATE_GDHTTPREQUESTDELEGATE __attribute__((deprecated("GDHttpRequestDelegate interface has been deprecated")))
#else
#   define DEPRECATE_GDHTTPREQUESTDELEGATE __attribute__((deprecated))
#endif
/* \endcond */
 
DEPRECATE_GDHTTPREQUESTDELEGATE
@protocol GDHttpRequestDelegate
 
@required
- (void)onStatusChange:(id) httpRequest DEPRECATE_GDHTTPREQUESTDELEGATE;
 
@end
 
typedef NS_ENUM(NSInteger, GDHttpRequest_state_t)
{
    GDHttpRequest_UNSENT = 0,
    GDHttpRequest_OPENED = 1,
    GDHttpRequest_SENT = 2,
    GDHttpRequest_HEADERS_RECEIVED = 3,
    GDHttpRequest_LOADING = 4,
    GDHttpRequest_DONE = 5
} DEPRECATE_GDHTTPREQUESTDELEGATE;
 
// See: http://clang.llvm.org/docs/LanguageExtensions.html
/* \cond DOXYGEN_IGNORE */
#ifndef __has_extension
#define __has_extension(x) 0  // Compatibility with non-clang compilers.
#endif
/* \endcond */
 
/* \cond DOXYGEN_IGNORE */
#if __has_extension(attribute_deprecated_with_message)
#   define DEPRECATE_CLEARCOOKIES __attribute__((deprecated("No longer supported")))
#else
#   define DEPRECATE_CLEARCOOKIES __attribute__((deprecated))
#endif
#if __has_extension(attribute_deprecated_with_message)
#   define DEPRECATE_GDHTTPREQUEST __attribute__((deprecated("GDHttpRequest interface has been deprecated")))
#else
#   define DEPRECATE_GDHTTPREQUEST __attribute__((deprecated))
#endif
/* \endcond */
DEPRECATE_GDHTTPREQUEST
@interface GDHttpRequest : NSObject {
    __weak id <GDHttpRequestDelegate> _Nullable delegate;
    @private
    void* m_httpRequestInternal;
}
 
- (instancetype)init DEPRECATE_GDHTTPREQUEST;
 
- (BOOL) open:(const char*)method withUrl:(const char*)url withAsync:(BOOL) isAsync withUser:(nullable const char*)user withPass:(nullable const char*)password withAuth:(nullable const char*)auth DEPRECATE_GDHTTPREQUEST;
 
- (BOOL) open:(const char*)method withUrl:(const char*)url withUser:(nullable const char*)user withPass:(nullable const char*)password withAuth:(nullable const char*)auth DEPRECATE_GDHTTPREQUEST;
 
- (BOOL) open:(const char*)method withUrl:(const char*)url withAsync:(BOOL)isAsync DEPRECATE_GDHTTPREQUEST;
 
- (BOOL) open:(const char*)method withUrl:(const char*)url DEPRECATE_GDHTTPREQUEST;
 
- (BOOL) disableHostVerification DEPRECATE_GDHTTPREQUEST;
 
- (BOOL) disablePeerVerification DEPRECATE_GDHTTPREQUEST;
 
- (BOOL) disableFollowLocation DEPRECATE_GDHTTPREQUEST;
 
- (BOOL) disableCookieHandling DEPRECATE_GDHTTPREQUEST;
 
- (void) clearCookies:(BOOL) includePersistentStore DEPRECATE_CLEARCOOKIES;
 
- (BOOL) enableHttpProxy:(const char*)host withPort:(int)port withUser:(const char*)user withPass:(const char*)password withAuth:(const char*)auth DEPRECATE_GDHTTPREQUEST;
 
- (BOOL) enableHttpProxy:(const char*)host withPort:(int)port DEPRECATE_GDHTTPREQUEST;
 
- (BOOL) disableHttpProxy DEPRECATE_GDHTTPREQUEST;
 
- (BOOL) setRequestHeader:(const char*)header withValue:(const char*)value DEPRECATE_GDHTTPREQUEST;
 
- (void) setPostValue:(const char*)value forKey:(const char*)key DEPRECATE_GDHTTPREQUEST;
 
- (void) clearPostValues DEPRECATE_GDHTTPREQUEST;
 
- (BOOL) send:(nullable const char*)data withLength:(unsigned int)len withTimeout:(int)timeout_s DEPRECATE_GDHTTPREQUEST;
 
- (BOOL) send:(nullable const char*)data withTimeout:(int)timeout_s DEPRECATE_GDHTTPREQUEST;
 
 
- (BOOL) send:(nullable const char*)data DEPRECATE_GDHTTPREQUEST;
 
- (BOOL) send DEPRECATE_GDHTTPREQUEST;
 
- (BOOL) sendData:(nullable NSData*)data withTimeout:(int)timeout_s DEPRECATE_GDHTTPREQUEST;
 
- (BOOL) sendData:(nullable NSData*)data DEPRECATE_GDHTTPREQUEST;
 
- (BOOL) sendWithFile:(NSString*)pathAndFileName withTimeout:(NSTimeInterval)timeoutSeconds DEPRECATE_GDHTTPREQUEST;
 
- (BOOL) sendWithFile:(NSString*)pathAndFileName DEPRECATE_GDHTTPREQUEST;
 
- (GDHttpRequest_state_t) getState DEPRECATE_GDHTTPREQUEST;
 
- (nullable const char*) getResponseHeader:(const char*)header DEPRECATE_GDHTTPREQUEST;
 
- (nullable const char*) getAllResponseHeaders DEPRECATE_GDHTTPREQUEST;
 
- (int) getStatus DEPRECATE_GDHTTPREQUEST;
 
- (nullable const char*) getStatusText DEPRECATE_GDHTTPREQUEST;
 
- (nullable GDDirectByteBuffer*) getReceiveBuffer DEPRECATE_GDHTTPREQUEST;
 
- (BOOL) close DEPRECATE_GDHTTPREQUEST;
 
- (BOOL) abort DEPRECATE_GDHTTPREQUEST;
 
@property (nonatomic, assign) BOOL enablePipelining DEPRECATE_GDHTTPREQUEST;
 
@property (nullable, nonatomic, weak) id<GDHttpRequestDelegate> delegate DEPRECATE_GDHTTPREQUEST;
 
@end
 
NS_ASSUME_NONNULL_END