Change the function to retrieve used buffer instead of available buffer #114
Conversation
The status of the used receive buffer is more helpful for users when configuring credit updates.
| /// | ||
| /// When the used bytes is 0, it indicates that the receive buffer is empty and does not | ||
| /// contain any data. | ||
| pub fn recv_buffer_used_bytes(&mut self, peer: VsockAddr, src_port: u32) -> Result<usize> { |
There was a problem hiding this comment.
The behaviour is now good, but I think we should call it available, because from the point of view of the caller it is the number of bytes which are available to read. I'll upload another commit to fix this.
There was a problem hiding this comment.
I feel it confusing to call it available. Especially the same word is used in the same function to indicate the free space in buffer .
There was a problem hiding this comment.
Fair point about the method on RingBuffer, we could rename that to free or something if you like. But I really think that 'available' is the best word for the number of bytes which are ready to be read by the caller. The caller shouldn't usually need to care about the details of how the buffering works, all it needs to know is how much data is available to read.
There was a problem hiding this comment.
The caller shouldn't usually need to care about the details of how the buffering works, all it needs to know is how much data is available to read.
Agreed. I just don't like using "available" twice in the same code to convey two contradictory meanings for the buffer. It's easier to understand if we adopt consistent naming, or include available_to_read in the name.
There was a problem hiding this comment.
Okay, uploaded #115, PTAL.
The status of the used receive buffer is more helpful for users when configuring credit updates.