implab/ImplabNet Files · Implab/src/Components/IInitializable.cs

Closing branch: `v3`

cin - - Load All Authors

File last commit:

r289:95896f882995 v3.0.14 v3


                r293:bb6f69f90c6c

Download file

             IInitializable.cs
        
                    30 lines
            
             | 1.3 KiB
            
                | text/x-csharp
            
             |
                CSharpLexer
            
             / Implab / src / Components / IInitializable.cs
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      using System;

      using System.Threading;

      namespace Implab.Components {

          /// <summary>

          /// Initializable components are created and initialized in two steps, first we have create the component,

          /// then we have to complete it's creation by calling an <see cref="Initialize()"/> method. All parameters needed

          /// to complete the initialization must be passed before the calling <see cref="Initialize()"/>

          /// </summary>

          public interface IInitializable {

              /// <summary>

              /// Completes initialization.

              /// </summary>

              /// <remarks>

              /// <para>

              /// Normally virtual methods shouldn't be called from the constructor, due to the incomplete object state, but

              /// they can be called from this method. This method is also usefull when we constructing a complex grpah

              /// of components where cyclic references may take place.

              /// </para>

              /// <para>

              /// In asyncronous patterns <see cref="Initialize()"/> can be called

              /// to start initialization and the <see cref="IRunnable.Completion"/>

              /// property can be used to track operation completion.

              /// </para>

              /// </remarks>

              void Initialize();

              void Initialize(CancellationToken ct);

          }

      }

	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;
				using System.Threading;

				namespace Implab.Components {
				/// <summary>
				/// Initializable components are created and initialized in two steps, first we have create the component,
				/// then we have to complete it's creation by calling an <see cref="Initialize()"/> method. All parameters needed
				/// to complete the initialization must be passed before the calling <see cref="Initialize()"/>
				/// </summary>
				public interface IInitializable {
				/// <summary>
				/// Completes initialization.
				/// </summary>
				/// <remarks>
				/// <para>
				/// Normally virtual methods shouldn't be called from the constructor, due to the incomplete object state, but
				/// they can be called from this method. This method is also usefull when we constructing a complex grpah
				/// of components where cyclic references may take place.
				/// </para>
				/// <para>
				/// In asyncronous patterns <see cref="Initialize()"/> can be called
				/// to start initialization and the <see cref="IRunnable.Completion"/>
				/// property can be used to track operation completion.
				/// </para>
				/// </remarks>
				void Initialize();
				void Initialize(CancellationToken ct);
				}
				}