VPNUTransport
Class used to send synchronous requests to VPN Unlimited service servers.
Discussion
When an instance of this class is created it then can be passed as a parameter to other classes which are initialized using initWithtransport: method.
Once sign-in request is successful, the instance of VPNUTransport manages the created session internally. Therefore, all subsequent requests should be made using the same instance of VPNUTransport.
If you use the standard authorization routine with authorizeWithLogin: method of VPNUAuthorizer class, VPNUTransport silently re-authorizes if the session is expired. But if you implement non-standard authorization methods (like authorizing with social networks), it is impossible to re-authorize without calling the third-party code. In this case you must implement methods from VPNUAuthDelegateProtocol and pass the delegate instance to customAuthDelegate property before any usage of this class.
Extends: NSObject
Declared in: VPNUTransport.h
Instance Methods
cancelAllRequests
- (void)cancelAllRequests;
Cancels all pending requests.
sendRequest:error:
- (id)sendRequest:(VPNURequest *)request error:(NSError **)error;
Sends the specified request synchronously.
Parameters
- request
- The cunstructed request object. Cannot be
nil. - 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 arbitrary object which represents a server response if no error has occured. Can be nil.
Discussion
This method sends a previously created instance of VPNURequest synchronously and waits for the response. It blocks a calling thread.
Warning
This method shouldn't be called from main thread.
Availability
Available in Mac OS X v10.7. Available in iOS v7.0.
Class Methods
setSharedTransport:
+ (void)setSharedTransport:(VPNUTransport *)transport;
Sets the shared
VPNUTransport instance to a specified transport object.
Parameters
- transport
- The transport object to use as the shared transport object.
Discussion
An application that has special transporting requirements or constraints should use this method to specify an VPNUTransport instance with customized settings. The application should do so before any calls to the sharedTransport method.
Availability
Available in Mac OS X v10.7. Available in iOS v7.0.
sharedTransport
+ (VPNUTransport *)sharedTransport;
Returns the shared
VPNUTransport instance.
Return value
The shared VPNUTransport instance.
Discussion
Applications that do not have special transporting requirements or constraints should find the default shared transport instance acceptable. An application with more specific needs can create a custom VPNUTransport object and set it as the shared transport instance using setSharedTransport:. The application should do so before any calls to this method.
Availability
Available in Mac OS X v10.7. Available in iOS v7.0.
Properties
customAuthDelegate
@property (strong) id<VPNUAuthDelegateProtocol> customAuthDelegate;
A delegate object which conforms to VPNUAuthDelegateProtocol protocol.
Discussion
Once you define an object which conforms to VPNUAuthDelegateProtocol, set this property with it. If you are using non-standard authorization methods (like authorizing with social networks), you must provide an object which resolves custom authorization with third-party server and returns authentication details.
Availability
Available in Mac OS X v10.7. Available in iOS v7.0.