Package mxaccess_gateway.v1

Class MxAccessGatewayGrpc.MxAccessGatewayBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<MxAccessGatewayGrpc.MxAccessGatewayBlockingStub>

io.grpc.stub.AbstractBlockingStub<MxAccessGatewayGrpc.MxAccessGatewayBlockingStub>

mxaccess_gateway.v1.MxAccessGatewayGrpc.MxAccessGatewayBlockingStub

Enclosing class:

MxAccessGatewayGrpc

public static final class MxAccessGatewayGrpc.MxAccessGatewayBlockingStub
extends io.grpc.stub.AbstractBlockingStub<MxAccessGatewayGrpc.MxAccessGatewayBlockingStub>

A stub to allow clients to do limited synchronous rpc calls to service MxAccessGateway.

 Public client API for MXAccess sessions hosted by the gateway.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

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

Methods inherited from class io.grpc.stub.AbstractBlockingStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOnReadyThreshold, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

build

protected MxAccessGatewayGrpc.MxAccessGatewayBlockingStub build(io.grpc.Channel channel,
 io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<MxAccessGatewayGrpc.MxAccessGatewayBlockingStub>

openSession

public MxaccessGateway.OpenSessionReply openSession(MxaccessGateway.OpenSessionRequest request)

closeSession

public MxaccessGateway.CloseSessionReply closeSession(MxaccessGateway.CloseSessionRequest request)

invoke

public MxaccessGateway.MxCommandReply invoke(MxaccessGateway.MxCommandRequest request)

streamEvents

public Iterator<MxaccessGateway.MxEvent> streamEvents(MxaccessGateway.StreamEventsRequest request)

acknowledgeAlarm

public MxaccessGateway.AcknowledgeAlarmReply acknowledgeAlarm(MxaccessGateway.AcknowledgeAlarmRequest request)

streamAlarms

public Iterator<MxaccessGateway.AlarmFeedMessage> streamAlarms(MxaccessGateway.StreamAlarmsRequest request)

 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

public Iterator<MxaccessGateway.ActiveAlarmSnapshot> queryActiveAlarms(MxaccessGateway.QueryActiveAlarmsRequest request)

 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.