Skip to main content

ClientConfig

Struct ClientConfig 

Source
pub struct ClientConfig {
Show 34 fields pub namesrv_addr: Option<CheetahString>, pub client_ip: Option<CheetahString>, pub instance_name: CheetahString, pub client_callback_executor_threads: usize, pub namespace: Option<CheetahString>, pub namespace_initialized: Arc<AtomicBool>, pub namespace_v2: Option<CheetahString>, pub access_channel: AccessChannel, pub poll_name_server_interval: u32, pub heartbeat_broker_interval: u32, pub persist_consumer_offset_interval: u32, pub pull_time_delay_millis_when_exception: u32, pub unit_mode: bool, pub unit_name: Option<CheetahString>, pub decode_read_body: bool, pub decode_decompress_body: bool, pub vip_channel_enabled: bool, pub use_heartbeat_v2: bool, pub enable_concurrent_heartbeat: bool, pub use_tls: bool, pub socks_proxy_config: CheetahString, pub mq_client_api_timeout: u64, pub detect_timeout: u32, pub detect_interval: u32, pub language: LanguageCode, pub enable_stream_request_type: bool, pub send_latency_enable: bool, pub start_detector_enable: bool, pub enable_heartbeat_channel_event_listener: bool, pub enable_trace: bool, pub trace_topic: Option<CheetahString>, pub trace_msg_batch_num: usize, pub max_page_size_in_get_metadata: usize, pub concurrent_heartbeat_thread_pool_size: usize,
}

Fields§

§namesrv_addr: Option<CheetahString>§client_ip: Option<CheetahString>§instance_name: CheetahString§client_callback_executor_threads: usize§namespace: Option<CheetahString>§namespace_initialized: Arc<AtomicBool>§namespace_v2: Option<CheetahString>§access_channel: AccessChannel§poll_name_server_interval: u32§heartbeat_broker_interval: u32§persist_consumer_offset_interval: u32§pull_time_delay_millis_when_exception: u32§unit_mode: bool§unit_name: Option<CheetahString>§decode_read_body: bool§decode_decompress_body: bool§vip_channel_enabled: bool§use_heartbeat_v2: bool§enable_concurrent_heartbeat: bool§use_tls: bool§socks_proxy_config: CheetahString§mq_client_api_timeout: u64§detect_timeout: u32§detect_interval: u32§language: LanguageCode§enable_stream_request_type: bool§send_latency_enable: bool§start_detector_enable: bool§enable_heartbeat_channel_event_listener: bool§enable_trace: bool§trace_topic: Option<CheetahString>§trace_msg_batch_num: usize§max_page_size_in_get_metadata: usize§concurrent_heartbeat_thread_pool_size: usize

Thread pool size for concurrent heartbeat operations. Only effective when enable_concurrent_heartbeat is true. Default: number of CPU cores (matches Java: Runtime.getRuntime().availableProcessors())

Implementations§

Source§

impl ClientConfig

Source

pub const SEND_MESSAGE_WITH_VIP_CHANNEL_PROPERTY: &'static str = "com.rocketmq.sendMessageWithVIPChannel"

Source

pub const SOCKS_PROXY_CONFIG: &'static str = "com.rocketmq.socks.proxy.config"

Source

pub const DECODE_READ_BODY: &'static str = "com.rocketmq.read.body"

Source

pub const DECODE_DECOMPRESS_BODY: &'static str = "com.rocketmq.decompress.body"

Source

pub const SEND_LATENCY_ENABLE: &'static str = "com.rocketmq.sendLatencyEnable"

Source

pub const START_DETECTOR_ENABLE: &'static str = "com.rocketmq.startDetectorEnable"

Source

pub const HEART_BEAT_V2: &'static str = "com.rocketmq.heartbeat.v2"

Source

pub const ENABLE_CONCURRENT_HEARTBEAT: &'static str = "com.rocketmq.enableConcurrentHeartbeat"

Source

pub fn new() -> Self

Source§

impl ClientConfig

Source

pub fn with_namespace( &mut self, resource: impl Into<CheetahString>, ) -> CheetahString

Source

pub fn queue_with_namespace(&mut self, queue: MessageQueue) -> MessageQueue

Source

pub fn get_namespace(&mut self) -> Option<CheetahString>

Source

pub fn change_instance_name_to_pid(&mut self)

Source

pub fn set_instance_name(&mut self, instance_name: CheetahString)

Source

pub fn set_namesrv_addr(&mut self, namesrv_addr: CheetahString)

Source

pub fn build_mq_client_id(&self) -> String

Source

pub fn get_namesrv_addr(&self) -> Option<CheetahString>

Source

pub fn get_client_ip(&self) -> Option<&CheetahString>

Source

pub fn set_client_ip(&mut self, client_ip: CheetahString)

Source

pub fn get_instance_name(&self) -> &CheetahString

Source

pub fn get_client_callback_executor_threads(&self) -> usize

Source

pub fn set_client_callback_executor_threads(&mut self, threads: usize)

Source

pub fn get_namespace_v2(&self) -> Option<&CheetahString>

Source

