Package mxaccess_gateway.v1

Interface MxAccessGatewayGrpc.AsyncService

All Known Implementing Classes:

MxAccessGatewayGrpc.MxAccessGatewayImplBase

Enclosing class:

MxAccessGatewayGrpc

public static interface MxAccessGatewayGrpc.AsyncService

 Public client API for MXAccess sessions hosted by the gateway.
 

Method Summary

Modifier and Type	Method	Description
default void	acknowledgeAlarm(MxaccessGateway.AcknowledgeAlarmRequest request, io.grpc.stub.StreamObserver<MxaccessGateway.AcknowledgeAlarmReply> responseObserver)
default void	closeSession(MxaccessGateway.CloseSessionRequest request, io.grpc.stub.StreamObserver<MxaccessGateway.CloseSessionReply> responseObserver)
default void	invoke(MxaccessGateway.MxCommandRequest request, io.grpc.stub.StreamObserver<MxaccessGateway.MxCommandReply> responseObserver)
default void	openSession(MxaccessGateway.OpenSessionRequest request, io.grpc.stub.StreamObserver<MxaccessGateway.OpenSessionReply> responseObserver)
default void	queryActiveAlarms(MxaccessGateway.QueryActiveAlarmsRequest request, io.grpc.stub.StreamObserver<MxaccessGateway.ActiveAlarmSnapshot> responseObserver)	Point-in-time snapshot of the currently-active alarm set served from the gateway's always-on alarm monitor cache (session-less).
default void	streamAlarms(MxaccessGateway.StreamAlarmsRequest request, io.grpc.stub.StreamObserver<MxaccessGateway.AlarmFeedMessage> responseObserver)	Session-less central alarm feed.
default void	streamEvents(MxaccessGateway.StreamEventsRequest request, io.grpc.stub.StreamObserver<MxaccessGateway.MxEvent> responseObserver)

Method Details

openSession

default void openSession(MxaccessGateway.OpenSessionRequest request,
 io.grpc.stub.StreamObserver<MxaccessGateway.OpenSessionReply> responseObserver)

closeSession

default void closeSession(MxaccessGateway.CloseSessionRequest request,
 io.grpc.stub.StreamObserver<MxaccessGateway.CloseSessionReply> responseObserver)

invoke

default void invoke(MxaccessGateway.MxCommandRequest request,
 io.grpc.stub.StreamObserver<MxaccessGateway.MxCommandReply> responseObserver)

streamEvents

default void streamEvents(MxaccessGateway.StreamEventsRequest request,
 io.grpc.stub.StreamObserver<MxaccessGateway.MxEvent> responseObserver)

acknowledgeAlarm

default void acknowledgeAlarm(MxaccessGateway.AcknowledgeAlarmRequest request,
 io.grpc.stub.StreamObserver<MxaccessGateway.AcknowledgeAlarmReply> responseObserver)

streamAlarms

default void streamAlarms(MxaccessGateway.StreamAlarmsRequest request,
 io.grpc.stub.StreamObserver<MxaccessGateway.AlarmFeedMessage> responseObserver)

 Session-less central alarm feed. The stream opens with the current
 active-alarm snapshot (one `active_alarm` per alarm), then a single
 `snapshot_complete`, then a `transition` for every subsequent change.
 Served by the gateway's always-on alarm monitor; any number of clients
 fan out from the single monitor without opening a worker session.
 

queryActiveAlarms

default void queryActiveAlarms(MxaccessGateway.QueryActiveAlarmsRequest request,
 io.grpc.stub.StreamObserver<MxaccessGateway.ActiveAlarmSnapshot> responseObserver)

 Point-in-time snapshot of the currently-active alarm set served from the
 gateway's always-on alarm monitor cache (session-less). Used after a
 reconnect to seed Part 9 client state, or to reconcile alarms that may
 have been missed during a transport blip. Streamed so callers can
 begin processing without buffering the full set.
 `QueryActiveAlarmsRequest.alarm_filter_prefix` optionally narrows the
 snapshot to alarms whose `alarm_full_reference` starts with the given
 prefix; an empty prefix returns the full set.