C# Class Amazon.Runtime.ClientConfig

This class is the base class of all the configurations settings to connect to a service.

Show file Open project: aws/aws-sdk-net Class Usage Examples

Public Properties

Property	Type	Description
MaxTimeout	System.TimeSpan

Private Properties

Property	Type	Description
GetDefaultRegionEndpoint	RegionEndpoint
GetUrl	string

Public Methods

Method	Description
ClientConfig ( ) : System
DetermineServiceURL ( ) : string
GetTimeoutValue ( System.TimeSpan clientTimeout, System.TimeSpan requestTimeout ) : TimeSpan?	Returns the request timeout value if its value is set, else returns client timeout value.
GetWebProxy ( ) : IWebProxy	Returns a WebProxy instance configured to match the proxy settings in the client configuration.
GetWebProxy ( ) : WebProxy	Returns a WebProxy instance configured to match the proxy settings in the client configuration.
SetUseNagleIfAvailable ( bool useNagle ) : void	Enable or disable the Nagle algorithm on the underlying http client. This method is not intended to be called by consumers of the AWS SDK for .NET
SetWebProxy ( IWebProxy proxy ) : void	Unpacks the host, port and any credentials info into the instance's proxy-related fields. Unlike the SetWebProxy implementation on .NET 3.5/4.5,the Host and the Port are not reconstructed from the input proxyuri
SetWebProxy ( WebProxy proxy ) : void	Unpacks the host, port and any credentials info into the instance's proxy-related fields.
Validate ( ) : void	Performs validation on this config object. Throws exception if any of the required values are missing/invalid.
ValidateTimeout ( System.TimeSpan timeout ) : void

Protected Methods

Method	Description
Initialize ( ) : void

Private Methods

Method	Description
GetDefaultRegionEndpoint ( ) : RegionEndpoint
GetUrl ( RegionEndpoint regionEndpoint, string regionEndpointServiceName, bool useHttp, bool useDualStack ) : string

Method Details

ClientConfig() public method

public ClientConfig ( ) : System
return	System

DetermineServiceURL() public method

public DetermineServiceURL ( ) : string
return	string

GetTimeoutValue() public static method

Returns the request timeout value if its value is set, else returns client timeout value.

public static GetTimeoutValue ( System.TimeSpan clientTimeout, System.TimeSpan requestTimeout ) : TimeSpan?
clientTimeout	System.TimeSpan
requestTimeout	System.TimeSpan
return	TimeSpan?

GetWebProxy() public method

Returns a WebProxy instance configured to match the proxy settings in the client configuration.

public GetWebProxy ( ) : IWebProxy
return	IWebProxy

GetWebProxy() public method

Returns a WebProxy instance configured to match the proxy settings in the client configuration.

public GetWebProxy ( ) : WebProxy
return	System.Net.WebProxy

Initialize() protected method

protected Initialize ( ) : void
return	void

SetUseNagleIfAvailable() public method

Enable or disable the Nagle algorithm on the underlying http client. This method is not intended to be called by consumers of the AWS SDK for .NET

public SetUseNagleIfAvailable ( bool useNagle ) : void
useNagle	bool
return	void

SetWebProxy() public method

Unpacks the host, port and any credentials info into the instance's proxy-related fields. Unlike the SetWebProxy implementation on .NET 3.5/4.5,the Host and the Port are not reconstructed from the input proxyuri

public SetWebProxy ( IWebProxy proxy ) : void
proxy	IWebProxy	The proxy details
return	void

SetWebProxy() public method

Unpacks the host, port and any credentials info into the instance's proxy-related fields.

public SetWebProxy ( WebProxy proxy ) : void
proxy	System.Net.WebProxy	The proxy details
return	void

Validate() public method

Performs validation on this config object. Throws exception if any of the required values are missing/invalid.

public Validate ( ) : void
return	void

ValidateTimeout() public static method

public static ValidateTimeout ( System.TimeSpan timeout ) : void
timeout	System.TimeSpan
return	void

Property Details

MaxTimeout public static property

public static TimeSpan,System MaxTimeout
return	System.TimeSpan