implab/ImplabNet Files · Implab/ICancellationToken.cs

docs

cin - - Load All Authors

File last commit:

r145:706fccb85524 v2


                r154:2dcdee4c0810

Download file

             ICancellationToken.cs
        
                    36 lines
            
             | 1.2 KiB
            
                | text/x-csharp
            
             |
                CSharpLexer
            
             / Implab / ICancellationToken.cs
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      using System;

      namespace Implab {

          public interface ICancellationToken {

              /// <summary>

              /// Indicates wherther the cancellation was requested.

              /// </summary>

              bool IsCancellationRequested { get ; }

              /// <summary>

              /// The reason why the operation should be cancelled.

              /// </summary>

              Exception CancellationReason { get ; }

              /// <summary>

              /// Accepts if requested.

              /// </summary>

              /// <returns><c>true</c>, if if requested was accepted, <c>false</c> otherwise.</returns>

              bool CancelOperationIfRequested();

              /// <summary>

              /// Sets the token to cancelled state.

              /// </summary>

              /// <param name="reason">The reason why the operation was cancelled.</param>

              void CancelOperation(Exception reason);

              /// <summary>

              /// Adds the listener for the cancellation request, is the cancellation was requested the <paramref name="handler"/>

              /// is executed immediatelly.

              /// </summary>

              /// <param name="handler">The handler which will be executed if the cancel occurs.</param>

              void CancellationRequested(Action<Exception> handler);

          }

      }

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

				using System;

				namespace Implab {
				public interface ICancellationToken {
				/// <summary>
				/// Indicates wherther the cancellation was requested.
				/// </summary>
				bool IsCancellationRequested { get ; }

				/// <summary>
				/// The reason why the operation should be cancelled.
				/// </summary>
				Exception CancellationReason { get ; }

				/// <summary>
				/// Accepts if requested.
				/// </summary>
				/// <returns><c>true</c>, if if requested was accepted, <c>false</c> otherwise.</returns>
				bool CancelOperationIfRequested();

				/// <summary>
				/// Sets the token to cancelled state.
				/// </summary>
				/// <param name="reason">The reason why the operation was cancelled.</param>
				void CancelOperation(Exception reason);

				/// <summary>
				/// Adds the listener for the cancellation request, is the cancellation was requested the <paramref name="handler"/>
				/// is executed immediatelly.
				/// </summary>
				/// <param name="handler">The handler which will be executed if the cancel occurs.</param>
				void CancellationRequested(Action<Exception> handler);

				}
				}