Struct quilkin::filters::LocalRateLimit
source · pub struct LocalRateLimit { /* private fields */ }
Expand description
A filter that implements rate limiting on packets based on the token-bucket
algorithm. Packets that violate the rate limit are dropped. It only
applies rate limiting on packets received from a downstream connection (processed
through LocalRateLimit::read
). Packets coming from upstream endpoints
flow through the filter untouched.
Trait Implementations§
source§impl Filter for LocalRateLimit
impl Filter for LocalRateLimit
source§fn read<'life0, 'life1, 'async_trait>(
&'life0 self,
ctx: &'life1 mut ReadContext
) -> Pin<Box<dyn Future<Output = Result<(), FilterError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn read<'life0, 'life1, 'async_trait>(
&'life0 self,
ctx: &'life1 mut ReadContext
) -> Pin<Box<dyn Future<Output = Result<(), FilterError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Filter::read
is invoked when the proxy receives data from a
downstream connection on the listening port. Read moresource§fn write<'life0, 'life1, 'async_trait>(
&'life0 self,
_: &'life1 mut WriteContext
) -> Pin<Box<dyn Future<Output = Result<(), FilterError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn write<'life0, 'life1, 'async_trait>(
&'life0 self,
_: &'life1 mut WriteContext
) -> Pin<Box<dyn Future<Output = Result<(), FilterError>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Filter::write
is invoked when the proxy is about to send data to a
downstream connection via the listening port after receiving it via one
of the upstream Endpoints. Read moresource§impl StaticFilter for LocalRateLimit
impl StaticFilter for LocalRateLimit
source§const NAME: &'static str = "quilkin.filters.local_rate_limit.v1alpha1.LocalRateLimit"
const NAME: &'static str = "quilkin.filters.local_rate_limit.v1alpha1.LocalRateLimit"
The globally unique name of the filter.
§type Configuration = Config
type Configuration = Config
The human-readable configuration of the filter. Must be
serde
compatible, have a JSON schema, and be convertible to and
from Self::BinaryConfiguration
.§type BinaryConfiguration = LocalRateLimit
type BinaryConfiguration = LocalRateLimit
The binary configuration of the filter. Must be
prost
compatible,
and be convertible to and from Self::Configuration
.source§fn try_from_config(
config: Option<Self::Configuration>
) -> Result<Self, CreationError>
fn try_from_config( config: Option<Self::Configuration> ) -> Result<Self, CreationError>
Instantiates a new
StaticFilter
from the given configuration, if any. Read moresource§fn from_config(config: Option<Self::Configuration>) -> Self
fn from_config(config: Option<Self::Configuration>) -> Self
Instantiates a new
StaticFilter
from the given configuration, if any. Read moresource§fn factory() -> DynFilterFactorywhere
Self: 'static,
fn factory() -> DynFilterFactorywhere
Self: 'static,
Creates a new dynamic
FilterFactory
virtual table.source§fn ensure_config_exists(
config: Option<Self::Configuration>
) -> Result<Self::Configuration, CreationError>
fn ensure_config_exists( config: Option<Self::Configuration> ) -> Result<Self::Configuration, CreationError>
Convenience method for providing a consistent error message for filters
which require a fully initialized
Self::Configuration
.fn as_filter_config( config: impl Into<Option<Self::Configuration>> ) -> Result<Filter, CreationError>
Auto Trait Implementations§
impl !RefUnwindSafe for LocalRateLimit
impl Send for LocalRateLimit
impl Sync for LocalRateLimit
impl Unpin for LocalRateLimit
impl !UnwindSafe for LocalRateLimit
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moresource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T
in a tonic::Request