mirror of
https://github.com/deneraraujo/OpenVPNAdapter.git
synced 2026-02-11 00:00:08 +08:00
0b1e8117f0
Delete unnecessary properties ad methods. Implement applying configuration and providing credentials.
135 lines
2.9 KiB
Objective-C
135 lines
2.9 KiB
Objective-C
//
|
|
// OpenVPNAdapter+Public.h
|
|
// OpenVPN Adapter
|
|
//
|
|
// Created by Sergey Abramchuk on 11.02.17.
|
|
//
|
|
//
|
|
|
|
#import "OpenVPNEvent.h"
|
|
#import "OpenVPNAdapter.h"
|
|
|
|
@class OpenVPNConfiguration;
|
|
@class OpenVPNProperties;
|
|
@class OpenVPNCredentials;
|
|
@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:));
|
|
|
|
@optional
|
|
|
|
/**
|
|
<#Description#>
|
|
|
|
@param logMessage <#logMessage description#>
|
|
*/
|
|
- (void)handleLog:(nonnull NSString *)logMessage
|
|
NS_SWIFT_NAME(handle(logMessage:));
|
|
|
|
/**
|
|
<#Description#>
|
|
*/
|
|
- (void)tick;
|
|
|
|
@end
|
|
|
|
/**
|
|
<#Description#>
|
|
*/
|
|
@interface OpenVPNAdapter (Public)
|
|
|
|
/**
|
|
<#Description#>
|
|
*/
|
|
@property (weak, nonatomic, null_unspecified) id<OpenVPNAdapterDelegate> delegate;
|
|
|
|
/**
|
|
<#Description#>
|
|
|
|
@param configuration <#configuration description#>
|
|
@param error <#error description#>
|
|
@return <#return value description#>
|
|
*/
|
|
- (nullable OpenVPNProperties *)applyConfiguration:(nonnull OpenVPNConfiguration *)configuration
|
|
error:(out NSError * __nullable * __nullable)error
|
|
NS_SWIFT_NAME(apply(configuration:));
|
|
|
|
/**
|
|
<#Description#>
|
|
|
|
@param credentials <#credentials description#>
|
|
@param error <#error description#>
|
|
@return <#return value description#>
|
|
*/
|
|
- (BOOL)provideCredentials:(nonnull OpenVPNCredentials *)credentials
|
|
error:(out NSError * __nullable * __nullable)error
|
|
NS_SWIFT_NAME(provide(credentials:));
|
|
|
|
/**
|
|
Establish connection with the VPN server
|
|
*/
|
|
- (void)connect;
|
|
|
|
/**
|
|
Close connection with the VPN server
|
|
*/
|
|
- (void)disconnect;
|
|
|
|
@end
|