Class CommandSession

Payload sent by a IPbmClient when interfacing with a Petabridge.Cmd host.

Inheritance

object

CommandSession

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Petabridge.Cmd.Common.Client

Assembly: Petabridge.Cmd.Common.dll

Syntax

public class CommandSession

Constructors

CommandSession(Source<CommandResponse, Task<Done>>, UniqueKillSwitch)

Declaration

public CommandSession(Source<CommandResponse, Task<Done>> stream, UniqueKillSwitch killSwitch)

Parameters

Type	Name	Description
Source<CommandResponse, Task<Done>>	stream
UniqueKillSwitch	killSwitch

Properties

KillSwitch

A kill switch that can be used to terminate this stream in the event that the client no longer wishes to receive any commands from the server.

Declaration

public UniqueKillSwitch KillSwitch { get; }

Property Value

Type	Description
UniqueKillSwitch

Stream

The set of results produced by the server.

The materialized Task will complete once the server has completed the response stream for this command instance.

Declaration

public Source<CommandResponse, Task<Done>> Stream { get; }

Property Value

Type	Description
Source<CommandResponse, Task<Done>>

Remarks

See https://getakka.net/articles/streams/modularitycomposition.html#materialized-values for details on Akka.Streams materialization