//
//  OpenVPNAdapter+Provider.h
//  OpenVPN iOS Client
//
//  Created by Sergey Abramchuk on 11.02.17.
//
//

#import "OpenVPNEvent.h"

#import "OpenVPNAdapter.h"

@class NEPacketTunnelNetworkSettings;

// TODO: Add documentation to properties and methods

/**
 <#Description#>
 */
@protocol OpenVPNAdapterPacketFlow <NSObject>

/**
 <#Description#>

 @param completionHandler <#completionHandler description#>
 */
- (void)readPacketsWithCompletionHandler:(nonnull void (^)(NSArray<NSData *> * _Nonnull packets, NSArray<NSNumber *> * _Nonnull protocols))completionHandler;

/**
 <#Description#>

 @param packets <#packets description#>
 @param protocols <#protocols description#>
 @return <#return value description#>
 */
- (BOOL)writePackets:(nonnull NSArray<NSData *> *)packets withProtocols:(nonnull NSArray<NSNumber *> *)protocols;

@end

/**
 <#Description#>
 */
@protocol OpenVPNAdapterDelegate <NSObject>

/**
 <#Description#>

 @param settings <#settings description#>
 @param callback <#callback description#>
 */
- (void)configureTunnelWithSettings:(nonnull NEPacketTunnelNetworkSettings *)settings
                 callback:(nonnull void (^)(id<OpenVPNAdapterPacketFlow> _Nullable flow))callback
NS_SWIFT_NAME(configureTunnel(settings:callback:));

/**
 <#Description#>

 @param event <#event description#>
 @param message <#message description#>
 */
- (void)handleEvent:(OpenVPNEvent)event
            message:(nullable NSString *)message
NS_SWIFT_NAME(handle(event:message:));

/**
 <#Description#>

 @param error <#error description#>
 */
- (void)handleError:(nonnull NSError *)error
NS_SWIFT_NAME(handle(error:));

/**
 <#Description#>

 @param logMessage <#logMessage description#>
 */
- (void)handleLog:(nonnull NSString *)logMessage
NS_SWIFT_NAME(handle(logMessage:));

@end

/**
 <#Description#>
 */
@interface OpenVPNAdapter (Provider)

/**
 <#Description#>
 */
@property (strong, nonatomic, nullable) NSString *username;

/**
 <#Description#>
 */
@property (strong, nonatomic, nullable) NSString *password;

/**
 <#Description#>
 */
@property (weak, nonatomic, null_unspecified) id<OpenVPNAdapterDelegate> delegate;

/**
 <#Description#>

 @param settings <#settings description#>
 @param error <#error description#>
 @return <#return value description#>
 */
- (BOOL)configureUsingSettings:(nonnull NSData *)settings
            error:(out NSError * __nullable * __nullable)error
NS_SWIFT_NAME(configure(using:));

/**
 Establish connection with the VPN server
 */
- (void)connect;

/**
 Close connection with the VPN server
 */
- (void)disconnect;

@end