IRPCApplicationTaskQueue.SendBroadcastMessage
Server integration API / specialized write session
Sends a broadcast message through a task queue to every consumer of that queue.
| Service | Application task queue MFiles.IRPCApplicationTaskQueue |
|---|---|
| gRPC method | /MFiles.IRPCApplicationTaskQueue/SendBroadcastMessage |
| HTTP (mf-http-grpc) | POST /grpc/v1/send-broadcast-message |
| Request | SendBroadcastMessageRequest |
| Response | SendBroadcastMessageResponse |
| Book and level | Server integration API, specialized |
| Kind | write |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Consumers read new messages with GetNewBroadcastMessages. Messages are removed by the server after a day.
- Requires a vault session and the vault right
change_full_control_role. Internal queue IDs are refused with "Access denied.".
Request: SendBroadcastMessageRequest
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 |
|---|---|---|
queue_id | string | The ID of the queue. |
broadcast_type | string | A free-form type name that tells consumers how to read broadcast_data. |
broadcast_data | bytes | The payload of the message. |
Response: SendBroadcastMessageResponse
No fields.
Related methods
- GetNewBroadcastMessages -- Gets the broadcast messages of a queue that are newer than the given message ID.