package hs.network.proto

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc CallMethod (CallRequest, messages.Message)

  application.proto:343

  Used to call a method at {path}.

  message CallRequest

  application.proto:190

  • string path = 1

    The path of the method.

  • optional messages.Message data = 2

    The input parameter of the method.

• rpc GetApplication (GetApplicationRequest, Node)

  application.proto:265

  Used to get the current Application.

  message GetApplicationRequest

  application.proto:126

  Represents a request to get the current application.

  (message has no fields)

• rpc GetApplicationVersion (VersionRequest, Version)

  application.proto:258

• rpc GetInterfaceVersion (VersionRequest, Version)

  application.proto:252

• rpc GetNode (GetNodeRequest, Node)

  application.proto:272

  Used to get the Node at {path}.

  message GetNodeRequest

  application.proto:129

  Represents a request to get a Node.

  • string path = 1

    Represents the path to a Node to be requested.

• rpc GetProperty (GetPropertyRequest, Property)

  application.proto:279

  Used to get the property at {path}.

  message GetPropertyRequest

  application.proto:134

  Represents a request to get a Property.

  • string path = 1

    Represents the path to a Property to be requested.

• rpc GetReadTopicEnabled (GetReadTopicEnabledRequest, GetReadTopicEnabledResponse)

  application.proto:309

  Used to query if topic reads are enabled for topic at {path}.

  message GetReadTopicEnabledRequest

  application.proto:228

  Represents a request to query if topic reads are enabled.

  • string path = 1

    The path of the topic.

  message GetReadTopicEnabledResponse

  application.proto:234

  Represents the response to query if topic reads are enabled.

  • bool value = 1

    Indicates if topic reads are enabled.

• rpc ReadTopic (ReadTopicRequest, ReadTopicResponse)

  application.proto:302

  Used to read a topic at {path}.

  message ReadTopicRequest

  application.proto:162

  Represents a request to read a topic.

  • string path = 1

    The path of the topic.

  • uint32 prev_message_id = 2

    The timestamp of the previous message. The call will block until newer message is available.

  message ReadTopicResponse

  application.proto:171

  Represents the response to write to a topic.

  • uint32 message_id = 1

    The message id.

  • optional messages.Message data = 2

    The message.

• rpc SetProperty (SetPropertyRequest, Property)

  application.proto:286

  Used to set a property at {path} to {value}.

  message SetPropertyRequest

  application.proto:139

  Represents a request to set a Property.

  • string path = 1

    Represents the path to the property to be set.

  • oneof value_oneof

    • int32 value_int32 = 2

      The value of a 32 bit signed integer property.

    • int64 value_int64 = 3

      The value of a 64 bit signed integer property.

    • uint32 value_uint32 = 4

      The value of a 32 bit unsigned integer property.

    • uint64 value_uint64 = 5

      The value of a 64 bit unsigned integer property.

    • float value_float = 6

      The value of a 32 bit floating point property.

    • double value_double = 7

      The value of a 64 bit floating point property.

    • string value_string = 8

      The value of a string property.

    • bool value_bool = 9

      The value of a boolean property.

    • int32 value_enum = 10

      The value of an enumeration property.

• rpc SetReadTopicEnabled (SetReadTopicEnabledRequest, SetReadTopicEnabledResponse)

  application.proto:318

  Used to enable/disable topic reads for topic at {path}.

  message SetReadTopicEnabledRequest

  application.proto:240

  Request to enable/disable topic reads.

  • string path = 1

    The path of the topic.

  • bool value = 2

    Enables or disables topic reads.

  message SetReadTopicEnabledResponse

  application.proto:246

  (message has no fields)

• rpc SubscribeEvents (SubscribeEventsRequest, stream Event)

  application.proto:336

  Used to subscribe to events of the current application.

  message SubscribeEventsRequest

  application.proto:188

  Represents a request to subscribe to events.

  (message has no fields)

  message Event

  application.proto:199

  Represents an event.

  • Event.Type type = 1

    The type of the Event.

  • string path = 2

    The path to the corresponding object.

  • oneof data

    • Input input = 3

      The Input message. Field is only set on an InputAdded event.

    • Output output = 4

      The Output message. Field is only set on an OutputAdded event.

    • Property property = 5

      The Property message. Field is only set on

    • Method method = 6

      PropertyAdded and PropertyChanged events.

      The Method message. Field is only set on an MethodAdded event.

• rpc SubscribeTopic (SubscribeTopicRequest, stream messages.Message)

  application.proto:294

  Used to subscribe to updates to a topic at {path}.

  message SubscribeTopicRequest

  application.proto:157

  Represents a request to subscribe to a topic.

  • string path = 1

    The path of the topic.

