Struct ProxySettings 

pub struct ProxySettings {
    pub calls_per_minute: u32,
    pub burst_calls: u32,
    pub in_flight_per_account: usize,
    pub in_flight_per_tree: usize,
    pub in_flight_total: usize,
    pub target_cache_ttl: Duration,
    pub target_cache_entries: usize,
    pub app_view: Option<String>,
}

The bounds on proxied calls, and where an app.bsky.* call with no atproto-proxy goes; see ProxyLimits.

Fields

calls_per_minute: u32

How many proxied calls one account’s budget refills by each minute.

Reasonable range: 1 to 6000. Sixty, the default, is one a second sustained: a hundred times the few calls a minute an agent makes, and the most one account can make a third party see from this server’s address.

burst_calls: u32

How many proxied calls one account may make at once from a full budget.

Reasonable range: 1 to 1000. Sixty, the default, covers a client that opens a view by fanning out a few dozen calls.

in_flight_per_account: usize

How many of one account’s proxied calls may be open at once, from the request to the last byte of the answer.

Reasonable range: 1 to 64. Eight, the default, is more than an agent opens at once, and keeps one account to a sixteenth of in_flight_total.

in_flight_per_tree: usize

How many proxied calls may be open at once across one account tree: an account this server’s operator admitted, and every account created beneath it.

Reasonable range: 1 to 512. 64, the default, is half of in_flight_total, so one creator’s accounts leave half for every other tree. A per-tree cap at or above in_flight_total has no effect.

in_flight_total: usize

How many proxied calls may be open at once across every account.

Reasonable range: 1 to 512. 128, the default, is a quarter of crate::MAX_CONCURRENT_REQUESTS, so however many accounts call a stalled service, three quarters of the request permits stay free for everything else. A per-account cap above it has no effect.

target_cache_ttl: Duration

How long the endpoint a target’s DID document names is kept.

Reasonable range: 10 to 3600 seconds. Five minutes, the default, fetches a document once for every few hundred calls an agent makes to it, and a service that moves is reached at its new address within five minutes.

target_cache_entries: usize

How many targets’ endpoints are kept, the least recently used dropped first.

Reasonable range: 16 to 100_000. An entry is a few kilobytes at most. 1024, the default, holds every service a deployment’s agents call in common use, in a few megabytes.

app_view: Option<String>

The service an app.bsky.* call with no atproto-proxy header is sent to, as that header would name it: did#service, such as did:web:api.bsky.app#bsky_appview. The reference PDS sends these calls to its configured app view the same way.

None, the default, sends nowhere: such a call is MethodNotImplemented.

Implementations

impl ProxySettings

pub fn check(&self) -> Result<(), String>

Refuses a setting outside its documented range, or an app_view that is not a DID and a service id, naming its [proxy] key.

Trait Implementations

impl Clone for ProxySettings

fn clone(&self) -> ProxySettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProxySettings

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

Formats the value using the given formatter.

impl Default for ProxySettings

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ProxySettings

fn eq(&self, other: &ProxySettings) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ProxySettings

impl StructuralPartialEq for ProxySettings