pub fn set_namespace_v2(&mut self, namespace_v2: CheetahString)

Source

pub fn set_namespace(&mut self, namespace: CheetahString)

Source

pub fn get_access_channel(&self) -> AccessChannel

Source

pub fn set_access_channel(&mut self, access_channel: AccessChannel)

Source

pub fn get_poll_name_server_interval(&self) -> u32

Source

pub fn set_poll_name_server_interval(&mut self, interval: u32)

Source

pub fn get_heartbeat_broker_interval(&self) -> u32

Source

pub fn set_heartbeat_broker_interval(&mut self, interval: u32)

Source

pub fn get_persist_consumer_offset_interval(&self) -> u32

Source

pub fn set_persist_consumer_offset_interval(&mut self, interval: u32)

Source

pub fn get_pull_time_delay_millis_when_exception(&self) -> u32

Source

pub fn set_pull_time_delay_millis_when_exception(&mut self, delay: u32)

Source

pub fn get_unit_name(&self) -> Option<&CheetahString>

Source

pub fn set_unit_name(&mut self, unit_name: CheetahString)

Source

pub fn is_unit_mode(&self) -> bool

Source

pub fn set_unit_mode(&mut self, unit_mode: bool)

Source

pub fn is_decode_read_body(&self) -> bool

Source

pub fn set_decode_read_body(&mut self, decode_read_body: bool)

Source

pub fn is_decode_decompress_body(&self) -> bool

Source

pub fn set_decode_decompress_body(&mut self, decode_decompress_body: bool)

Source

pub fn is_vip_channel_enabled(&self) -> bool

Source

pub fn set_vip_channel_enabled(&mut self, enabled: bool)

Source

pub fn is_use_heartbeat_v2(&self) -> bool

Source

pub fn set_use_heartbeat_v2(&mut self, use_heartbeat_v2: bool)

Source

pub fn is_use_tls(&self) -> bool

Source

pub fn set_use_tls(&mut self, use_tls: bool)

Source

pub fn get_socks_proxy_config(&self) -> &CheetahString

Source

pub fn set_socks_proxy_config(&mut self, config: CheetahString)

Source

pub fn get_language(&self) -> LanguageCode

Source

pub fn set_language(&mut self, language: LanguageCode)

Source

pub fn get_mq_client_api_timeout(&self) -> u64

Source

pub fn set_mq_client_api_timeout(&mut self, timeout: u64)

Source

pub fn get_detect_timeout(&self) -> u32

Source

pub fn set_detect_timeout(&mut self, timeout: u32)

Source

pub fn get_detect_interval(&self) -> u32

Source

pub fn set_detect_interval(&mut self, interval: u32)

Source

pub fn is_enable_stream_request_type(&self) -> bool

Source

pub fn set_enable_stream_request_type(&mut self, enabled: bool)

Source

pub fn is_send_latency_enable(&self) -> bool

Source

pub fn set_send_latency_enable(&mut self, enabled: bool)

Source

pub fn is_start_detector_enable(&self) -> bool

Source

pub fn set_start_detector_enable(&mut self, enabled: bool)

Source

pub fn is_enable_heartbeat_channel_event_listener(&self) -> bool

Source

pub fn set_enable_heartbeat_channel_event_listener(&mut self, enabled: bool)

Source

pub fn is_enable_trace(&self) -> bool

Source

pub fn set_enable_trace(&mut self, enabled: bool)

Source

pub fn get_trace_topic(&self) -> Option<&CheetahString>

Source

pub fn set_trace_topic(&mut self, topic: CheetahString)

Source

pub fn get_trace_msg_batch_num(&self) -> usize

Source

pub fn set_trace_msg_batch_num(&mut self, num: usize)

Source

pub fn get_max_page_size_in_get_metadata(&self) -> usize

Source

pub fn set_max_page_size_in_get_metadata(&mut self, size: usize)

Source

pub fn get_concurrent_heartbeat_thread_pool_size(&self) -> usize

Source

pub fn set_concurrent_heartbeat_thread_pool_size(&mut self, size: usize)

Source

pub fn clone_client_config(&self) -> Self

Clones the configuration

Source

pub fn reset_client_config(&mut self, other: &ClientConfig)

Resets client config from another instance

Source

pub fn without_namespace(&mut self, resource: &str) -> CheetahString

👎Deprecated:

Use with_namespace for namespace wrapping

Deprecated: Use with_namespace instead

Source

pub fn builder() -> ClientConfigBuilder

Creates a new builder for constructing a ClientConfig with a fluent API

§Example
use rocketmq_client_rust::base::client_config::ClientConfig;

let config = ClientConfig::builder()
    .namesrv_addr("localhost:9876")
    .instance_name("my_producer")
    .enable_tls(true)
    .build()
    .unwrap();

Trait Implementations§

Source§

impl Clone for ClientConfig

Source§

fn clone(&self) -> ClientConfig

Returns a duplicate 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 Default for ClientConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Display for ClientConfig

Source§

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

Formats the value using the given formatter. 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
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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T> ToStringFallible for T
where T: Display,

Source§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. 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<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