Struct TunnelingClientContext

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,
}

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

impl<C> TunnelingClientContext<C>

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.

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.

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.

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.

pub fn inner(&self) -> &C

Returns a reference to the wrapped context.

pub fn tunnel_status(&self) -> SshTunnelStatus

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

Trait Implementations

impl<C> ClientContext for TunnelingClientContext<C>

where C: ClientContext,

const ENABLE_REFRESH_OAUTH_TOKEN: bool = true

Whether to periodically refresh the SASL OAUTHBEARER token by calling ClientContext::generate_oauth_token.

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

Generates an OAuth token from the provided configuration.

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

Performs DNS resolution on a broker address.

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

Receives log lines from librdkafka.

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

Receives global errors from the librdkafka client.

fn stats(&self, statistics: Statistics)

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

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.

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C> ConsumerContext for TunnelingClientContext<C>

where C: ConsumerContext,

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.

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

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

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

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

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.

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.

impl<C> ProducerContext for TunnelingClientContext<C>

where C: ProducerContext,

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.

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.