VPNUServersListAccessor
This class provides an interface for getting the list of available VPN servers for currently logged-in user.
Discussion
Before using this class you must authorize or register with the help of VPNUAuthorizer class. You must pass the same VPNUTransport instance to its constructor as you have passed to VPNUAuthorizer instance constructor.
Extends: NSObject
Declared in: VPNUServersListAccessor.h
Instance Methods
freeListWithError:
- (NSArray<VPNUServerItem *> *)freeListWithError:(NSError **)error;
Retieves a list of available VPN servers with no need to logged-in.
Parameters
- error
- If request generates an error, a new error object is created and returned as an object pointed to by this parameter. Can be nil.
Return value
An array of VPNUServerItem objects if no error occured, nil otherwise.
Discussion
It blocks a calling thread. This method shouldn't be called from main thread.
freeOptimalServersListWithError:
- (NSArray<VPNUServerItem *> *) freeOptimalServersListWithError:(NSError **)error;
Retieves a list of optimal VPN servers with no need to logged-in.
Parameters
- error
- If request generates an error, a new error object is created and returned as an object pointed to by this parameter. Can be nil.
Return value
An array of VPNUServerItem objects if no error occured, nil otherwise.
Discussion
It blocks a calling thread. This method shouldn't be called from main thread.
initWithTransport:
- (instancetype)initWithTransport:(VPNUTransport *)transport NS_DESIGNATED_INITIALIZER;
Initializes and returns a newly allocated servers list accessor object with the specified transport object.
Parameters
- transport
- The transport object for internal usage.
Return value
An initialized servers list accessor object or nil if the object couldn't be created.
listWithError:
- (NSArray<VPNUServerItem *> *)listWithError:(NSError **)error;
Retieves a list of available VPN servers for currently logged-in user.
Parameters
- error
- If request generates an error, a new error object is created and returned as an object pointed to by this parameter. Can be nil.
Return value
An array of VPNUServerItem objects if no error occured, nil otherwise.
Discussion
It blocks a calling thread. This method shouldn't be called from main thread.
optimalServersListWithError:
- (NSArray<VPNUServerItem *> *)optimalServersListWithError:(NSError **)error;
Retieves a list of optimal VPN servers for currently logged-in user.
Parameters
- error
- If request generates an error, a new error object is created and returned as an object pointed to by this parameter. Can be nil.
Return value
An array of VPNUServerItem objects if no error occured, nil otherwise.
Discussion
It blocks a calling thread. This method shouldn't be called from main thread.
Class Methods
serversListAccessorWithTransport:
+ (instancetype)serversListAccessorWithTransport:(VPNUTransport *)transport;
Creates and returns a newly allocated servers list accessor object with the specified transport object.
Parameters
- transport
- The transport object for internal usage.
Return value
An initialized servers list accessor object or nil if the object couldn't be created.
Discussion
This method is a convenience constructor.
Properties
useSquareFlags
@property BOOL useSquareFlags;
Use square flags.