Show / Hide Table of Contents

    Class CommandSession

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

    Inheritance
    System.Object
    CommandSession
    Inherited Members
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Petabridge.Cmd.Common.Client
    Assembly: cs.temp.dll.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 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

    Back to top Generated by DocFX