Interface IDurableObjectState

Readonlystorage

acceptWebSocket

• acceptWebSocket(ws: IDurableObjectWebSocket): void

  Accepts a socket as hibernatable.

  Unlike ws.accept(), this tells the runtime it need not pin the Durable Object to memory while the connection is open: the object may be evicted and its constructor re-run when the next message arrives. That is why RealtimeBackplaneObjectCore keeps no membership in a field — getWebSockets is the only state that survives.

  Parameters

  • ws: IDurableObjectWebSocket

    The server half of the pair

  Returns void

getWebSockets

• getWebSockets(): IDurableObjectWebSocket[]

  Returns every currently connected socket.

  Survives hibernation, which is what makes it usable as the sole source of truth for broadcast membership.

  Returns IDurableObjectWebSocket[]

  The connected sockets