• rpc WriteTopic (WriteTopicRequest, WriteTopicResponse)

  application.proto:328

  Used to write data to a topic at {path}.

  message WriteTopicRequest

  application.proto:177

  Represents a request to write to a topic.

  • string path = 1

    The path of the topic.

  • optional messages.Message data = 2

    The message that should be written.

  message WriteTopicResponse

  application.proto:185

  Represents the response to write to a topic.

  (message has no fields)

Used in: Event

• Unknown = 0

  An unknown Event occured.

• InputAdded = 1

  An Input has been added.

• InputRemoved = 2

  An Input has been removed.

• OutputAdded = 3

  An Output has been added.

• OutputRemoved = 4

  An Output has been removed.

• PropertyAdded = 5

  A Property has been added.

• PropertyRemoved = 6

  A Property has been removed.

• PropertyChanged = 7

  A Property has been changed.

• MethodAdded = 8

  A Method has been added.

• MethodRemoved = 9

  A Method has been removed.

Represents the input to a Node.

Used in: Event, Node

• string type = 1

  Defines the type of input to the Node.

Used in: Event, Node

• string typeIn = 1

  Defines the type of the method's input parameter.

• string typeOut = 2

  Defines the type of the method's output parameter.

Represents a specific application with corresponding properties, inputs and outputs.

Used as response type in: ApplicationService.GetApplication, ApplicationService.GetNode

• map<string, Property> properties = 1

  Represents the properties of the application as a map.

• map<string, Input> inputs = 2

  Represents the inputs of the application as a map.

• map<string, Output> outputs = 3

  Represents the outputs of the application as a map.

• map<string, Method> methods = 4

Represents the output from a Node.

Used in: Event, Node

• string type = 1

  Defines the type of output from a Node.

Represents a property containing a single datatype.

Used as response type in: ApplicationService.GetProperty, ApplicationService.SetProperty

Used as field type in: Event, Node

• oneof property_oneof

  • PropertyInt32 prop_int32 = 1

    A 32 bit signed integer property.

  • PropertyInt64 prop_int64 = 2

    A 64 bit signed integer property.

  • PropertyUInt32 prop_uint32 = 3

    A 32 bit unsigned integer property.

  • PropertyUInt64 prop_uint64 = 4

    A 64 bit unsigned integer property.

  • PropertyFloat prop_float = 5

    A 32 bit floating point property.

  • PropertyDouble prop_double = 6

    A 64 bit floating point property.

  • PropertyString prop_string = 7

    A string property.

  • PropertyBool prop_bool = 8

    A boolean property.

  • PropertyEnum prop_enum = 9

    An enumeration property.

• string displayname = 20

  Name of the property.

• string description = 21

  Description of the property.

Represents a Boolean value.

Used in: Property

• bool value = 1

  Value of the property, can be true or false.

Represents a double-precision floating-point number.

Used in: Property

• double value = 1

  The property value.

• double min = 2

  Lower bound of the property.

• double max = 3

  Upper bound of the property.

• double step = 4

  Step between two consecutive values (0 if disabled)

Represents an enumeration type.

Used in: Property

• int32 value = 1

  The property value.

• map<int32, string> value_map = 2

  The value map containing possible values

Represents a floating-point number.

Used in: Property

• float value = 1

  The property value.

• float min = 2

  Lower bound of the property.

• float max = 3

  Upper bound of the property.

• float step = 4

  Step between two consecutive values (0 if disabled)

Represents a 32-bit signed integer.

Used in: Property

• int32 value = 1

  The property value.

• int32 min = 2

  Lower bound of the property.

• int32 max = 3

  Upper bound of the property.

• int32 step = 4

  Step between two consecutive values (0 if disabled)

Represents a 64-bit signed integer.

Used in: Property

• int64 value = 1

  The property value.

• int64 min = 2

  Lower bound of the property.

• int64 max = 3

  Upper bound of the property.

• int64 step = 4

  Step between two consecutive values (0 if disabled)

Represents a string type.

Used in: Property

• string value = 1

  The property value.

Represents a 32-bit unsigned integer.

Used in: Property

• uint32 value = 1

  The property value.

• uint32 min = 2

  Lower bound of the property.

• uint32 max = 3

  Upper bound of the property.

• uint32 step = 4

  Step between two consecutive values (0 if disabled)

Represents a 64-bit unsigned integer.

Used in: Property

• uint64 value = 1

  The property value.

• uint64 min = 2

  Lower bound of the property.

• uint64 max = 3

  Upper bound of the property.

• uint64 step = 4

  Step between two consecutive values (0 if disabled)

Used as response type in: ApplicationService.GetApplicationVersion, ApplicationService.GetInterfaceVersion

• int32 versionMajor = 1

• int32 versionMinor = 2

• int32 versionPatch = 3

Used as request type in: ApplicationService.GetApplicationVersion, ApplicationService.GetInterfaceVersion

(message has no fields)