## 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 } ## <a id="pub-attribs" name="pub-attribs"></a>Public Attributes

string [prefix](structensightservice_1_1_subscribe_event_options.xhtml#a082993f0eb40371edb50a17748c35478) = 1 [ChannelType](structensightservice_1_1_subscribe_event_options.xhtml#a40c27f449a1bef4be2896c9ddabc33ec) [type](structensightservice_1_1_subscribe_event_options.xhtml#a48a6a952356ad524def1932913f05dd0) = 2 map&lt; string, string &gt; [options](structensightservice_1_1_subscribe_event_options.xhtml#a9fea05c94fe1c3d637193793a4c27ccb) = 3 <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" name="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" name="a40c27f449a1bef4be2896c9ddabc33ecac76af920867bae3f2205d0257ed35248"></a>GRPC EnSight should use gRPC PublishEvent() 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" name="a9fea05c94fe1c3d637193793a4c27ccb"></a>## [◆ ](#a9fea05c94fe1c3d637193793a4c27ccb)options

 map&lt;string, string&gt; ensightservice::SubscribeEventOptions::options = 3

various type specific options

For type=[ChannelType::GRPC](structensightservice_1_1_subscribe_event_options.xhtml#a40c27f449a1bef4be2896c9ddabc33ecac76af920867bae3f2205d0257ed35248 "EnSight should use gRPC PublishEvent() to send the events back to the client."), '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).





<a id="a082993f0eb40371edb50a17748c35478" name="a082993f0eb40371edb50a17748c35478"></a>## [◆ ](#a082993f0eb40371edb50a17748c35478)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](ensight_8proto_source.xhtml#l00165) of file [ensight.proto](ensight_8proto_source.xhtml).





<a id="a48a6a952356ad524def1932913f05dd0" name="a48a6a952356ad524def1932913f05dd0"></a>## [◆ ](#a48a6a952356ad524def1932913f05dd0)type

 [ChannelType](structensightservice_1_1_subscribe_event_options.xhtml#a40c27f449a1bef4be2896c9ddabc33ec) ensightservice::SubscribeEventOptions::type = 2

The [EventReply](structensightservice_1_1_event_reply.xhtml) transport mechanism (GRPC)

Definition at line [166](ensight_8proto_source.xhtml#l00166) of file [ensight.proto](ensight_8proto_source.xhtml).





---

The documentation for this struct was generated from the following file:- D:/Product-src/ensight/client/rpc\_interface/[ensight.proto](ensight_8proto_source.xhtml)