IRPCVault.SendPushDataPendingHeartbeat
Vault API / core write session returns metadata structure version
Sends a heartbeat signal as an early response for server data push (with non-zero request id). If the client cannot provide final response in 20 seconds, the client should be sending a heartbeat signal for server that prevents server from terminating the request.
| Service | Vault information MFiles.IRPCVault |
|---|---|
| gRPC method | /MFiles.IRPCVault/SendPushDataPendingHeartbeat |
| HTTP (mf-http-grpc) | POST /grpc/v1/send-push-data-pending-heartbeat |
| Request | SendPushDataPendingHeartbeatRequest |
| Response | SendPushDataPendingHeartbeatResponse |
| Book and level | Vault API, core |
| Kind | write |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | yes (in the mfiles-metadata-version-bin trailer) |
| Streaming | none (unary) |
Remarks
Part of server data push. A client that needs more time to answer a push request sends this within 20 seconds, and again as needed, so that the server keeps waiting for SendPushDataResponse.
Request: SendPushDataPendingHeartbeatRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
response_id | int32 | The response id, should match with the request id that was received from of the RequestPushDataAsync call. |
Response: SendPushDataPendingHeartbeatResponse
No fields.
Related methods
- SendPushDataResponse -- Sends a response for server data push. This is a response for request received with RequestPushDataAsync call (with non-zero request id). This call completes the push data cycle.