Skip to main content

EdgeConfig

Struct EdgeConfig 

Source
pub struct EdgeConfig {
    pub listen_addr: SocketAddr,
    pub brain_addr: SocketAddr,
    pub pool_size: usize,
    pub max_credentials: usize,
    pub idle_ttl_secs: u64,
    pub request_timeout_secs: u64,
    pub max_body_bytes: usize,
    pub wire_listen_addr: Option<SocketAddr>,
    pub wire_rate_capacity: u32,
    pub wire_rate_refill_per_sec: u32,
}
Expand description

brain-edge configuration.

Fields§

§listen_addr: SocketAddr

Address to serve the HTTP API on.

§brain_addr: SocketAddr

Address of the Brain database to proxy to.

§pool_size: usize

Per-credential connection-pool width to Brain.

§max_credentials: usize

Hard cap on distinct cached credentials (LRU-evicted over this).

§idle_ttl_secs: u64

Seconds of idle before a cached credential’s pool is swept.

§request_timeout_secs: u64

Per-request wall-clock timeout, in seconds. A request that outlives this (e.g. a stalled Brain connection) is cut with 408 Request Timeout rather than hanging a worker indefinitely.

§max_body_bytes: usize

Hard cap on request body size, in bytes. Bodies over this are rejected with 413 Payload Too Large before the handler runs.

§wire_listen_addr: Option<SocketAddr>

Optional address for the transparent wire-protocol proxy listener. When Some, the edge serves the Brain binary wire protocol here (in addition to the HTTP data plane) — a customer SDK points at this address with its own Brain key and the edge splices frames to Brain untouched. None (the default) leaves the proxy off; the edge is HTTP-only.

§wire_rate_capacity: u32

Wire-proxy per-credential rate-limit burst ceiling. 0 (the default) disables rate limiting on the wire path.

§wire_rate_refill_per_sec: u32

Wire-proxy per-credential sustained rate, in ops per second, refilled into the burst bucket. Ignored when wire_rate_capacity is 0.

Implementations§

Source§

impl EdgeConfig

Source

pub fn from_env() -> Result<Self, String>

Load from the environment with sane self-host defaults.

  • BRAIN_EDGE_LISTEN — HTTP listen addr (default 0.0.0.0:8080).
  • BRAIN_ADDR — Brain address, ip:port or host:port (default 127.0.0.1:7878).
  • BRAIN_EDGE_POOL_SIZE — pool width per credential (default 4).
  • BRAIN_EDGE_MAX_CREDENTIALS — cap on cached credentials (default 256).
  • BRAIN_EDGE_IDLE_TTL_SECS — idle-sweep TTL in seconds (default 900).
  • BRAIN_EDGE_REQUEST_TIMEOUT_SECS — per-request timeout (default 30).
  • BRAIN_EDGE_MAX_BODY_BYTES — request body cap (default 1048576 = 1 MiB).
  • BRAIN_EDGE_WIRE_LISTEN — wire-proxy listen addr, ip:port or host:port (unset = wire proxy off).
  • BRAIN_EDGE_WIRE_RATE_CAPACITY — per-credential burst (default 0 = off).
  • BRAIN_EDGE_WIRE_RATE_REFILL_PER_SEC— per-credential ops/sec refill (default 0).
§Errors

Returns a message if an address fails to parse/resolve, a numeric var is malformed, or a required-positive value is zero.

Trait Implementations§

Source§

impl Clone for EdgeConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EdgeConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more