mz_kafka_util::client

Struct TunnelingClientContext

Source
pub struct TunnelingClientContext<C> {
    inner: C,
    rewrites: Arc<Mutex<BTreeMap<BrokerAddr, BrokerRewriteHandle>>>,
    default_tunnel: TunnelConfig,
    in_task: InTask,
    ssh_tunnel_manager: SshTunnelManager,
    ssh_timeout_config: SshTimeoutConfig,
    aws_config: Option<SdkConfig>,
    runtime: Handle,
}
Expand description

A client context that supports rewriting broker addresses.

Fields§

§inner: C§rewrites: Arc<Mutex<BTreeMap<BrokerAddr, BrokerRewriteHandle>>>§default_tunnel: TunnelConfig§in_task: InTask§ssh_tunnel_manager: SshTunnelManager§ssh_timeout_config: SshTimeoutConfig§aws_config: Option<SdkConfig>§runtime: Handle

Implementations§

Source§

impl<C> TunnelingClientContext<C>

Source

pub fn new( inner: C, runtime: Handle, ssh_tunnel_manager: SshTunnelManager, ssh_timeout_config: SshTimeoutConfig, aws_config: Option<SdkConfig>, in_task: InTask, ) -> TunnelingClientContext<C>

Constructs a new context that wraps inner.

Source

pub fn set_default_tunnel(&mut self, tunnel: TunnelConfig)

Adds the default broker rewrite rule.

Connections to brokers that aren’t specified in other rewrites will be rewritten to connect to rewrite_host and rewrite_port instead.

Source

pub async fn add_ssh_tunnel( &self, broker: BrokerAddr, tunnel: SshTunnelConfig, ) -> Result<(), Error>

Adds an SSH tunnel for a specific broker.

Overrides the existing SSH tunnel or rewrite for this broker, if any.

This tunnel allows the rewrite to evolve over time, for example, if the ssh tunnel’s address changes if it fails and restarts.

Source

pub fn add_broker_rewrite(&self, broker: BrokerAddr, rewrite: BrokerRewrite)

Adds a broker rewrite rule.

Overrides the existing SSH tunnel or rewrite for this broker, if any.

rewrite is BrokerRewrite that specifies how to rewrite the address for broker.

Source

pub fn inner(&self) -> &C

Returns a reference to the wrapped context.

Source

pub fn tunnel_status(&self) -> SshTunnelStatus

Returns a consolidated SshTunnelStatus that communicates the status of all active ssh tunnels self knows about.

Trait Implementations§

Source§

impl<C> ClientContext for TunnelingClientContext<C>
where C: ClientContext,

Source§

const ENABLE_REFRESH_OAUTH_TOKEN: bool = true

Whether to periodically refresh the SASL OAUTHBEARER token by calling ClientContext::generate_oauth_token. Read more
Source§

fn generate_oauth_token( &self, _oauthbearer_config: Option<&str>, ) -> Result<OAuthToken, Box<dyn Error>>

Generates an OAuth token from the provided configuration. Read more
Source§

fn resolve_broker_addr( &self, host: &str, port: u16, ) -> Result<Vec<SocketAddr>, Error>

Performs DNS resolution on a broker address. Read more
Source§

fn log(&self, level: RDKafkaLogLevel, fac: &str, log_message: &str)

Receives log lines from librdkafka. Read more
Source§

fn error(&self, error: KafkaError, reason: &str)

Receives global errors from the librdkafka client. Read more
Source§

fn stats(&self, statistics: Statistics)

Receives the decoded statistics of the librdkafka client. To enable, the statistics.interval.ms configuration parameter must be specified. Read more
Source§

fn stats_raw(&self, statistics: &[u8])

Receives the JSON-encoded statistics of the librdkafka client. To enable, the statistics.interval.ms configuration parameter must be specified. Read more
Source§

impl<C: Clone> Clone for TunnelingClientContext<C>

Source§

fn clone(&self) -> TunnelingClientContext<C>

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<C> ConsumerContext for TunnelingClientContext<C>
where C: ConsumerContext,

Source§

fn rebalance( &self, native_client: &NativeClient, err: RDKafkaRespErr, tpl: &mut TopicPartitionList, )

Implements the default rebalancing strategy and calls the pre_rebalance and post_rebalance methods. If this method is overridden, it will be responsibility of the user to call them if needed.
Source§

fn pre_rebalance<'a>(&self, rebalance: &Rebalance<'a>)

Pre-rebalance callback. This method will run before the rebalance and should terminate its execution quickly.
Source§

fn post_rebalance<'a>(&self, rebalance: &Rebalance<'a>)

Post-rebalance callback. This method will run after the rebalance and should terminate its execution quickly.
Source§

fn commit_callback(&self, result: KafkaResult<()>, offsets: &TopicPartitionList)

Post commit callback. This method will run after a group of offsets was committed to the offset store.
Source§

fn main_queue_min_poll_interval(&self) -> Timeout

Returns the minimum interval at which to poll the main queue, which services the logging, stats, and error callbacks. Read more
Source§

impl<C> ProducerContext for TunnelingClientContext<C>
where C: ProducerContext,

Source§

type DeliveryOpaque = <C as ProducerContext>::DeliveryOpaque

A DeliveryOpaque is a user-defined structure that will be passed to the producer when producing a message, and returned to the delivery method once the message has been delivered, or failed to.
Source§

fn delivery( &self, delivery_result: &DeliveryResult<'_>, delivery_opaque: Self::DeliveryOpaque, )

This method will be called once the message has been delivered (or failed to). The DeliveryOpaque will be the one provided by the user when calling send.

Auto Trait Implementations§

§

impl<C> Freeze for TunnelingClientContext<C>
where C: Freeze,

§

impl<C> !RefUnwindSafe for TunnelingClientContext<C>

§

impl<C> Send for TunnelingClientContext<C>
where C: Send,

§

impl<C> Sync for TunnelingClientContext<C>
where C: Sync,

§

impl<C> Unpin for TunnelingClientContext<C>
where C: Unpin,

§

impl<C> !UnwindSafe for TunnelingClientContext<C>

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<T, U> CastInto<U> for T
where U: CastFrom<T>,

Source§

fn cast_into(self) -> U

Performs the cast.
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize = _

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = 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.
Source§

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

Source§

fn vzip(self) -> V

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