ensightservice::SubscribeImageOptions Struct Reference
Last update: 17.04.2023Public Types | |
| enum | ChannelType { GRPC = 0 , SHARED_MEM = 1 } |
| Image channel type The image subscription can be via gRPC protocol or via shared memory transport. More... | |
Public Attributes | |
| string | prefix = 1 |
| A unique prefix string (perhaps a GUID) used to identify this stream (used by Unsubscribe()) | |
| ChannelType | type = 2 |
| Select GRPC or SHARED_MEM transport. | |
| bool | flip_vertical = 3 |
| If true, flip the image over the X axis before sending the image. | |
| bool | chunk = 4 |
| Set to send images in 1MB chunks to speed up large (>1MB) image transfers (see ImageStreamRequest and ImageReply) | |
| map< string, string > | options = 5 |
| various type specific options More... | |
Detailed Description
The image subscription options
Definition at line 177 of file ensight.proto.
Member Enumeration Documentation
◆ ChannelType
Image channel type The image subscription can be via gRPC protocol or via shared memory transport.
| Enumerator | |
|---|---|
| GRPC | EnSight should use gRPC PublishImage() calls to send images back to the client. |
| SHARED_MEM | EnSight should use a SharedMemoryImageStream to send images back to the client. |
Definition at line 181 of file ensight.proto.
Member Data Documentation
◆ options
| map<string, string> ensightservice::SubscribeImageOptions::options = 5 |
various type specific options
For type=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.
For type=SHARED_MEM, 'filename' map key contains the name of local file to be used as the memory mapped shared memory block (required).
Definition at line 198 of file ensight.proto.
The documentation for this struct was generated from the following file:
- D:/ANSYSDev/NoBackup/branches/EnSight-Second-Coming/ensight/client/rpc_interface/ensight.proto