Crate ic_websocket_cdk

Macros

• custom_print

Structs

• 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.
• OnCloseCallbackArgs
  Arguments passed to the on_close handler.
• OnMessageCallbackArgs
  Arguments passed to the on_message handler.
• OnOpenCallbackArgs
  Arguments passed to the on_open handler.
• 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.

Functions

• init
  Initialize the CDK by setting the callback handlers and the principal of the WS Gateway that will be polling the canister.
• wipe
  Resets the internal state of the IC WebSocket CDK.
• ws_close
  Handles the WS connection close event received from the WS Gateway.
• ws_get_messages
  Returns messages to the WS Gateway in response of a polling iteration.
• ws_message
  Handles the WS messages received either directly from the client or relayed by the WS Gateway.
• ws_open
  Handles the WS connection open event sent by the client and relayed by the Gateway.
• ws_send
  Sends a message to the client. The message must already be serialized, using a method of your choice, like Candid or CBOR.

Type Aliases

• 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.
• CanisterWsSendResult
  The result of ws_send.
• ClientPrincipal