PTDiffusionHTTPProxyConfiguration Class Reference

Connection details for an HTTP proxy to be tunneled through in order to reach the Diffusion server. More...

#include <PTDiffusionHTTPProxyConfiguration.h>

Inheritance diagram for PTDiffusionHTTPProxyConfiguration:

Instance Methods
(instancetype)	- initWithHost:port:
(instancetype)	- initWithHost:port:authentication:
(BOOL)	- isEqualToHTTPProxyConfiguration:

Properties
NSString *	host
UInt32	port
id< PTDiffusionHTTPAuthentication >	authentication

Detailed Description

Connection details for an HTTP proxy to be tunneled through in order to reach the Diffusion server.

See also

PTDiffusionSessionConfiguration

Since

6.0

Method Documentation

initWithHost:port:

- (instancetype) initWithHost:		(NSString *)	host
port:		(UInt32)	port

Returns a HTTP proxy authentication object initialized with the given host and port.

Parameters

host	The host name of the HTTP proxy.
port	The port of the HTTP proxy.

Returns

A HTTP proxy authentication object initialized with the given host and port.

Exceptions

NSInvalidArgumentException

If host is `nil`.

Since

6.0

initWithHost:port:authentication:

- (instancetype) initWithHost:		(NSString *)	host
port:		(UInt32)	port
authentication:		(id< PTDiffusionHTTPAuthentication >)	authentication

Returns a HTTP proxy authentication object initialized with the given host, port and authentication.

Parameters

host	The host name of the proxy.
port	The TCP port of the proxy.
authentication	The provider to be used if the proxy requests authentication.

Returns

A HTTP proxy authentication object initialized with the given host, port and authentication.

Exceptions

NSInvalidArgumentException

If either host or authentication is `nil`.

See also

PTDiffusionBasicHTTPProxyAuthentication

Since

6.0

isEqualToHTTPProxyConfiguration:

- (BOOL) isEqualToHTTPProxyConfiguration:

(nullable PTDiffusionHTTPProxyConfiguration *)

configuration

Compares the receiver to the given configuration.

Parameters

configuration

The HTTP proxy configuration object with which to compare the receiver.

Returns

YES if the configuration is identical to the receiver, otherwise NO.

Since

6.0

Property Documentation

authentication

- (id<PTDiffusionHTTPAuthentication>) authentication

readnonatomicassign

The provider to be used if the proxy requests authentication.

See also

PTDiffusionBasicHTTPProxyAuthentication

Since

6.0

host

- (NSString*) host

readnonatomicassign

The host name of the proxy.

Since

6.0

port

- (UInt32) port

readnonatomicassign

The TCP port of the proxy.

Since

6.0