protocol/socket/catalog

packages/protocol/src/socket/catalog

Purpose

Closed RPC catalogs and Effect RPC groups for first-party socket wiring. The main socket barrel exposes lifecycle classes. This module exposes the derived method/notification catalogs and group types needed by client, server-core, conformance, and generated protocol reference docs.

Public surface

`agentCallableGroup`

Variable

export const agentCallableGroup = makeRpcGroup(
  agentCallableMethods.map((definition) => definition.clientRpc),
)

Effect RPC group for all agent-callable methods.

`agentCallableMethods`

Variable

export const agentCallableMethods = [
  ...identityRpcMethods,
  ...agentCallableNetworkRpcMethods,
  ...agentCallableConversationRpcMethods,
  ...agentCallableMessageRpcMethods,
] as const

Client-to-server descriptors an agent principal may originate.

`AnyAgentCallableRpcDefinition`

TypeAlias

export type AnyAgentCallableRpcDefinition =
  (typeof agentCallableMethods)[number];

Any descriptor an agent client may call.

`AnyNotificationDefinition`

TypeAlias

export type AnyNotificationDefinition =
  (typeof notificationDefinitions)[number];

Any server-to-client notification descriptor.

`AnyServerRpcDefinition`

TypeAlias

export type AnyServerRpcDefinition = (typeof serverInboundMethods)[number];

Any client-to-server descriptor the server handles.

`notificationDefinitions`

Variable

export const notificationDefinitions = [
  ...networkNotifications,
  ...conversationNotifications,
  ...messageNotifications,
] as const

Every server-to-client notification descriptor.

`notificationRpcGroup`

Variable

export const notificationRpcGroup = makeRpcGroup(
  notificationDefinitions.map((definition) => definition.notificationRpc),
)

Server-to-client reverse notification group. The server fires each notification as a fire-and-forget void-result RPC on a target connection’s reverse channel; the client serves it via RpcServer<NotificationRpcGroup>, routing each payload into the SubscriberRegistry.

`reverseRpcGroup`

Variable

export const reverseRpcGroup = makeRpcGroup(
  notificationDefinitions.map((definition) => definition.notificationRpc),
)

The full server-to-client reverse group: every notification descriptor, built as ONE RpcGroup over the member tuple. The server holds one RpcClient<ReverseRpcGroup> per connection (fires notifications fork-and-forget); clients stand one RpcServer<ReverseRpcGroup> on the s2c sink, routing each payload into the SubscriberRegistry.

`ServerHandler`

TypeAlias

export type ServerHandler<D extends AnyServerRpcDefinition> =

Handler type for one inbound RPC descriptor.

`ServerHandlers`

TypeAlias

export type ServerHandlers = RpcGroup.HandlersFrom<
  RpcGroup.Rpcs<typeof serverInboundGroup>
>;

Complete server handler table keyed by every inbound RPC tag.

`serverInboundGroup`

Variable

export const serverInboundGroup = makeRpcGroup(
  serverInboundMethods.map((definition) => definition.serverRpc),
)

Effect RPC group for all client-to-server calls accepted by the server.

`serverInboundMethods`

Variable

export const serverInboundMethods = [
  ...identityRpcMethods,
  ...networkRpcMethods,
  ...agentCallableConversationRpcMethods,
  ...agentCallableMessageRpcMethods,
] as const

Full server inbound descriptor union. This is derived from the authored agent callable catalog, with the unauthenticated connect descriptor included once.

Files

index.ts

Getting Started

Concepts

Integrations

Guides

Simulator

Development

Modules

protocol/socket/catalog

protocol/socket/catalog

Purpose

Public surface

`agentCallableGroup`

`agentCallableMethods`

`AnyAgentCallableRpcDefinition`

`AnyNotificationDefinition`

`AnyServerRpcDefinition`

`notificationDefinitions`

`notificationRpcGroup`

`reverseRpcGroup`

`ServerHandler`

`ServerHandlers`

`serverInboundGroup`

`serverInboundMethods`

Files

​protocol/socket/catalog

​Purpose

​Public surface

​Files

protocol/socket/catalog

Purpose

Public surface

Files