[This is preliminary documentation and is subject to change.]
The Service type exposes the following members.Constructors
Name | Description | |
---|---|---|
![]() | Service | Initializes a new instance of the Service class |
![]() | Service(Object) | Initializes a new instance of the Service class |
Methods
Name | Description | |
---|---|---|
![]() | ____ObtainPrivateServiceStatusLockObject |
WARNING: Developers never call this method!!!
It is used by advanced derived implementations that need to synchronize status updates.
We do not want to make statuslock protected as it is almost never needed, hence this accessor
|
![]() | __setComponentDirector | (Inherited from ApplicationComponent.) |
![]() | AbortStart |
Allows to abort unsuccessful DoStart() overridden implementation.
This method must be called from within DoStart()
|
![]() | AcceptManagerVisit |
Accepts a visit of a manager entity - this call is useful for periodic updates of service status,
i.e. when service does not have a thread of its own it can be periodically managed by some other service through this method.
The default implementation of DoAcceptManagerVisit(object, DateTime) does nothing
|
![]() | CheckForCompleteStop |
Non-blocking call that returns true when the service instance has completely stopped after SignalStop()
|
![]() | CheckServiceActive |
Checks for service activity and throws exception if service is not in ControlStatus.Active state
|
![]() | CheckServiceActiveOrStarting |
Checks for service activity and throws exception if service is not in ControlStatus.Active state
|
![]() | CheckServiceInactive |
Checks for service inactivity and throws exception if service is running (started, starting or stopping)
|
![]() | Configure |
Configures service from configuration node (and possibly it's sub-nodes)
|
![]() | Destructor | (Overrides ApplicationComponent Destructor .) |
![]() | Dispose |
Deterministically disposes object. DO NOT OVERRIDE this method, override Destructor() instead
(Inherited from DisposableObject.) |
![]() | DoAcceptManagerVisit |
Accepts a visit from external manager. Base implementation does nothing.
Override in services that need external management calls
to update their state periodically, i.e. when they don't have a thread on their own
|
![]() | DoCheckForCompleteStop |
Provides implementation for checking whether the service has completely stopped
|
![]() | DoConfigure |
Provides implementation that configures service from configuration node (and possibly it's sub-nodes)
|
![]() | DoSignalStop |
Provides implementation that signals service to stop. This is expected not to block
|
![]() | DoStart |
Provides implementation that starts the service
|
![]() | DoWaitForCompleteStop |
Provides implementation for a blocking call that returns only after a complete service stop
|
![]() | EnsureObjectNotDisposed |
Checks to see whether object dispose started or has already been disposed and throws an exception if Dispose() was called
(Inherited from DisposableObject.) |
![]() | ![]() | Determines whether the specified object is equal to the current object. (Inherited from ![]() |
![]() | Finalize | (Inherited from DisposableObject.) |
![]() | ![]() | Serves as the default hash function. (Inherited from ![]() |
![]() | ![]() | Gets the (Inherited from ![]() ![]() |
![]() | LocalizedTimeToUniversalTime |
Converts localized time to UTC time as of TimeLocation property
|
![]() | ![]() | Creates a shallow copy of the current (Inherited from ![]() ![]() |
![]() | SignalStop |
Non-blocking call that initiates the stopping of the service
|
![]() | Start |
Blocking call that starts the service instance
|
![]() | StartByApplication |
Blocking call that starts the service instance
|
![]() | ![]() | Returns a string that represents the current object. (Inherited from ![]() |
![]() | UniversalTimeToLocalizedTime |
Converts universal time to local time as of TimeLocation property
|
![]() | WaitForCompleteStop |
Blocks execution of current thread until this service has completely stopped
|
Extension Methods
Fields
Name | Description | |
---|---|---|
![]() ![]() | CONFIG_NAME_ATTR |
Properties
Name | Description | |
---|---|---|
![]() | ApplicationDontAutoStartService |
Checks whether the class is decorated with ApplicationDontAutoStartServiceAttribute
|
![]() | ComponentCommonName |
Returns the common name used to identify the component, for example "Glue" for various IGlue implementations.
This name is searched-by some management tools that allow to find component by this name that does not change between
application restarts like ComponentSID does. Subordinate (non-root) components return null
(Inherited from ApplicationComponent.) |
![]() | ComponentDirector |
Returns a reference to an object that this app component services/operates under, or null
(Inherited from ApplicationComponent.) |
![]() | ComponentSID |
Returns process/instance unique app component system id
(Inherited from ApplicationComponent.) |
![]() | ComponentStartTime |
Returns local computer time of component start (not from application container time)
(Inherited from ApplicationComponent.) |
![]() | Disposed |
Indicates whether this object was already disposed - the Dispose() has finished
(Inherited from DisposableObject.) |
![]() | DisposeStarted |
Indicates whether this object Dispose() has been called and dispose started but not finished yet
(Inherited from DisposableObject.) |
![]() | LocalizedTime |
Returns current time localized per TimeLocation
|
![]() | Name |
Provides textual name for the service
|
![]() | Running |
Returns true when service is active or about to become active.
Check in service implementation loops/threads/tasks
|
![]() | Status |
Current service status
|
![]() | TimeLocation |
Returns time location of this LocalizedTimeProvider implementation
|
See Also