package nitric.proto.websockets.v1

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc SendMessage (WebsocketSendRequest, WebsocketSendResponse)

  websockets.proto:14

  Send a messages to a websocket

  message WebsocketSendRequest

  websockets.proto:37

  • string socket_name = 1

    The nitric name of the socket to send on

  • string connection_id = 2

    The connection ID of the client to send to

  • bytes data = 3

    The data to send to the socket

  message WebsocketSendResponse

  websockets.proto:46

  (message has no fields)

• rpc CloseConnection (WebsocketCloseConnectionRequest, WebsocketCloseConnectionResponse)

  websockets.proto:18

  Close a websocket connection This can be used to force a client to disconnect

  message WebsocketCloseConnectionRequest

  websockets.proto:49

  • string socket_name = 1

    The nitric name of the socket to send on

  • string connection_id = 2

    The connection ID of the client to send to

  message WebsocketCloseConnectionResponse

  websockets.proto:56

  (message has no fields)

• rpc SocketDetails (WebsocketDetailsRequest, WebsocketDetailsResponse)

  websockets.proto:21

  Retrieve details about an API

  message WebsocketDetailsRequest

  websockets.proto:24

  • string socket_name = 1

  message WebsocketDetailsResponse

  websockets.proto:28

  • string url = 1

• rpc HandleEvents (stream ClientMessage, stream ServerMessage)

  websockets.proto:34

  Handle incoming websocket events

  message ClientMessage

  websockets.proto:61

  ClientMessages are sent from the service to the nitric server

  • string id = 1

    Globally unique id to pair requests/responses

  • oneof content

    • RegistrationRequest registration_request = 2

      Client initialisation request A worker will not be eligible for triggers until it has identified itself

    • WebsocketEventResponse websocket_event_response = 3

      Client responding with result of a trigger

  message ServerMessage

  websockets.proto:115

  ServerMessages are sent from the nitric server to the service

  • string id = 1

    Server message ID, used to pair requests/responses

  • oneof content

    • RegistrationResponse registration_response = 2

      Server responding with client configuration details to an InitRequest

    • WebsocketEventRequest websocket_event_request = 3

      Server requesting client to process an event

Used in: WebsocketConnectionEvent

• repeated string value = 1

Used in: ClientMessage

• string socket_name = 1

  The nitric name of the socket that this worker listens on

• WebsocketEventType event_type = 2

  The type of event that this worker handles

Placeholder message

Used in: ServerMessage

(message has no fields)

Used in: WebsocketEventRequest

• map<string, QueryValue> query_params = 1

  The query params available in the connection request

Used in: WebsocketEventResponse

• bool reject = 1

Used in: WebsocketEventRequest

(message has no fields)

Used in: ServerMessage

• string socket_name = 1

  The nitric name of the socket that this worker listens on

• string connection_id = 2

  The connection this trigger came from

• oneof websocket_event

  • WebsocketConnectionEvent connection = 10

  • WebsocketDisconnectionEvent disconnection = 11

  • WebsocketMessageEvent message = 12

Used in: ClientMessage

• oneof websocket_response

  • WebsocketConnectionResponse connection_response = 10

    WebsocketDisconnectionResponse disconnection_response = 11; WebsocketMessageEventResponse message_response = 12;

Used in: RegistrationRequest

• Connect = 0

  Specialised Event for handling new client connections

• Disconnect = 1

  Specialised Event for handling existing client connections

• Message = 2

  All other types of events are messages

Used in: WebsocketEventRequest

• bytes body = 1

  Data available on