Class MachiningProjectGrpcServer

Namespace

HiNc.Grpcs

Assembly

HiNc.dll

Server for exposing machining project functionality via gRPC.

public class MachiningProjectGrpcServer : IDisposable, IMakeXmlSource

Inheritance

object

MachiningProjectGrpcServer

Implements

IDisposable

IMakeXmlSource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])

InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)

InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)

ColorUtil.GetGloomyColor(object, double, double)

NameUtil.GetSelectionName(object)

StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)

LockUtil.Lock(object)

Constructors

MachiningProjectGrpcServer(MachiningProject)

Initializes a new instance of the MachiningProjectGrpcServer class.

public MachiningProjectGrpcServer(MachiningProject millingCourse)

Parameters

millingCourse MachiningProject

The machining project to expose via gRPC

MachiningProjectGrpcServer(XElement, MachiningProject)

Initializes a new instance of the MachiningProjectGrpcServer class from XML.

public MachiningProjectGrpcServer(XElement src, MachiningProject millingCourse)

Parameters

src XElement

XML source element

millingCourse MachiningProject

The machining project to expose via gRPC

Properties

IsServiceRunning

Gets whether the service is currently running.

public bool IsServiceRunning { get; }

Property Value

bool

ServicePort

Gets or sets the port used by the gRPC service.

public int ServicePort { get; set; }

Property Value

int

WebApplication

Gets the web application instance for the gRPC server.

public WebApplication WebApplication { get; }

Property Value

WebApplication

XName

Name for XML IO.

public static string XName { get; }

Property Value

string

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

Dispose(bool)

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

MakeXmlSource(string, string)

Creates an XML representation of the object. This method may also generate additional resources such as related files.

public XElement MakeXmlSource(string baseDirectory, string relFile)

Parameters

baseDirectory string

The base directory for resolving relative paths

relFile string

The relative file path for the XML source

Returns

XElement

An XML element representing the object's state

Remarks

For the demand of easy moving source folder (especially project folder) without configuration file path corruption, the relative file path is applied. The baseDirectory is typically the folder at the nearest configuration file folder. Since the folder can be moving with the configuration file.

StartAsync()

Starts the gRPC server asynchronously.

public Task StartAsync()

Returns

Task

A task representing the asynchronous operation

StopAsync()

Stops the gRPC server asynchronously.

public Task StopAsync()

Returns

Task

A task representing the asynchronous operation