SslStream.BeginAuthenticateAsClient Method (String, AsyncCallback, Object)

 

Called by clients to begin an asynchronous operation to authenticate the server and optionally the client.

Namespace:   System.Net.Security
Assembly:  System (in System.dll)

[HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)]
public virtual IAsyncResult BeginAuthenticateAsClient(
	string targetHost,
	AsyncCallback asyncCallback,
	object asyncState
)

Parameters

targetHost
Type: System.String

The name of the server that shares this SslStream.

asyncCallback
Type: System.AsyncCallback

An AsyncCallback delegate that references the method to invoke when the authentication is complete.

asyncState
Type: System.Object

A user-defined object that contains information about the operation. This object is passed to the asyncCallback delegate when the operation completes.

Return Value

Type: System.IAsyncResult

An IAsyncResult object that indicates the status of the asynchronous operation.

Exception Condition
ArgumentNullException

targetHost is null.

AuthenticationException

The authentication failed and left this object in an unusable state.

InvalidOperationException

Authentication has already occurred.

-or-

Server authentication using this SslStream was tried previously.

-or-

Authentication is already in progress.

ObjectDisposedException

This object has been closed.

This method authenticates using Default. No client certificates are used in the authentication. The certificate revocation list is not checked during authentication.

The value specified for targetHost must match the name on the server's certificate.

The asynchronous authentication operation must be completed by calling the EndAuthenticateAsClient method. Typically, the method is invoked by the asyncCallback delegate.

This method does not block while the operation completes. To block until the operation completes, use one of the AuthenticateAsClient method overloads.

For detailed information about using the asynchronous programming model, see Calling Synchronous Methods Asynchronously

If you receive a AuthenticationException, this SslStream is no longer useable. You should close this object and remove all references to it so that it can be collected by the garbage collector.

.NET Framework
Available since 2.0
Return to top
Show: