26.288. Class GrpcEventsService

Namespace: ArmoniK.Core.Common.gRPC.Services
Assembly: ArmoniK.Core.Common.dll

Service for subscribing to events representing modifications to ArmoniK result and task data

[Authorize(AuthenticationSchemes = "ArmoniKAuthenticationScheme")]
public class GrpcEventsService : Events.EventsBase

26.288.1. Inheritance

object ← Events.EventsBase ← GrpcEventsService

26.288.2. Inherited Members

Events.EventsBase.GetEvents(EventSubscriptionRequest, IServerStreamWriter<EventSubscriptionResponse>, ServerCallContext), object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()

26.288.3. Constructors

26.288.3.1. GrpcEventsService(ITaskTable, ITaskWatcher, IResultTable, IResultWatcher, FunctionExecutionMetrics<GrpcEventsService>, ILogger<GrpcEventsService>)

Initializes a new instance of the class.

public GrpcEventsService(ITaskTable taskTable, ITaskWatcher taskWatcher, IResultTable resultTable, IResultWatcher resultWatcher, FunctionExecutionMetrics<GrpcEventsService> meter, ILogger<GrpcEventsService> logger)

26.288.3.1.1. Parameters

taskTable ITaskTable

The task table for managing tasks.

taskWatcher ITaskWatcher

The task watcher for monitoring task events.

resultTable IResultTable

The result table for managing results.

resultWatcher IResultWatcher

The result watcher for monitoring result events.

meter FunctionExecutionMetrics<GrpcEventsService>

The metrics for function execution.

logger ILogger<GrpcEventsService>

The logger for logging information.

26.288.4. Methods

26.288.4.1. GetEvents(EventSubscriptionRequest, IServerStreamWriter<EventSubscriptionResponse>, ServerCallContext)

Get events that represents updates of result and tasks data.

[RequiresPermission(typeof(GrpcEventsService), "GetEvents")]
public override Task GetEvents(EventSubscriptionRequest request, IServerStreamWriter<EventSubscriptionResponse> responseStream, ServerCallContext context)

26.288.4.1.1. Parameters

request EventSubscriptionRequest

The request received from the client.

responseStream IServerStreamWriter<EventSubscriptionResponse>

Used for sending responses back to the client.

context ServerCallContext

The context of the server-side call handler being invoked.

26.288.4.1.2. Returns

Task

A task indicating completion of the handler.