pub(super) struct StreamMap {
open_streams: StreamPollSet<StreamId, Priority, OpenStreamEntStream>,
closed_streams: HashMap<StreamId, ClosedStreamEnt>,
next_stream_id: StreamId,
next_priority: Priority,
}
Expand description
A map from stream IDs to stream entries. Each circuit has one for each hop.
Fields§
§open_streams: StreamPollSet<StreamId, Priority, OpenStreamEntStream>
Open streams.
closed_streams: HashMap<StreamId, ClosedStreamEnt>
Closed streams.
next_stream_id: StreamId
The next StreamId that we should use for a newly allocated circuit.
next_priority: Priority
Next priority to use in rxs
. We implement round-robin scheduling of
handling outgoing messages from streams by assigning a stream the next
priority whenever an outgoing message is processed from that stream,
putting it last in line.
Implementations§
Source§impl StreamMap
impl StreamMap
Sourcepub(super) fn n_open_streams(&self) -> usize
pub(super) fn n_open_streams(&self) -> usize
Return the number of open streams in this map.
Sourcefn take_next_priority(&mut self) -> Priority
fn take_next_priority(&mut self) -> Priority
Return the next available priority.
Sourcepub(super) fn add_ent(
&mut self,
sink: Sender<UnparsedRelayMsg, MpscSpec>,
rx: Receiver<AnyRelayMsg, MpscSpec>,
flow_ctrl: StreamSendFlowControl,
cmd_checker: Box<dyn CmdChecker + Send + 'static>,
) -> Result<StreamId>
pub(super) fn add_ent( &mut self, sink: Sender<UnparsedRelayMsg, MpscSpec>, rx: Receiver<AnyRelayMsg, MpscSpec>, flow_ctrl: StreamSendFlowControl, cmd_checker: Box<dyn CmdChecker + Send + 'static>, ) -> Result<StreamId>
Add an entry to this map; return the newly allocated StreamId.
Sourcepub(super) fn add_ent_with_id(
&mut self,
sink: Sender<UnparsedRelayMsg, MpscSpec>,
rx: Receiver<AnyRelayMsg, MpscSpec>,
flow_ctrl: StreamSendFlowControl,
id: StreamId,
cmd_checker: Box<dyn CmdChecker + Send + 'static>,
) -> Result<()>
Available on crate feature hs-service
only.
pub(super) fn add_ent_with_id( &mut self, sink: Sender<UnparsedRelayMsg, MpscSpec>, rx: Receiver<AnyRelayMsg, MpscSpec>, flow_ctrl: StreamSendFlowControl, id: StreamId, cmd_checker: Box<dyn CmdChecker + Send + 'static>, ) -> Result<()>
hs-service
only.Add an entry to this map using the specified StreamId.
Sourcepub(super) fn get_mut(&mut self, id: StreamId) -> Option<StreamEntMut<'_>>
pub(super) fn get_mut(&mut self, id: StreamId) -> Option<StreamEntMut<'_>>
Return the entry for id
in this map, if any.
Sourcepub(super) fn ending_msg_received(&mut self, id: StreamId) -> Result<()>
pub(super) fn ending_msg_received(&mut self, id: StreamId) -> Result<()>
Note that we received an END message (or other message indicating the end of
the stream) on the stream with id
.
Returns true if there was really a stream there.
Sourcepub(super) fn terminate(
&mut self,
id: StreamId,
why: TerminateReason,
) -> Result<ShouldSendEnd>
pub(super) fn terminate( &mut self, id: StreamId, why: TerminateReason, ) -> Result<ShouldSendEnd>
Handle a termination of the stream with id
from this side of
the circuit. Return true if the stream was open and an END
ought to be sent.
Sourcepub(super) fn poll_ready_streams_iter<'a>(
&'a mut self,
cx: &mut Context<'_>,
) -> impl Iterator<Item = (StreamId, Option<&'a AnyRelayMsg>)> + 'a
pub(super) fn poll_ready_streams_iter<'a>( &'a mut self, cx: &mut Context<'_>, ) -> impl Iterator<Item = (StreamId, Option<&'a AnyRelayMsg>)> + 'a
Get an up-to-date iterator of streams with ready items. Option<AnyRelayMsg>::None
indicates that the local sender has been dropped.
Conceptually all streams are in a queue; new streams are added to the
back of the queue, and a stream is sent to the back of the queue
whenever a ready message is taken from it (via
Self::take_ready_msg
). The returned iterator is an ordered view of
this queue, showing the subset of streams that have a message ready to
send, or whose sender has been dropped.
Sourcepub(super) fn take_ready_msg(&mut self, sid: StreamId) -> Option<AnyRelayMsg>
pub(super) fn take_ready_msg(&mut self, sid: StreamId) -> Option<AnyRelayMsg>
If the stream sid
has a message ready, take it, and reprioritize sid
to the “back of the line” with respect to
Self::poll_ready_streams_iter
.
Auto Trait Implementations§
impl Freeze for StreamMap
impl !RefUnwindSafe for StreamMap
impl Send for StreamMap
impl !Sync for StreamMap
impl Unpin for StreamMap
impl !UnwindSafe for StreamMap
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
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
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
, which can then be
downcast
into Box<dyn ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
, which can then be further
downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.§impl<T> DowncastSend for T
impl<T> DowncastSend for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§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.§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.§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.§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.§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.§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.§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.§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.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§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> 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>
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>
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 more§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§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 more§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 more§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
§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
§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.§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.§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.§impl<T> Tap for T
impl<T> Tap for T
§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 more§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 more§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 more§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 more§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 more§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 more§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.§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.§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.§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.§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.§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.§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.