Struct HostOptions

Source

pub struct HostOptions { /* private fields */ }

Expand description

Host-side transport options, passed to host_with_options. HostOptions::default() is what host uses.

Implementations§

Source §

impl HostOptions

Source

pub fn new() -> Self

Source

pub fn max_pipe_instances(self, n: u32) -> Self

Cap on simultaneous instances of the Windows named pipe: live connections plus the one instance waiting for the next client. A client that arrives when the cap is reached gets “pipe busy” and retries, so a flood of connections cannot grow the host without bound. Default DEFAULT_MAX_PIPE_INSTANCES (16); clamped to 1..=254 (255 is “unlimited” to Win32 and is never used). Ignored on Unix, where there is no pipe.

Source

pub fn get_max_pipe_instances(&self) -> u32

The effective (clamped) cap.

Source

pub fn write_timeout(self, bound: Option<Duration>) -> Self

Longest one frame (hello, event, or response) may take to write and flush to a client. A client that stops reading fills the transport buffer and would otherwise block the writing thread, and the connection with it, forever; when the bound passes the host closes that connection (the client sees connection_closed, never a partial frame it could mistake for a reply), and the connection’s connection_closed handler hook runs. The bound is per frame, so a slow but progressing reader of a stream of events is not cut off unless a single frame stalls. Default DEFAULT_WRITE_TIMEOUT (120 s); None restores the earlier unbounded write. A zero duration is raised to 1 ms.

Source

pub fn get_write_timeout(&self) -> Option<Duration>

The effective write bound (None = unbounded).

Source

pub fn max_message(self, bytes: usize) -> Self

Largest message the host assembles from chunks, or hands out in chunks (see the chunk module). The frame limit (ServiceConfig::frame_limit) stays the cap on any one frame; this is the second, separate cap on a whole chunked request or result, held in memory per connection. Default 0: chunking is off, the host refuses rk.upload and never announces a chunked result (it was 256 MiB earlier in the unpublished 0.2.7; see issue #323). A service that takes large calls opts in with a size (see SUGGESTED_MAX_MESSAGE). A connection holds at most one assembly of at most this many bytes; the first piece is authorised before it is buffered, and the assembled text is bounded in nesting and value count before it is parsed.

Source

pub fn get_max_message(&self) -> usize

The effective message bound.

Source

pub fn max_connections(self, n: usize) -> Self

Cap on simultaneous connections on Unix (the counterpart of the Windows pipe-instance cap, which this does not replace there): a connection that arrives over the cap is closed at once, before any frame is read, so a flood cannot grow the host’s threads and buffers without bound. Default DEFAULT_MAX_CONNECTIONS (64); at least 1. Unlike Windows “pipe busy”, the refused client sees the connection close rather than a retryable busy status. Ignored on Windows.

Source