Class InstallerChannel

Message channel between applications and installer.

Inheritance
Object
BaseLogSource
BaseLogReceiver
InstallerChannel
Implements
Ecng.Serialization.IPersistable
Inherited Members
Namespace: StockSharp.Installer.IPC
Assembly: StockSharp.Installer.IPC.dll
Syntax
public class InstallerChannel : BaseLogReceiver, IPersistable, ILogReceiver, ILogSource, IDisposable

Constructors

InstallerChannel(Int64, IInstallerChannelHandler)

Создать объект.

Declaration
public InstallerChannel(long productId, IInstallerChannelHandler handler = null)
Parameters
Type Name Description
Int64 productId

This product.
IInstallerChannelHandler handler

Incoming message handler. Can be null so IncomingMessage event is used.

Fields

ProductIdInstallerConsole

Special product id for Installer.Console. (no such product in db)

Declaration
public static readonly long ProductIdInstallerConsole
Field Value
Type Description
Int64

Methods

DisposeManaged()

Declaration
protected override void DisposeManaged()

GetResponse(InstallerMessage, Int64)

Send message and get respons synchronously.

Declaration
public InstallerMessage GetResponse(InstallerMessage message, long toProductId)
Parameters
Type Name Description
InstallerMessage message
Int64 toProductId
Returns
Type Description
InstallerMessage

GetResponseAsync(InstallerMessage, Int64, CancellationToken)

Send message and get response asynchonously.

Declaration
public Task<InstallerMessage> GetResponseAsync(InstallerMessage message, long toProductId, CancellationToken token)
Parameters
Type Name Description
InstallerMessage message
Int64 toProductId
CancellationToken token
Returns
Type Description
Task<InstallerMessage>
Exceptions
Type Condition
ArgumentNullException

SendResponse(InstallerMessage, InstallerMessage)

Send response for particular request.

Declaration
public void SendResponse(InstallerMessage requestMessage, InstallerMessage response)
Parameters
Type Name Description
InstallerMessage requestMessage
InstallerMessage response

SendResponseAsync(InstallerMessage, InstallerMessage, CancellationToken)

Send response asynchronously.

Declaration
public Task SendResponseAsync(InstallerMessage requestMessage, InstallerMessage response, CancellationToken token)
Parameters
Type Name Description
InstallerMessage requestMessage
InstallerMessage response
CancellationToken token
Returns
Type Description
Task

StartServer()

Start channel server.

Declaration
public void StartServer()
Exceptions
Type Condition
InvalidOperationException

Events

IncomingMessage

Incoming message event. This event is used only if the object was created without IInstallerChannelHandler. if this event is used, application must use SendResponse(InstallerMessage, InstallerMessage) or SendResponseAsync(InstallerMessage, InstallerMessage, CancellationToken) to send response messages.

Declaration
public event Action<InstallerMessage> IncomingMessage
Event Type
Type Description
Action<InstallerMessage>

Implements

Ecng.Serialization.IPersistable

Extension Methods