class

MeshCoreTCPMux::Config

Inherits Reference < Object

Namespace for the TCP multiplexer: transport, protocol validation, and per-client state.

Instance methods

command_age
Source
command_age=(command_age : Time::Span)
Source
command_limit
Source
command_limit=(command_limit : Int32)
Source
connect_timeout

Bound both hostname resolution and TCP establishment. A connect timeout alone begins only after DNS has returned in Crystal's socket API.

Source
connect_timeout=(connect_timeout : Time::Span)

Bound both hostname resolution and TCP establishment. A connect timeout alone begins only after DNS has returned in Crystal's socket API.

Source
contacts_timeout
Source
contacts_timeout=(contacts_timeout : Time::Span)
Source
deduplicate_received_messages

Suppress radio retries that the companion exposes as repeated logical inbox messages. Disabled by default because downstream clients normally own this protocol policy themselves.

Source
deduplicate_received_messages=(deduplicate_received_messages : Bool)

Suppress radio retries that the companion exposes as repeated logical inbox messages. Disabled by default because downstream clients normally own this protocol policy themselves.

Source
factory_reset
Source
factory_reset=(factory_reset : Bool)
Source
frame_timeout
Source
frame_timeout=(frame_timeout : Time::Span)
Source
inbox_entries
Source
inbox_entries=(inbox_entries : Int32)
Source
listen_dedicated_client_ports
Source
listen_dedicated_client_ports=(listen_dedicated_client_ports : Array(Int32))
Source
listen_host

Shared runtime/broker settings: listener address, internal safety policies, operational deadlines, and permissions. Only settings with a credible deployment-specific tradeoff are exposed by the command-line interface; the other mutable properties remain useful for deterministic specs.

Queue limits count queued and currently active work. FrameCodec's fixed 176-byte payload maximum means entry/frame counts also impose finite byte bounds, so separate byte budgets would be redundant.

Source
listen_host=(listen_host : String)

Shared runtime/broker settings: listener address, internal safety policies, operational deadlines, and permissions. Only settings with a credible deployment-specific tradeoff are exposed by the command-line interface; the other mutable properties remain useful for deterministic specs.

Queue limits count queued and currently active work. FrameCodec's fixed 176-byte payload maximum means entry/frame counts also impose finite byte bounds, so separate byte budgets would be redundant.

Source
listen_multi_client_port
Source
listen_multi_client_port=(listen_multi_client_port : Int32)
Source
maintenance
Source
maintenance=(allowed : Bool) : Bool
Source
offline_queue_size
Source
offline_queue_size=(offline_queue_size : Int32)
Source
output_frames
Source
output_frames=(output_frames : Int32)
Source
poll_interval
Source
poll_interval=(poll_interval : Time::Span)
Source
private_key_export

Match a directly connected companion by default. Deployments that expose the mux to clients which should not control identity state can reject each sensitive operation independently through the corresponding CLI flag.

Source
private_key_export=(private_key_export : Bool)

Match a directly connected companion by default. Deployments that expose the mux to clients which should not control identity state can reject each sensitive operation independently through the corresponding CLI flag.

Source
private_key_import
Source
private_key_import=(private_key_import : Bool)
Source
radio_uncertainty_timeout

If TCP dies before SENT/ERR, the command may nevertheless have reached the companion. Keep shared radio admission closed long enough for that unobservable operation to finish without being overwritten after reconnect.

Source
radio_uncertainty_timeout=(radio_uncertainty_timeout : Time::Span)

If TCP dies before SENT/ERR, the command may nevertheless have reached the companion. Keep shared radio admission closed long enough for that unobservable operation to finish without being overwritten after reconnect.

Source
response_timeout

openHop companions await radio injection and persistence work before producing otherwise ordinary replies. Their reference client uses a 15-second command horizon, so five seconds is not a portable companion response bound even when the TCP reader remains healthy. Keep additional headroom for radio-link arbitration and persistence contention.

Source
response_timeout=(response_timeout : Time::Span)

openHop companions await radio injection and persistence work before producing otherwise ordinary replies. Their reference client uses a 15-second command horizon, so five seconds is not a portable companion response bound even when the TCP reader remains healthy. Keep additional headroom for radio-link arbitration and persistence contention.

Source
signing_timeout
Source
signing_timeout=(signing_timeout : Time::Span)
Source
startup_timeout
Source
startup_timeout=(startup_timeout : Time::Span)
Source
validate!
Source
virtual_sync_timeout

A virtual sync waits for a qualifying physical inbox pop behind other clients' transactions. Expiry rejects only this wait, without ending the epoch.

Source
virtual_sync_timeout=(virtual_sync_timeout : Time::Span)

A virtual sync waits for a qualifying physical inbox pop behind other clients' transactions. Expiry rejects only this wait, without ending the epoch.

Source
write_timeout
Source
write_timeout=(write_timeout : Time::Span)
Source