Module ic_websocket_cdk::types

Structs

• CanisterAckMessageContent
  Note: You should only use this struct in tests.
• CanisterCloseMessageContent
  Note: You should only use this struct in tests.
• CanisterOpenMessageContent
  Note: You should only use this struct in tests.
• CanisterOutputCertifiedMessages
  List of messages returned to the WS Gateway after polling.
• CanisterOutputMessage
  Element of the list of messages returned to the WS Gateway after polling.
• CanisterWsCloseArguments
  The arguments for ws_close.
• CanisterWsGetMessagesArguments
  The arguments for ws_get_messages.
• CanisterWsMessageArguments
  The arguments for ws_message.
• CanisterWsOpenArguments
  The arguments for ws_open.
• ClientKeepAliveMessageContent
  Note: You should only use this struct in tests.
• ClientKey
• OnCloseCallbackArgs
  Arguments passed to the on_close handler.
• OnMessageCallbackArgs
  Arguments passed to the on_message handler. The message argument is the message received from the client, serialized in Candid. To deserialize the message, use candid::decode_one.
• OnOpenCallbackArgs
  Arguments passed to the on_open handler.
• WebsocketMessage
  Messages exchanged through the WebSocket.
• WsHandlers
  Handlers initialized by the canister and triggered by the CDK.
• WsInitParams
  Parameters for the IC WebSocket CDK initialization. For default parameters and simpler initialization, use WsInitParams::new.

Enums

• CloseMessageReason
  Note: You should only use this struct in tests.
• WebsocketServiceMessageContent
  A service message sent by the CDK to the client or vice versa.

Type Aliases

• CanisterCloseResult
  The result of close.
• CanisterSendResult
  The result of send.
• CanisterWsCloseResult
  The result of ws_close.
• CanisterWsGetMessagesResult
  The result of ws_get_messages.
• CanisterWsMessageResult
  The result of ws_message.
• CanisterWsOpenResult
  The result of ws_open.
• CanisterWsSendResultDeprecated
• ClientPrincipal