Struct Protocol 

pub struct Protocol {
    pub channel_kinds: ChannelKinds,
    pub message_kinds: MessageKinds,
    pub component_kinds: ComponentKinds,
    pub resource_kinds: ResourceKinds,
    pub socket: SocketConfig,
    pub tick_interval: Duration,
    pub compression: Option<CompressionConfig>,
    pub client_authoritative_entities: bool,
    /* private fields */
}

Builder and configuration container for a naia protocol definition.

Collects channels, messages, components, and transport settings before being locked and passed to a server or client.

Fields

channel_kinds: ChannelKinds

Registry of all channels registered in this protocol.

message_kinds: MessageKinds

Registry of all message types registered in this protocol.

component_kinds: ComponentKinds

Registry of all replicated component types registered in this protocol.

resource_kinds: ResourceKinds

Marker table — which ComponentKinds are Replicated Resources. Receiver side checks this on SpawnWithComponents to populate its ResourceRegistry. See _AGENTS/RESOURCES_PLAN.md.

socket: SocketConfig

Used to configure the underlying socket

tick_interval: Duration

The duration between each tick

compression: Option<CompressionConfig>

Configuration used to control compression parameters

client_authoritative_entities: bool

Whether or not Client Authoritative Entities will be allowed

Implementations

impl Protocol

pub fn builder() -> Self

Returns a default Protocol ready for builder-style configuration.

pub fn add_plugin<P: ProtocolPlugin>(&mut self, plugin: P) -> &mut Self

Applies plugin’s registrations to this protocol. Builder-style.

pub fn link_condition(&mut self, config: LinkConditionerConfig) -> &mut Self

Sets the link conditioning configuration (artificial latency/loss). Builder-style.

pub fn rtc_endpoint(&mut self, path: String) -> &mut Self

Sets the WebRTC signalling endpoint path. Builder-style.

pub fn get_rtc_endpoint(&self) -> String

Returns the configured WebRTC signalling endpoint path.

pub fn tick_interval(&mut self, duration: Duration) -> &mut Self

Sets the server tick interval. Builder-style.

pub fn compression(&mut self, config: CompressionConfig) -> &mut Self

Enables packet compression with the given config. Builder-style.

pub fn enable_client_authoritative_entities(&mut self) -> &mut Self

Enables client-authoritative entity mode, allowing clients to own and update replicated entities. Builder-style.

pub fn add_default_channels(&mut self) -> &mut Self

Registers the six built-in default channels. Builder-style.

pub fn add_channel<C: Channel>( &mut self, direction: ChannelDirection, mode: ChannelMode, ) -> &mut Self

Registers channel type C with the given direction and mode. Builder-style.

pub fn add_channel_settings<C: Channel>( &mut self, settings: ChannelSettings, ) -> &mut Self

Register a channel with fully-specified ChannelSettings (including criticality). Use this when you need a non-default priority tier; otherwise add_channel is sufficient.

pub fn add_message<M: Message>(&mut self) -> &mut Self

Registers message type M. Builder-style.

pub fn add_request<Q: Request>(&mut self) -> &mut Self

Registers request type Q and its associated response type. Builder-style.

pub fn add_component<C: Replicate>(&mut self) -> &mut Self

Registers replicated component type C. Builder-style.

pub fn add_resource<R: Replicate>(&mut self) -> &mut Self

Register R as a Replicated Resource.

A Resource is internally a hidden 1-component entity carrying R as its sole replicated component. This call:

1. Calls add_component::<R>() to allocate a normal ComponentKind
   • NetId for R (Resources reuse the component wire encoding).
2. Records the ComponentKind in resource_kinds so the receiver side can recognize incoming SpawnWithComponents messages whose components are resources, and populate its ResourceRegistry.

Idempotent — registering the same type twice is a no-op (matches add_component re-registration semantics; the underlying tables dedupe on TypeId).

pub fn lock(&mut self)

Freezes the protocol, computes and caches the protocol ID. Must be called before use.

pub fn check_lock(&self)

Panics if the protocol has already been locked.

pub fn build(&mut self) -> Self

Moves out of the builder and returns the owned Protocol.

pub fn protocol_id(&self) -> ProtocolId

Returns the cached protocol ID. Panics if protocol is not locked.

Trait Implementations

impl Clone for Protocol

fn clone(&self) -> Protocol

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Protocol

fn default() -> Self

Returns the “default value” for a type.