Class CommandConnection

Connection class for sending commands to the control server

Inheritance

object

BaseConnection

BaseCommandConnection

CommandConnection

Implements

IDisposable

Inherited Members

BaseCommandConnection.AddHttpEndpoint(HttpEndpointType, string, string, bool, int, CancellationToken)

BaseCommandConnection.AddUserSession(AccessLevel, SessionType, string, CancellationToken)

BaseCommandConnection.CheckPassword(string, CancellationToken)

BaseCommandConnection.EvaluateExpression<T>(string, CodeChannel, CancellationToken)

BaseCommandConnection.Flush(CodeChannel, CancellationToken)

BaseCommandConnection.GetFileInfo(string, CancellationToken)

BaseCommandConnection.GetFileInfo(string, bool, CancellationToken)

BaseCommandConnection.GetMachineModel(CancellationToken)

BaseCommandConnection.GetObjectModel(CancellationToken)

BaseCommandConnection.GetSerializedMachineModel(CancellationToken)

BaseCommandConnection.GetSerializedObjectModel(CancellationToken)

BaseCommandConnection.InstallPlugin(string, CancellationToken)

BaseCommandConnection.InstallSystemPackage(string, CancellationToken)

BaseCommandConnection.InvalidateChannel(CodeChannel, CancellationToken)

BaseCommandConnection.LockMachineModel(CancellationToken)

BaseCommandConnection.LockObjectModel(CancellationToken)

BaseCommandConnection.PatchMachineModel(string, object, CancellationToken)

BaseCommandConnection.PatchObjectModel(string, object, CancellationToken)

BaseCommandConnection.PatchObjectModel(string, JsonElement, CancellationToken)

BaseCommandConnection.PerformCode(Code, CancellationToken)

BaseCommandConnection.PerformSimpleCode(string, CodeChannel, CancellationToken)

BaseCommandConnection.PerformSimpleCode(string, CodeChannel, bool, CancellationToken)

BaseCommandConnection.ReloadPlugin(string, CancellationToken)

BaseCommandConnection.RemoveHttpEndpoint(HttpEndpointType, string, string, CancellationToken)

BaseCommandConnection.RemoveUserSession(int, CancellationToken)

BaseCommandConnection.ResolvePath(string, CancellationToken)

BaseCommandConnection.SetMachineModel(string, string, CancellationToken)

BaseCommandConnection.SetObjectModel(string, string, CancellationToken)

BaseCommandConnection.SetPluginData(string, object, string, CancellationToken)

BaseCommandConnection.SetPluginData(string, JsonElement, string, CancellationToken)

BaseCommandConnection.SetUpdateStatus(bool, CancellationToken)

BaseCommandConnection.StartPlugin(string, CancellationToken)

BaseCommandConnection.StopPlugin(string, CancellationToken)

BaseCommandConnection.SyncMachineModel(CancellationToken)

BaseCommandConnection.SyncObjectModel(CancellationToken)

BaseCommandConnection.UninstallPlugin(string, CancellationToken)

BaseCommandConnection.UninstallSystemPackage(string, CancellationToken)

BaseCommandConnection.UnlockMachineModel(CancellationToken)

BaseCommandConnection.WriteMessage(MessageType, string, bool, bool, CancellationToken)

BaseCommandConnection.WriteMessage(MessageType, string, bool, LogLevel?, CancellationToken)

BaseCommandConnection.WriteMessage(Message, bool, bool, CancellationToken)

BaseCommandConnection.WriteMessage(Message, bool, LogLevel, CancellationToken)

BaseConnection.Dispose()

BaseConnection.Id

BaseConnection.IsConnected

BaseConnection.Close()

BaseConnection.Poll()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: DuetAPIClient

Assembly: DuetAPIClient.dll

Syntax

public sealed class CommandConnection : BaseCommandConnection, IDisposable

Constructors

CommandConnection()

Create a new connection in command mode

Declaration

public CommandConnection()

Methods

Connect(string, CancellationToken)

Establish a connection to the given UNIX socket file

Declaration

public Task Connect(string socketPath = "/run/dsf/dcs.sock", CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	socketPath	Path to the UNIX socket file
CancellationToken	cancellationToken	Optional cancellation token

Returns

Type	Description
Task	Asynchronous task

Exceptions

Type	Condition
IncompatibleVersionException	API level is incompatible
IOException	Connection mode is unavailable
OperationCanceledException	Operation has been cancelled
SocketException	Init message could not be processed

SetNetworkProtocol(NetworkProtocol, bool, CancellationToken)

Update the status of a network protocol. Reserved for internal purposes, do not use

Declaration

public Task SetNetworkProtocol(NetworkProtocol protocol, bool enabled, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
NetworkProtocol	protocol	Protocol to update
bool	enabled	If it is enabled or not
CancellationToken	cancellationToken	Optional cancellation token

Returns

Type	Description
Task	Asynchronous task

Exceptions

Type	Condition
OperationCanceledException	Operation has been cancelled
SocketException	Command could not be processed

SetPluginProcess(string, int, CancellationToken)

Update the process id of a given plugin. Reserved for internal purposes, do not use

Declaration

public Task SetPluginProcess(string name, int pid, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	name	Name of the plugin
int	pid	New process id
CancellationToken	cancellationToken	Optional cancellation token

Returns

Type	Description
Task	Asynchronous task

Exceptions

Type	Condition
OperationCanceledException	Operation has been cancelled
SocketException	Command could not be processed

Implements

IDisposable

See Also

Command