socketRoomName

socketRoomName(channel, room) returns the name Meeko uses to locate a room's Durable Object: the channel and room separated by a null character ("chat\u0000general"). It is used by createWorker when forwarding an upgrade, by DurableObjectSocketPubSub when publishing and by the room itself to recognize publications addressed to it.

Use it in a custom Worker that needs to communicate with a specific room: inspect it, publish without going through the hub or forward an upgrade.

Usage#

import { socketRoomName } from "@meekojs/meeko/cloudflare";

const stub = env.MEEKO_SOCKET.get(env.MEEKO_SOCKET.idFromName(socketRoomName("chat", "general")));

Type#

function socketRoomName(channel: string, room: string): string

Parameters#

Return value#

`${channel}\0${room}`. The null separator cannot appear in a channel name, so two distinct pairs never share an object.

Examples#

The name of each pair#

import { socketRoomName } from "@meekojs/meeko/cloudflare";

console.log(JSON.stringify(socketRoomName("chat", "general"))); // "chat\u0000general"
console.log(JSON.stringify(socketRoomName("operations", "")));  // "operations\u0000", the default room

Publish to a room from a Cron Trigger#

// worker.ts: a scheduled event rather than an HTTP request.
import { DurableObjectSocketPubSub } from "@meekojs/meeko/cloudflare";

export default {
  fetch: worker.fetch,
  async scheduled(_event: ScheduledEvent, env: Env) {
    const pubsub = new DurableObjectSocketPubSub(env.MEEKO_SOCKET);
    await pubsub.publish("status", "", { event: "maintenance", payload: { at: Date.now() } });
  },
};

DurableObjectSocketPubSub computes the name with socketRoomName. Publishing this way does not validate the event or payload before sending them (the room discards a payload that fails the schema when delivering it); within a request, prefer socket.status.broadcast("", "maintenance", payload), which validates them against the contract.

Common mistakes#

Build the name by hand#

env.MEEKO_SOCKET.idFromName(`${channel}:${room}`);

There is no error, but this is a different object: empty, without the room's peers. The publications reach nobody.

env.MEEKO_SOCKET.idFromName(socketRoomName(channel, room));

Notes#

• Long names. If the name exceeds 1,024 bytes, the runtime does not expose ctx.id.name: the room takes it from its first connection or publication.
• Stability. Deployed rooms are located by this name: a custom Worker that computes it differently communicates with empty objects.

Related#

• createSocketRoomClassCreates the Durable Object class hosting a Socket room's WebSockets in Cloudflare Workers, with the hibernation API, reconstruction on wake and per-room limits.
• DurableObjectSocketPubSubThe Socket broker for Cloudflare Workers, where each channel and room is a Durable Object that receives publications over RPC and distributes them to its peers.
• createWorkerServes a Meeko application from a Cloudflare module Worker, created once per isolate with its bindings, forwarding Socket upgrades to their room's Durable Object.
• Socket and Durable ObjectsMeeko as a full-stack framework