pub struct ChannelInner { /* private fields */ }Expand description
Shared state for a Channel - handles I/O, async message queueing, and response tracking.
ChannelInner is the “heavy” part of a channel that is shared via ArcMut across
multiple Channel clones. It manages:
- Connection: Low-level TCP I/O
- Send Queue: Async message queueing to decouple caller from I/O backpressure
- Response Table: Tracks pending request-response pairs (opaque ID → future)
§Threading Model
- Send Task: Dedicated task (
handle_send) pulls from queue and writes to connection - Response Tracking: Shared map accessed by send task (insert) and receive task (remove)
§Lifecycle
- Created: Spawns background
handle_sendtask - Active: Processes send queue, tracks responses
- Shutdown: Queue closed, pending responses canceled
Implementations§
Source§impl ChannelInner
impl ChannelInner
Sourcepub fn new(
connection: Connection,
response_table: ArcMut<HashMap<i32, ResponseFuture>>,
) -> Self
pub fn new( connection: Connection, response_table: ArcMut<HashMap<i32, ResponseFuture>>, ) -> Self
Creates a new ChannelInner and spawns the background send task.
§Arguments
connection- The underlying TCP connectionresponse_table- Shared response tracking map
§Returns
A new ChannelInner with an active background send task.
§Implementation Note
- Queue capacity: 1024 messages (adjust based on load)
- Spawns
handle_sendtask immediately - Task runs until channel is dropped or connection fails
§Performance
Uses flume::bounded channel for better performance:
- Lock-free operations for most cases
- ~40-60% higher throughput than tokio::mpsc
- Better performance under contention
Source§impl ChannelInner
impl ChannelInner
Sourcepub fn connection(&self) -> ArcMut<Connection>
pub fn connection(&self) -> ArcMut<Connection>
Gets a cloned ArcMut handle to the connection.
§Returns
Shared mutable reference to the connection (cheap clone, increments refcount)
Sourcepub fn connection_ref(&self) -> &Connection
pub fn connection_ref(&self) -> &Connection
Gets an immutable reference to the connection.
§Returns
Immutable reference to the underlying Connection
Sourcepub fn connection_mut(&mut self) -> &mut Connection
pub fn connection_mut(&mut self) -> &mut Connection
Sourcepub async fn send_wait_response(
&mut self,
request: RemotingCommand,
timeout_millis: u64,
) -> RocketMQResult<RemotingCommand>
pub async fn send_wait_response( &mut self, request: RemotingCommand, timeout_millis: u64, ) -> RocketMQResult<RemotingCommand>
Sends a request and waits for the response (request-response pattern).
Enqueues the request, tracks it via opaque ID, and blocks until the response arrives or timeout expires.
§Arguments
request- The command to sendtimeout_millis- Maximum wait time for response (milliseconds)
§Returns
Ok(response): Response received within timeoutErr(ChannelSendRequestFailed): Failed to enqueue requestErr(ChannelRecvRequestFailed): Response channel closed or timeout
§Lifecycle
- Create oneshot channel for response
- Enqueue request with response channel
- Wait (with timeout) for response on channel
- Clean up response table on error
§Example
let request = RemotingCommand::create_request_command(10, header).into();
let response = channel_inner.send_wait_response(request, 3000).await?;
println!("Got response: {:?}", response);Sourcepub async fn send_oneway(
&self,
request: RemotingCommand,
timeout_millis: u64,
) -> RocketMQResult<()>
pub async fn send_oneway( &self, request: RemotingCommand, timeout_millis: u64, ) -> RocketMQResult<()>
Sends a one-way request without waiting for response (fire-and-forget).
Marks the request as oneway and enqueues it. Does not track response.
§Arguments
request- The command to sendtimeout_millis- Timeout for enqueuing (not for response)
§Returns
Ok(().into()): Request successfully enqueuedErr(ChannelSendRequestFailed): Failed to enqueue
§Use Case
Notifications, heartbeats, or any scenario where response is not needed.
More efficient than send_wait_response as it avoids response tracking overhead.
Sourcepub async fn send(
&self,
request: RemotingCommand,
timeout_millis: Option<u64>,
) -> RocketMQResult<()>
pub async fn send( &self, request: RemotingCommand, timeout_millis: Option<u64>, ) -> RocketMQResult<()>
Sends a request without waiting for response (async enqueue only).
Similar to send_oneway, but does not mark the request as oneway.
Use when caller doesn’t care about response but request is not marked as oneway protocol.
§Arguments
request- The command to sendtimeout_millis- Optional timeout for enqueuing
§Returns
Ok(()): Request successfully enqueuedErr(ChannelSendRequestFailed): Failed to enqueue
Sourcepub fn is_healthy(&self) -> bool
pub fn is_healthy(&self) -> bool
Checks if the underlying connection is healthy.
§Returns
true: Connection is operationalfalse: Connection has failed, channel should be discarded
Auto Trait Implementations§
impl Freeze for ChannelInner
impl !RefUnwindSafe for ChannelInner
impl Send for ChannelInner
impl Sync for ChannelInner
impl Unpin for ChannelInner
impl !UnwindSafe for ChannelInner
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
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.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> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
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
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
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
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.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
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.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
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.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
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.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
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.