Interface IProcess

Namespace

IceRpc.Ice

Assembly

IceRpc.Locator.dll

A server application managed by a locator implementation such as IceGrid hosts a Process object and registers a proxy to this object with the locator registry. See SetServerProcessProxyAsync(string, ProcessProxy?, IFeatureCollection?, CancellationToken).

public interface IProcess

Remarks

Use the methods of this interface to invoke operations on a remote Ice service that implements Process. The Ice compiler generated this client-side interface from Ice interface ::Ice::Process.

Methods

ShutdownAsync(IFeatureCollection?, CancellationToken)

Initiates a graceful shutdown of the server application.

Task ShutdownAsync(IFeatureCollection? features = null, CancellationToken cancellationToken = default)

Parameters

features IFeatureCollection

The features of this invocation.

cancellationToken CancellationToken

A cancellation token that receives the cancellation requests.

Returns

Task

A task that completes when the response is received.

Exceptions

DispatchException

Thrown when the dispatch of the operation failed. This exception is provided through the returned task; it's never thrown synchronously.

WriteMessageAsync(string, int, IFeatureCollection?, CancellationToken)

Writes a message on the server application's stdout or stderr.

Task WriteMessageAsync(string message, int fd, IFeatureCollection? features = null, CancellationToken cancellationToken = default)

Parameters

message string

The message to write.

fd int

1 for stdout, 2 for stderr.

features IFeatureCollection

The features of this invocation.

cancellationToken CancellationToken

A cancellation token that receives the cancellation requests.

Returns

Task

A task that completes when the response is received.

Exceptions

DispatchException

Thrown when the dispatch of the operation failed. This exception is provided through the returned task; it's never thrown synchronously.