Struct OcreChannel 

pub struct OcreChannel { /* private fields */ }

The Durable Object class behind each realtime channel, exported by Ocre under the name OcreChannel.

One instance per channel name holds that channel’s WebSockets. It accepts them with the WebSocket Hibernation API, so it is evicted from memory between broadcasts while browsers stay connected (hibernated sockets cost no duration), and it stores nothing but each socket’s attachment (its identity and whether it may publish). What subscribers send is ignored, or relayed to the others as JSON for sockets connected with WebSocketUpgrade::rebroadcast; it completes the closing handshakes browsers start. Apps never call it directly: they use broadcast and WebSocketUpgrade::connect.

Free plan: Durable Objects must be SQLite-backed (storage: "sqlite"); one object accepts up to 32,768 WebSockets. cloudflare.config.ts declares it (ocre g scaffold ... --realtime adds this, with demo as the app name):

// worker.env
CHANNELS: bindings.durableObject({ worker: "demo", exportName: "OcreChannel" }),
// worker.exports
OcreChannel: exports.durableObject({ storage: "sqlite" }),

Implementations

impl OcreChannel

pub fn new(state: DurableObjectState, env: Env) -> Self

pub async fn fetch(&self, req: Request) -> Result<JsValue, JsValue>

pub async fn websocket_message( &self, ws: WebSocket, message: JsValue, ) -> Result<JsValue, JsValue>

pub async fn websocket_close( &self, ws: WebSocket, code: usize, reason: String, was_clean: bool, ) -> Result<JsValue, JsValue>

pub async fn websocket_error( &self, ws: WebSocket, error: JsValue, ) -> Result<JsValue, JsValue>

Trait Implementations

impl DurableObject for OcreChannel

async fn fetch(&self, req: Request) -> Result<Response>

POST: send the body to every socket, answer how many got it. Anything else: a WebSocket handshake forwarded by connect.

async fn websocket_message( &self, ws: WebSocket, message: WebSocketIncomingMessage, ) -> Result<()>

Relays text from sockets allowed to publish to every other socket; ignores the rest.

async fn websocket_close( &self, ws: WebSocket, code: usize, reason: String, _clean: bool, ) -> Result<()>

Completes the closing handshake the browser started.

fn new(state: State, _env: Env) -> Self

Constructs the Durable Object. This is synchronous; there is no async constructor. For async setup, call [State::block_concurrency_while] here without awaiting it: the runtime blocks delivery of all events until the initialization future completes.

async fn websocket_error(&self, ws: WebSocket, _error: Error) -> Result<()>

async fn connect(&self, socket: Socket) -> Result<(), Error>

Serves a TCP connection opened with [Stub::connect]. The socket is closed when this future completes, so it must live for the whole connection: when handing the socket to a listener, await [Socket::handle_as_node_connection] rather than spawning it or returning early.

async fn alarm(&self) -> Result<Response, Error>

impl From<OcreChannel> for JsValue

fn from(value: OcreChannel) -> Self

Converts to this type from the input type.

impl FromWasmAbi for OcreChannel

type Abi = WasmPtr<WasmRefCell<OcreChannel>>

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for OcreChannel

type Abi = WasmPtr<WasmRefCell<OcreChannel>>

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for OcreChannel

type Abi = WasmPtr<WasmRefCell<OcreChannel>>

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<OcreChannel>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for OcreChannel

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for OcreChannel

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for OcreChannel

type Abi = WasmPtr<WasmRefCell<OcreChannel>>

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<OcreChannel>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for OcreChannel

type Abi = WasmPtr<WasmRefCell<OcreChannel>>

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<OcreChannel>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl SupportsConstructor for OcreChannel

impl SupportsInstanceProperty for OcreChannel

impl SupportsStaticProperty for OcreChannel

impl TryFromJsValue for OcreChannel

fn try_from_js_value(value: JsValue) -> Result<Self, JsValue>

Performs the conversion.

fn try_from_js_value_ref(value: &JsValue) -> Option<Self>

Performs the conversion.

impl VectorFromWasmAbi for OcreChannel

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[OcreChannel]>

impl VectorIntoWasmAbi for OcreChannel

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[OcreChannel]>) -> Self::Abi

impl WasmDescribe for OcreChannel

fn describe()

impl WasmDescribeVector for OcreChannel

fn describe_vector()