Class PlotterProxy

Namespace

chia.dotnet

Assembly

chia-dotnet.dll

Class to manage plotting

public sealed class PlotterProxy : ServiceProxy, IServiceProxy

Inheritance

object

ServiceProxy

PlotterProxy

Implements

IServiceProxy

Inherited Members

ServiceProxy.IsEventSource

ServiceProxy.ConnectionsChanged

ServiceProxy.ConnectionAdded

ServiceProxy.ConnectionClosed

ServiceProxy.UnrecognizedEvent

ServiceProxy.OriginService

ServiceProxy.DestinationService

ServiceProxy.RpcClient

ServiceProxy.HealthZ(CancellationToken)

ServiceProxy.StopNode(CancellationToken)

ServiceProxy.GetConnections(CancellationToken)

ServiceProxy.GetRoutes(CancellationToken)

ServiceProxy.OpenConnection(string, int, CancellationToken)

ServiceProxy.CloseConnection(string, CancellationToken)

ServiceProxy.GetNetworkInfo(CancellationToken)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

Converters.ToJson(object)

Remarks

ctor

Constructors

PlotterProxy(WebSocketRpcClient, string)

Class to manage plotting

public PlotterProxy(WebSocketRpcClient rpcClient, string originService)

Parameters

rpcClient WebSocketRpcClient

IRpcClient instance to use for rpc communication

originService string

Origin

Remarks

ctor

Methods

GetKeysForPlotting(IEnumerable<uint>?, CancellationToken)

Returns the list of plotting keys.

public Task<IDictionary<uint, PlottingKeys>> GetKeysForPlotting(IEnumerable<uint>? fingerprints = null, CancellationToken cancellationToken = default)

Parameters

fingerprints IEnumerable<uint>

cancellationToken CancellationToken

A token to allow the call to be cancelled

Returns

Task<IDictionary<uint, PlottingKeys>>

A dictionary of fingerprints and PlottingKeys

GetPlotters(CancellationToken)

Get info about installed and installable plotters

public Task<IDictionary<string, PlotterInfo>> GetPlotters(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to allow the call to be cancelled

Returns

Task<IDictionary<string, PlotterInfo>>

Dictionary of supported plotters

RegisterPlotter(CancellationToken)

Registers this instance as a plotter and retrieves the plot queue

public Task<IEnumerable<QueuedPlotInfo>> RegisterPlotter(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A token to allow the call to be cancelled

Returns

Task<IEnumerable<QueuedPlotInfo>>

The list of QueuedPlotInfos

StartPlotting(PlotterConfig, CancellationToken)

Starts plotting. Returns after plot is added to the plotting queue. Does not wait for plot to finish

public Task<IEnumerable<string>> StartPlotting(PlotterConfig config, CancellationToken cancellationToken = default)

Parameters

config PlotterConfig

The config of the plot. Maps 1:1 to the chia plot create command line

cancellationToken CancellationToken

A token to allow the call to be cancelled

Returns

Task<IEnumerable<string>>

An awaitable Task

StopPlotting(string, CancellationToken)

Stops the plot with the given id

public Task StopPlotting(string id, CancellationToken cancellationToken = default)

Parameters

id string

The id of the plot to stop. Can be found by inspecting the plot queue returned from RegisterPlotter(CancellationToken)

cancellationToken CancellationToken

A token to allow the call to be cancelled

Returns

Task

An awaitable Task