package nitric.proto.topics.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Service for subscribing to asynchronous messages

• rpc Subscribe (stream ClientMessage, stream ServerMessage)

  topics.proto:24

  Subscribe to a topic and handle incoming messages

  message ClientMessage

  topics.proto:28

  ClientMessage is the message sent from the service to the nitric server

  • string id = 1

    globally unique ID of the request/response pair

  • oneof content

    • RegistrationRequest registration_request = 2

      Register a subscription to a topic

    • MessageResponse message_response = 3

      Handle a message received from a topic

  message ServerMessage

  topics.proto:53

  ServerMessage is the message sent from the nitric server to the service

  • string id = 1

    globally unique ID of the request/response pair

  • oneof content

    • RegistrationResponse registration_response = 2

      Response to a topic subscription request

    • MessageRequest message_request = 3

      Response to a topic message request

Service for publishing asynchronous messages

• rpc Publish (TopicPublishRequest, TopicPublishResponse)

  topics.proto:18

  Publishes a message to a given topic

  message TopicPublishRequest

  topics.proto:81

  Request to publish a message to a topic

  • string topic_name = 1

    The name of the topic to publish the topic to

  • optional TopicMessage message = 2

    The message to be published

  • optional google.protobuf.Duration delay = 3

    An optional delay specified in seconds (minimum 10 seconds)

  message TopicPublishResponse

  topics.proto:93

  Result of publishing an topic

  (message has no fields)

Used in: ServerMessage

• string topic_name = 1

• optional TopicMessage message = 2

  Message Type

Used in: ClientMessage

• bool success = 1

Used in: ClientMessage

• string topic_name = 1

Used in: ServerMessage

(message has no fields)

Used in: MessageRequest, TopicPublishRequest

• oneof content

  The topic message contents

  • google.protobuf.Struct struct_payload = 1