## On this page

  

 

 # ensightservice::SubscribeEventOptions Struct Reference

 Last update: 16.07.2025 

## <a id="pub-types" name="pub-types"></a>Public Types

enum [ChannelType](structensightservice_1_1_subscribe_event_options.xhtml#a40c27f449a1bef4be2896c9ddabc33ec) { [GRPC](structensightservice_1_1_subscribe_event_options.xhtml#a40c27f449a1bef4be2896c9ddabc33ecac76af920867bae3f2205d0257ed35248) = 0 } Subscription channel type Presently, only image subscriptions are supported. [More...](structensightservice_1_1_subscribe_event_options.xhtml#a40c27f449a1bef4be2896c9ddabc33ec)  
 ## <a id="pub-attribs" name="pub-attribs"></a>Public Attributes

<a id="a082993f0eb40371edb50a17748c35478"></a>string [prefix](structensightservice_1_1_subscribe_event_options.xhtml#a082993f0eb40371edb50a17748c35478) = 1 A unique prefix string (perhaps a GUID) used to identify this stream (used by [Unsubscribe()](group___en_sight_service.xhtml#ga9161e678fe3d7608820907269d55bf8c))   
 <a id="a48a6a952356ad524def1932913f05dd0"></a>[ChannelType](structensightservice_1_1_subscribe_event_options.xhtml#a40c27f449a1bef4be2896c9ddabc33ec) [type](structensightservice_1_1_subscribe_event_options.xhtml#a48a6a952356ad524def1932913f05dd0) = 2 The [EventReply](structensightservice_1_1_event_reply.xhtml) transport mechanism (GRPC)   
 map&lt; string, string &gt; [options](structensightservice_1_1_subscribe_event_options.xhtml#a9fea05c94fe1c3d637193793a4c27ccb) = 3 various type specific options [More...](structensightservice_1_1_subscribe_event_options.xhtml#a9fea05c94fe1c3d637193793a4c27ccb)  
 <a id="details" name="details"></a>## Detailed Description

The event subscription options

Definition at line [158](ensight_8proto_source.xhtml#l00158) of file [ensight.proto](ensight_8proto_source.xhtml).



## Member Enumeration Documentation

<a id="a40c27f449a1bef4be2896c9ddabc33ec"></a>## [◆ ](#a40c27f449a1bef4be2896c9ddabc33ec)ChannelType

 enum [ensightservice::SubscribeEventOptions::ChannelType](structensightservice_1_1_subscribe_event_options.xhtml#a40c27f449a1bef4be2896c9ddabc33ec)

Subscription channel type Presently, only image subscriptions are supported.

Enumerator<a id="a40c27f449a1bef4be2896c9ddabc33ecac76af920867bae3f2205d0257ed35248"></a>GRPC EnSight should use gRPC [PublishEvent()](group___en_sight_subscription.xhtml#gaaded4bebe805118acaa44365183c2586) to send the events back to the client.

Definition at line [162](ensight_8proto_source.xhtml#l00162) of file [ensight.proto](ensight_8proto_source.xhtml).





## Member Data Documentation

<a id="a9fea05c94fe1c3d637193793a4c27ccb"></a>## [◆ ](#a9fea05c94fe1c3d637193793a4c27ccb)options

 map&lt;string, string&gt; 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](ensight_8proto_source.xhtml#l00173) of file [ensight.proto](ensight_8proto_source.xhtml).





---

The documentation for this struct was generated from the following file:- D:/ANSYSDev/NoBackup/branches/EnSight-Second-Coming/ensight/client/rpc\_interface/[ensight.proto](ensight_8proto_source.xhtml)