ShutdownServerTool

Definition

Assembly: Microsoft.OData.Mcp.Tools.dll Namespace: Microsoft.OData.Mcp.Tools.Hosting Inheritance: System.Object

Syntax

Microsoft.OData.Mcp.Tools.Hosting.ShutdownServerTool

Summary

Local-only control-plane tool that cancels the host lifetime after an optional delay.

Constructors

.ctor

Initializes a new instance of the ShutdownServerTool class.

Syntax

public ShutdownServerTool(System.Threading.CancellationTokenSource lifetime)

Parameters

Name	Type	Description
`lifetime`	`System.Threading.CancellationTokenSource`	The host lifetime source to cancel.

.ctor Inherited

Inherited from object

Syntax

public Object()

Methods

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

Name	Type	Description
`obj`	`object?`	-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

InvokeAsync

Acknowledges shutdown and cancels the host after delaySeconds.

Syntax

public System.Threading.Tasks.Task<string> InvokeAsync(string reason, int delaySeconds, System.Threading.CancellationToken cancellationToken)

Parameters

Name	Type	Description
`reason`	`string?`	The reason recorded in the acknowledgement.
`delaySeconds`	`int`	Delay between 0 and 10 seconds. Zero cancels immediately.
`cancellationToken`	`System.Threading.CancellationToken`	The cancellation token.

Returns

Type: System.Threading.Tasks.Task<string> JSON acknowledgement text.

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?

​Definition

​Syntax

​Summary

​Constructors

​ .ctor

​Syntax

​Parameters

​ .ctor Inherited

​Syntax

​Methods

​ Equals Inherited Virtual

​Syntax

​Parameters

​Returns

​ Equals Inherited

​Syntax

​Parameters

​Returns

​ GetHashCode Inherited Virtual

​Syntax

​Returns

​ GetType Inherited

​Syntax

​Returns

​ InvokeAsync

​Syntax

​Parameters

​Returns

​ MemberwiseClone Inherited

​Syntax

​Returns

​ ReferenceEquals Inherited

​Syntax

​Parameters

​Returns

​ ToString Inherited Virtual

​Syntax

​Returns

Definition

Syntax

Summary

Constructors

.ctor

Syntax

Parameters

.ctor Inherited

Syntax

Methods

Equals Inherited Virtual

Syntax

Parameters

Returns

Equals Inherited

Syntax

Parameters

Returns

GetHashCode Inherited Virtual

Syntax

Returns

GetType Inherited

Syntax

Returns

InvokeAsync

Syntax

Parameters

Returns

MemberwiseClone Inherited

Syntax

Returns

ReferenceEquals Inherited

Syntax

Parameters

Returns

ToString Inherited Virtual

Syntax

Returns