Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding remaining() and capacity() methods to Sender and Receiver #71

Closed
jcrevier opened this issue Oct 4, 2022 · 4 comments · Fixed by #72
Closed

Adding remaining() and capacity() methods to Sender and Receiver #71

jcrevier opened this issue Oct 4, 2022 · 4 comments · Fixed by #72
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@jcrevier
Copy link
Contributor

jcrevier commented Oct 4, 2022

Hello! This crate is very neat. It would be very helpful for metrics if mpsc::Sender and mpsc::Receiver channel handles exposed a way to determine the capacity and remaining slots. The ThingBuf queue has a remaining() and a capacity() method, so it seems odd that Sender or Receiver don't. I'm open to writing up a PR to add this, but I noticed that the implementation of Sender and Receiver was a bit different than ThingBuf -- is there any reason these weren't exposed? From a quick glance it seems like they would be easy to add to Sender and Receiver by just using the len() and capacity() methods from self.inner.core.core
@jcrevier jcrevier changed the title Adding remaining and capacity methods to Sender and Receiver Adding remaining() and capacity() methods to Sender and Receiver Oct 4, 2022
@jcrevier jcrevier changed the title Adding remaining() and capacity() methods to Sender and Receiver Adding remaining() and capacity() methods to Sender and Receiver Oct 4, 2022
@hawkw
Copy link
Owner

hawkw commented Oct 4, 2022

Yes, I believe it should be possible to add these methods by just forwarding them from the Core type; not having them on MPSC channels was just an oversight on my part, I think. I'd happily merge a PR that adds them!

@hawkw hawkw added enhancement New feature or request good first issue Good for newcomers labels Oct 4, 2022
jcrevier pushed a commit to jcrevier/thingbuf that referenced this issue Oct 5, 2022
feat(mpsc): add len, capacity, and remaining methods to `Sender…
8a8ae5a 
…` and `Receiver` (hawkw#71)
jcrevier pushed a commit to jcrevier/thingbuf that referenced this issue Oct 5, 2022
feat(mpsc): add len, capacity, and remaining methods to mpsc (h…
71deef5 
…awkw#71)
jcrevier pushed a commit to jcrevier/thingbuf that referenced this issue Oct 5, 2022
feat(mpsc): add len, capacity, and remaining methods to mpsc (h…
5a8a644 
…awkw#71)
jcrevier pushed a commit to jcrevier/thingbuf that referenced this issue Oct 5, 2022
fixup! feat(mpsc): add len, capacity, and remaining methods to …
34b0e9e 
…mpsc (hawkw#71)
jcrevier pushed a commit to jcrevier/thingbuf that referenced this issue Oct 5, 2022
feat(mpsc): add len, capacity, and remaining methods to mpsc (h…
6b7f22f 
…awkw#71)
@jcrevier jcrevier mentioned this issue Oct 5, 2022
Merged
jcrevier pushed a commit to jcrevier/thingbuf that referenced this issue Oct 6, 2022
feat(mpsc): add len, capacity, and related methods to mpsc (hawkw#71
6b5e0c3 
)
jcrevier pushed a commit to jcrevier/thingbuf that referenced this issue Oct 6, 2022
feat(mpsc): add len, capacity, and related methods to mpsc (hawkw#71
cfd9439 
)
@kiranshila
Copy link

Just wanted to give this a quick bump - the PR looks to be in decent shape. If there is anything I can do to help get it merged, let me know - as it would be very useful for one of my projects!

@jcrevier
Copy link
Contributor Author

jcrevier commented Feb 6, 2023

@kiranshila so I think the only real blocker is that there's some weird behavior around the len() method that merging this PR would expose -- I think when dropping the channel. See the failing doc tests in the PR. Eliza was going to look into it, and I was also going to try to look into it..I haven't had the time and I suspect the same for Eliza.

@hawkw hawkw closed this as completed in #72 Apr 6, 2024
hawkw added a commit that referenced this issue Apr 6, 2024
@jcrevier @hawkw
feat(mpsc): add len, capacity, and remaining methods to mpsc (#72)
00213c1 
Currently, there is no way to get the total capacity, remaining
capacity, or used length of a MPSC channel. This PR adds the following
methods to `mps::Sender`, `mpsc::Receiver`, `mpsc::StaticSender`,
`mpsc::StaticReceiver`, and their `mpsc::blocking` equivalents:

- `capacity`: Returns the total capacity of a channel, including used
  capacity.
- `len`: Returns the number of messages currently in a channel.
- `remaining`: Returns the current _free_ capacity of a channel
  (`capacity - len`).
- `is_empty`: Returns `true` if there are no messages in a channel.

Additionally, I've fixed a bug in `Core::len` where, if the channel is
closed and contains zero messages, the length returned is equal to its
capacity rather than 0. This is due to the `Core::len` function
incorrectly testing whether `head == tail` without masking out the
`closed` bit, which may be set in either `head` or `tail` when a channel
closes. This causes us to believe a closed channel is full when it's
actually empty. I've added tests reproducing this.

Fixes #71

---------

Co-authored-by: Joel Crevier <jcrevier@dragos.com>
Co-authored-by: Eliza Weisman <eliza@elizas.website>
@jcrevier
Copy link
Contributor Author

jcrevier commented Apr 6, 2024

Glad to see this merged 😄 🎉

hawkw added a commit that referenced this issue Apr 6, 2024
@hawkw
chore: prepare to release v0.1.5
c8e2a73 
## v0.1.5 (2024-04-06)

#### Features

* **mpsc:**  add `len`, `capacity`, and `remaining` methods to mpsc (#72) ([00213c1](00213c1), closes [#71](#71))

#### Bug Fixes

*   unused import with `alloc` enabled ([ac1eafc](ac1eafc))
*   skip slots with active reading `Ref`s in `push_ref` (#81) ([a72a286](a72a286), closes [#83](#83), [#80](#80))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(mpsc): add len, capacity, and remaining methods to mpsc jcrevier/thingbuf
3 participants
@hawkw @kiranshila @jcrevier