@milaboratories/pl-client 2.16.11 → 2.16.13

package/dist/proto-grpc/github.com/milaboratory/pl/plapi/plapiproto/api.d.ts

@@ -33,8 +33,11 @@ import { Status } from "../../../../googleapis/googleapis/google/rpc/status";
  *   - client reads server responses for each messages sent. Client can batch
  *     writes and reads: e.g. send 3 messages, read 2 responses, send one
  *     more, read 2;
- *   - to finish communication client sends 'commit' message and reads last
+ *   - to finish communication client sends 'commit' or 'discard' message and reads last
  *     response;
+ *   - to make server interrupt communication, client sends 'stream_close' message and reads to the last
+ *     server response. This allows graceful stream close, waiting for all queued server responses
+ *     to be sent before closing the stream.
  *
  * Detailed description of the process.
  *
@@ -111,6 +114,10 @@ import { Status } from "../../../../googleapis/googleapis/google/rpc/status";
  *    - server stops reading client stream and does the commit/discard action.
  *    - once transaction is closed, server sends the result to client and
  *      closes server stream.
+ *    - client stream reading may be interrupted by special 'stream_close' message, which
+ *      causes transaction automatic discard and does not produce additional reply message.
+ *      This 'stream_close' message also does not require any 'request_id' value and does not
+ *      produce any response from server side.
  *
  * At this point the transaction over gRPC is considered as finalized, all
  * local IDs generated within the transaction are no longer valid.
@@ -165,6 +172,22 @@ export interface TxAPI_ClientMessage {
          * @generated from protobuf field: MiLaboratories.PL.API.TxAPI.Discard.Request tx_discard = 13
          */
         txDiscard: TxAPI_Discard_Request;
+    } | {
+        oneofKind: "streamClose";
+        /**
+         * Interrupt the transaction network stream on server side.
+         *
+         * This allows to gracefully close network connection and discard the associated transaction,
+         * ensuring all pending server responses are sent to the client before closing.
+         * We use this in RO transactions to imitate the feature of 'half-open' connection
+         * available in pure gRPC, when we work with WebSockets.
+         * Pure gRPC uses 'end of client messages stream' as a criteria for graceful discard.
+         * Pure WebSocket does not allow this, breaking entire connection at once. stream_close helps to get
+         * behaviour as we have for gRPC.
+         *
+         * @generated from protobuf field: MiLaboratories.PL.API.TxAPI.CloseStream.Request stream_close = 14
+         */
+        streamClose: TxAPI_CloseStream_Request;
     } | {
         oneofKind: "resourceCreateRoot";
         /**
@@ -529,6 +552,12 @@ export interface TxAPI_ServerMessage {
          * @generated from protobuf field: MiLaboratories.PL.API.TxAPI.Discard.Response tx_discard = 13
          */
         txDiscard: TxAPI_Discard_Response;
+    } | {
+        oneofKind: "streamClose";
+        /**
+         * @generated from protobuf field: MiLaboratories.PL.API.TxAPI.CloseStream.Response stream_close = 14
+         */
+        streamClose: TxAPI_CloseStream_Response;
     } | {
         oneofKind: "resourceCreateRoot";
         /**
@@ -973,6 +1002,21 @@ export interface TxAPI_Discard_Request {
  */
 export interface TxAPI_Discard_Response {
 }
+/**
+ * @generated from protobuf message MiLaboratories.PL.API.TxAPI.CloseStream
+ */
+export interface TxAPI_CloseStream {
+}
+/**
+ * @generated from protobuf message MiLaboratories.PL.API.TxAPI.CloseStream.Request
+ */
+export interface TxAPI_CloseStream_Request {
+}
+/**
+ * @generated from protobuf message MiLaboratories.PL.API.TxAPI.CloseStream.Response
+ */
+export interface TxAPI_CloseStream_Response {
+}
 /**
  * @generated from protobuf message MiLaboratories.PL.API.TxAPI.Sync
  */
@@ -3228,6 +3272,36 @@ declare class TxAPI_Discard_Response$Type extends MessageType<TxAPI_Discard_Resp
  * @generated MessageType for protobuf message MiLaboratories.PL.API.TxAPI.Discard.Response
  */
 export declare const TxAPI_Discard_Response: TxAPI_Discard_Response$Type;
+declare class TxAPI_CloseStream$Type extends MessageType<TxAPI_CloseStream> {
+    constructor();
+    create(value?: PartialMessage<TxAPI_CloseStream>): TxAPI_CloseStream;
+    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: TxAPI_CloseStream): TxAPI_CloseStream;
+    internalBinaryWrite(message: TxAPI_CloseStream, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
+}
+/**
+ * @generated MessageType for protobuf message MiLaboratories.PL.API.TxAPI.CloseStream
+ */
+export declare const TxAPI_CloseStream: TxAPI_CloseStream$Type;
+declare class TxAPI_CloseStream_Request$Type extends MessageType<TxAPI_CloseStream_Request> {
+    constructor();
+    create(value?: PartialMessage<TxAPI_CloseStream_Request>): TxAPI_CloseStream_Request;
+    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: TxAPI_CloseStream_Request): TxAPI_CloseStream_Request;
+    internalBinaryWrite(message: TxAPI_CloseStream_Request, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
+}
+/**
+ * @generated MessageType for protobuf message MiLaboratories.PL.API.TxAPI.CloseStream.Request
+ */
+export declare const TxAPI_CloseStream_Request: TxAPI_CloseStream_Request$Type;
+declare class TxAPI_CloseStream_Response$Type extends MessageType<TxAPI_CloseStream_Response> {
+    constructor();
+    create(value?: PartialMessage<TxAPI_CloseStream_Response>): TxAPI_CloseStream_Response;
+    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: TxAPI_CloseStream_Response): TxAPI_CloseStream_Response;
+    internalBinaryWrite(message: TxAPI_CloseStream_Response, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
+}
+/**
+ * @generated MessageType for protobuf message MiLaboratories.PL.API.TxAPI.CloseStream.Response
+ */
+export declare const TxAPI_CloseStream_Response: TxAPI_CloseStream_Response$Type;
 declare class TxAPI_Sync$Type extends MessageType<TxAPI_Sync> {
     constructor();
     create(value?: PartialMessage<TxAPI_Sync>): TxAPI_Sync;