ensightservice::SubscribeEventOptions Struct Reference
Last update: 16.07.2025Public Types | |
| enum | ChannelType { GRPC = 0 } |
Public Attributes | |
| string | prefix = 1 |
| ChannelType | type = 2 |
| map< string, string > | options = 3 |
Detailed Description
The event subscription options
Definition at line 158 of file ensight.proto.
Member Enumeration Documentation
◆ ChannelType
Subscription channel type Presently, only image subscriptions are supported.
| Enumerator | |
|---|---|
| GRPC | EnSight should use gRPC PublishEvent() to send the events back to the client. |
Definition at line 162 of file ensight.proto.
Member Data Documentation
◆ options
| map<string, string> ensightservice::SubscribeEventOptions::options = 3 |
various type specific options
For type=ChannelType::GRPC, 'uri' map key contains the URI for the server launched by the client (required). 'num_retries' map key is the number of times EnSight should attempt to connect before failing the operation. 'shared_secret' map key is the shared secret that the client gRPC server is expecting to see to authenticate a connection.
Definition at line 173 of file ensight.proto.
◆ prefix
| string ensightservice::SubscribeEventOptions::prefix = 1 |
A unique prefix string (perhaps a GUID) used to identify this stream (used by Unsubscribe())
Definition at line 165 of file ensight.proto.
◆ type
| ChannelType ensightservice::SubscribeEventOptions::type = 2 |
The EventReply transport mechanism (GRPC)
Definition at line 166 of file ensight.proto.
The documentation for this struct was generated from the following file:
- D:/Product-src/ensight/client/rpc_interface/ensight.proto
