[This is preliminary documentation and is subject to change.]
The Transport type exposes the following members.Constructors
Name | Description | |
---|---|---|
![]() | Transport | Initializes a new instance of the Transport 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
(Inherited from Service.) |
![]() | __setComponentDirector | (Inherited from ApplicationComponent.) |
![]() | AbortStart |
Allows to abort unsuccessful DoStart() overridden implementation.
This method must be called from within DoStart()
(Inherited from Service.) |
![]() | 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
(Inherited from Service.) |
![]() | CheckForCompleteStop |
Non-blocking call that returns true when the service instance has completely stopped after SignalStop()
(Inherited from Service.) |
![]() | CheckRunningState |
Ensures that application and transport instance are running or throws otherwise
|
![]() | CheckServiceActive |
Checks for service activity and throws exception if service is not in ControlStatus.Active state
(Inherited from Service.) |
![]() | CheckServiceActiveOrStarting |
Checks for service activity and throws exception if service is not in ControlStatus.Active state
(Inherited from Service.) |
![]() | CheckServiceInactive |
Checks for service inactivity and throws exception if service is running (started, starting or stopping)
(Inherited from Service.) |
![]() | Configure |
Configures service from configuration node (and possibly it's sub-nodes)
(Inherited from Service.) |
![]() | Destructor | (Overrides Service 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
(Inherited from Service.) |
![]() | DoCheckForCompleteStop |
Provides implementation for checking whether the service has completely stopped
(Inherited from Service.) |
![]() | DoConfigure |
Provides implementation that configures service from configuration node (and possibly it's sub-nodes)
(Inherited from Service.) |
![]() | DoDumpInstrumentationData |
Override to dump instrumentation data, dont forget to call base to dump basic metrics
|
![]() | DoSignalStop |
Provides implementation that signals service to stop. This is expected not to block
(Inherited from Service.) |
![]() | DoStart | (Overrides Service DoStart .) |
![]() | DoWaitForCompleteStop |
Provides implementation for a blocking call that returns only after a complete service stop
(Inherited from Service.) |
![]() | DumpInstrumentationData |
Dumps instrumentation data
|
![]() | 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
(Inherited from Service.) |
![]() | ![]() | Creates a shallow copy of the current (Inherited from ![]() ![]() |
![]() | Release |
Releases transport by setting Acquired flag to false so it can be used by other operations
|
![]() | ResetStats |
Resets all statistical counters
|
![]() | SignalStop |
Non-blocking call that initiates the stopping of the service
(Inherited from Service.) |
![]() | Start |
Blocking call that starts the service instance
(Inherited from Service.) |
![]() | StartByApplication |
Blocking call that starts the service instance
(Inherited from Service.) |
![]() | stat_BytesReceived | |
![]() | stat_BytesSent | |
![]() | stat_Errors | |
![]() | stat_MsgReceived | |
![]() | stat_MsgSent | |
![]() | stat_Time |
Processes named time measurement statistical sample by using EMA filter
|
![]() | ![]() | Returns a string that represents the current object. (Inherited from ![]() |
![]() | TryAcquire |
A thread-safe operation that tries to acquire(reserve) this instance for exclusive use.
Returns true if acqusition succeded, false is this instance is reserved by someone else
|
![]() | UniversalTimeToLocalizedTime |
Converts universal time to local time as of TimeLocation property
(Inherited from Service.) |
![]() | WaitForCompleteStop |
Blocks execution of current thread until this service has completely stopped
(Inherited from Service.) |
Extension Methods
Fields
Name | Description | |
---|---|---|
![]() | m_TransportKind |
Properties
Name | Description | |
---|---|---|
![]() | Acquired |
Returns true when this transport instance has been acquired by some operation and is busy
|
![]() | ApplicationDontAutoStartService |
Checks whether the class is decorated with ApplicationDontAutoStartServiceAttribute
(Inherited from Service.) |
![]() | Binding |
Returns a binding that this transport operates under
|
![]() | 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 | (Inherited from Service TDirector .) |
![]() | 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.) |
![]() | ExpirationStart |
Returns timestamp when manager touched the instance for last time and no traffic went through it since
|
![]() | Glue |
Returns glue implementation that this transport is under
|
![]() | IdleAgeMs |
Returns the duration of transport idle period in ms.
|
![]() | LocalizedTime |
Returns current time localized per TimeLocation
(Inherited from Service.) |
![]() | Name |
Provides textual name for the service
(Inherited from Service.) |
![]() | Node |
Returns node that this transport services
|
![]() | Running |
Returns true when service is active or about to become active.
Check in service implementation loops/threads/tasks
(Inherited from Service.) |
![]() | StatBytesReceived |
Returns how many bytes were received since .ctor or last ResetStats() call
|
![]() | StatBytesSent |
Returns how many bytes were sent since .ctor or last ResetStats() call
|
![]() | StatErrors |
Returns how many message processing errors happened since .ctor or last ResetStats() call
|
![]() | StatMsgReceived |
Returns how many messages were received since .ctor or last ResetStats() call
|
![]() | StatMsgSent |
Returns how many messages were sent since .ctor or last ResetStats() call
|
![]() | StatTimes |
Returns enumerable of named times measured in double second fractions.
The returned times are EMA-filtered from supplied individual measurement samples
|
![]() | Status |
Current service status
(Inherited from Service.) |
![]() | TimeLocation |
Returns time location of this LocalizedTimeProvider implementation
(Inherited from Service.) |
![]() | TransportKind |
Reports if this is a server or client transport
|
See Also