Skip to main content

LimitConnPlugin

Struct LimitConnPlugin 

Source
pub struct LimitConnPlugin {
    role: Role,
    conn: i64,
    burst: i64,
    key: String,
    key_constant: bool,
    rejected_code: u16,
    rejected_msg: Option<String>,
    resources: Arc<PluginResources>,
}
Expand description

One node of a limit-conn acquire/release pair.

Holds a handle to the process-wide crate::traffic::ConnRegistry; the per-key counter is resolved at request time from the interpolated key so concurrency is measured per client (or per whatever the key selects), shared across both nodes of the pair.

Fields§

§role: Role§conn: i64

Maximum sustained concurrent requests.

§burst: i64

Extra concurrent requests tolerated above conn.

§key: String

Key template (interpolated per request unless key_type is constant).

§key_constant: bool

When true, key is used verbatim rather than interpolated.

§rejected_code: u16

Status returned when the limit is exceeded.

§rejected_msg: Option<String>

Optional human-readable rejection message (JSON {"error_msg": ...}).

§resources: Arc<PluginResources>

Implementations§

Source§

impl LimitConnPlugin

Source

pub fn from_config( config: &HashMap<String, Value>, resources: &Arc<PluginResources>, ) -> Result<Self, String>

Builds one node of the pair from node config.

Accepted keys:

  • phase / role (string, required): acquire (before upstream) or release (after upstream). Any other value is a config error.
  • conn (integer, default 20): maximum sustained concurrent requests. Must be > 0.
  • burst (integer, default 0): extra concurrent requests tolerated above conn. Must be >= 0. The hard ceiling is conn + burst.
  • key (string template, default "$remote_addr"): the concurrency key, interpolated per request (see crate::vars::interpolate). Both nodes of a pair must use the same key and conn/burst so they share one counter.
  • key_type (string, default var): constant uses key verbatim; any other value (var, var_combination) interpolates it.
  • rejected_code (integer, default 503): status for over-limit requests.
  • rejected_msg (string, optional): message returned as a JSON body {"error_msg": "..."} on rejection.
  • default_conn_delay (number, optional): accepted for APISIX config compatibility but ignored — featherbit rejects rather than delays.
# before upstream
type: limit-conn
config:
  phase: acquire
  conn: 100
  burst: 50
  key: $remote_addr
  rejected_code: 503
---
# after upstream (on both success and error paths)
type: limit-conn
config:
  phase: release
  conn: 100
  burst: 50
  key: $remote_addr
Source

fn resolve_key(&self, ctx: &Context) -> String

Resolves the concurrency key for this request.

Trait Implementations§

Source§

impl Plugin for LimitConnPlugin

Source§

fn plugin_type(&self) -> &str

Unique identifier for the plugin type (e.g., “proxy-rewrite”, “upstream”).
Source§

fn execute<'life0, 'life1, 'async_trait>( &'life0 self, ctx: Context, _named_inputs: &'life1 HashMap<String, Value>, ) -> Pin<Box<dyn Future<Output = Result<PluginOutput, PluginExecutionError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Executes the plugin logic against the request/response context. 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
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> MaybeSend for T