SecurityTokenProvider.BeginCancelToken Method

Definition

Namespace:

System.IdentityModel.Selectors

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v6.2.0

Source:

SecurityTokenProvider.cs

Begins an asynchronous operation to cancel a security token.

public:
 IAsyncResult ^ BeginCancelToken(TimeSpan timeout, System::IdentityModel::Tokens::SecurityToken ^ token, AsyncCallback ^ callback, System::Object ^ state);

public IAsyncResult BeginCancelToken (TimeSpan timeout, System.IdentityModel.Tokens.SecurityToken token, AsyncCallback callback, object state);

member this.BeginCancelToken : TimeSpan * System.IdentityModel.Tokens.SecurityToken * AsyncCallback * obj -> IAsyncResult

Public Function BeginCancelToken (timeout As TimeSpan, token As SecurityToken, callback As AsyncCallback, state As Object) As IAsyncResult

Parameters

timeout

TimeSpan

A TimeSpan that specifies the timeout value for the message that cancels the security token.

token

SecurityToken

The SecurityToken to cancel.

callback

AsyncCallback

The AsyncCallback delegate that receives notification of the completion of the asynchronous close operation.

state

Object

An object, specified by the application, that contains state information associated with the asynchronous close operation.

Returns

IAsyncResult

The IAsyncResult that references the asynchronous cancel operation.

Remarks

A security token that can be cancelled, such as one that is issued, allows a client that requested a security token to cancel it when it is done with it.

Notes to Inheritors

The BeginCancelTokenCore(TimeSpan, SecurityToken, AsyncCallback, Object) method is called by the BeginCancelToken(TimeSpan, SecurityToken, AsyncCallback, Object) method.

The asynchronous methods, which have a prefix of Begin and End, do not need to be overridden in derived classes. The SecurityTokenProvider base class provides an asynchronous implementation that is based on the synchronous methods.