Add reference counting to SocketSet.
This commit is contained in:
parent
74d1eb86b6
commit
ac38ddd936
|
@ -2,6 +2,17 @@ use managed::ManagedSlice;
|
|||
use core::slice;
|
||||
|
||||
use super::Socket;
|
||||
use super::TcpState;
|
||||
|
||||
/// An item of a socket set.
|
||||
///
|
||||
/// The only reason this struct is public is to allow the socket set storage
|
||||
/// to be allocated externally.
|
||||
#[derive(Debug)]
|
||||
pub struct Item<'a, 'b: 'a> {
|
||||
socket: Socket<'a, 'b>,
|
||||
refs: usize
|
||||
}
|
||||
|
||||
/// A handle, identifying a socket in a set.
|
||||
#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Clone, Copy)]
|
||||
|
@ -10,31 +21,39 @@ pub struct Handle {
|
|||
}
|
||||
|
||||
/// An extensible set of sockets, with stable numeric identifiers.
|
||||
///
|
||||
/// The lifetimes `'b` and `'c` are used when storing a `Socket<'b, 'c>`.
|
||||
#[derive(Debug)]
|
||||
pub struct Set<'a, 'b: 'a, 'c: 'a + 'b> {
|
||||
sockets: ManagedSlice<'a, Option<Socket<'b, 'c>>>
|
||||
sockets: ManagedSlice<'a, Option<Item<'b, 'c>>>
|
||||
}
|
||||
|
||||
impl<'a, 'b: 'a, 'c: 'a + 'b> Set<'a, 'b, 'c> {
|
||||
/// Create a socket set using the provided storage.
|
||||
pub fn new<SocketsT>(sockets: SocketsT) -> Set<'a, 'b, 'c>
|
||||
where SocketsT: Into<ManagedSlice<'a, Option<Socket<'b, 'c>>>> {
|
||||
where SocketsT: Into<ManagedSlice<'a, Option<Item<'b, 'c>>>> {
|
||||
let sockets = sockets.into();
|
||||
Set {
|
||||
sockets: sockets
|
||||
}
|
||||
}
|
||||
|
||||
/// Add a socket to the set, and return its handle.
|
||||
/// Add a socket to the set with the reference count 1, and return its handle.
|
||||
///
|
||||
/// # Panics
|
||||
/// This function panics if the storage is fixed-size (not a `Vec`) and is full.
|
||||
pub fn add(&mut self, mut socket: Socket<'b, 'c>) -> Handle {
|
||||
pub fn add(&mut self, socket: Socket<'b, 'c>) -> Handle {
|
||||
fn put<'b, 'c>(index: usize, slot: &mut Option<Item<'b, 'c>>,
|
||||
mut socket: Socket<'b, 'c>) -> Handle {
|
||||
net_trace!("[{}]: adding", index);
|
||||
socket.set_debug_id(index);
|
||||
*slot = Some(Item { socket: socket, refs: 1 });
|
||||
return Handle { index: index }
|
||||
}
|
||||
|
||||
for (index, slot) in self.sockets.iter_mut().enumerate() {
|
||||
if slot.is_none() {
|
||||
socket.set_debug_id(index);
|
||||
*slot = Some(socket);
|
||||
return Handle { index: index }
|
||||
return put(index, slot, socket)
|
||||
}
|
||||
}
|
||||
|
||||
|
@ -43,12 +62,12 @@ impl<'a, 'b: 'a, 'c: 'a + 'b> Set<'a, 'b, 'c> {
|
|||
panic!("adding a socket to a full SocketSet")
|
||||
}
|
||||
ManagedSlice::Owned(ref mut sockets) => {
|
||||
let index = sockets.len();
|
||||
socket.set_debug_id(index);
|
||||
sockets.push(Some(socket));
|
||||
Handle { index: index }
|
||||
sockets.push(None);
|
||||
let index = sockets.len() - 1;
|
||||
return put(index, &mut sockets[index], socket)
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
/// Get a socket from the set by its handle.
|
||||
|
@ -56,9 +75,10 @@ impl<'a, 'b: 'a, 'c: 'a + 'b> Set<'a, 'b, 'c> {
|
|||
/// # Panics
|
||||
/// This function may panic if the handle does not belong to this socket set.
|
||||
pub fn get(&self, handle: Handle) -> &Socket<'b, 'c> {
|
||||
self.sockets[handle.index]
|
||||
.as_ref()
|
||||
.expect("handle does not refer to a valid socket")
|
||||
&self.sockets[handle.index]
|
||||
.as_ref()
|
||||
.expect("handle does not refer to a valid socket")
|
||||
.socket
|
||||
}
|
||||
|
||||
/// Get a socket from the set by its handle, as mutable.
|
||||
|
@ -66,18 +86,69 @@ impl<'a, 'b: 'a, 'c: 'a + 'b> Set<'a, 'b, 'c> {
|
|||
/// # Panics
|
||||
/// This function may panic if the handle does not belong to this socket set.
|
||||
pub fn get_mut(&mut self, handle: Handle) -> &mut Socket<'b, 'c> {
|
||||
self.sockets[handle.index]
|
||||
.as_mut()
|
||||
.expect("handle does not refer to a valid socket")
|
||||
&mut self.sockets[handle.index]
|
||||
.as_mut()
|
||||
.expect("handle does not refer to a valid socket")
|
||||
.socket
|
||||
}
|
||||
|
||||
/// Remove a socket from the set, without changing its state.
|
||||
///
|
||||
/// # Panics
|
||||
/// This function may panic if the handle does not belong to this socket set.
|
||||
pub fn remove(&mut self, handle: Handle) {
|
||||
assert!(self.sockets[handle.index].is_some());
|
||||
self.sockets[handle.index] = None
|
||||
pub fn remove(&mut self, handle: Handle) -> Socket<'b, 'c> {
|
||||
net_trace!("[{}]: removing", handle.index);
|
||||
match self.sockets[handle.index].take() {
|
||||
Some(item) => item.socket,
|
||||
None => panic!("handle does not refer to a valid socket")
|
||||
}
|
||||
}
|
||||
|
||||
/// Increase reference count by 1.
|
||||
///
|
||||
/// # Panics
|
||||
/// This function may panic if the handle does not belong to this socket set.
|
||||
pub fn retain(&mut self, handle: Handle) {
|
||||
self.sockets[handle.index]
|
||||
.as_mut()
|
||||
.expect("handle does not refer to a valid socket")
|
||||
.refs += 1
|
||||
}
|
||||
|
||||
/// Decrease reference count by 1.
|
||||
///
|
||||
/// # Panics
|
||||
/// This function may panic if the handle does not belong to this socket set,
|
||||
/// or if the reference count is already zero.
|
||||
pub fn release(&mut self, handle: Handle) {
|
||||
let refs = &mut self.sockets[handle.index]
|
||||
.as_mut()
|
||||
.expect("handle does not refer to a valid socket")
|
||||
.refs;
|
||||
if *refs == 0 { panic!("decreasing reference count past zero") }
|
||||
*refs -= 1
|
||||
}
|
||||
|
||||
/// Prune the sockets in this set.
|
||||
///
|
||||
/// Pruning affects sockets with reference count 0. Open sockets are closed.
|
||||
/// Closed sockets are removed and dropped.
|
||||
pub fn prune(&mut self) {
|
||||
for item in self.sockets.iter_mut() {
|
||||
let mut may_remove = false;
|
||||
if let &mut Some(Item { refs: 0, ref socket }) = item {
|
||||
match socket {
|
||||
&Socket::Udp(_) =>
|
||||
may_remove = true,
|
||||
&Socket::Tcp(ref socket) =>
|
||||
may_remove = socket.state() == TcpState::Closed,
|
||||
&Socket::__Nonexhaustive => unreachable!()
|
||||
}
|
||||
}
|
||||
if may_remove {
|
||||
*item = None
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Iterate every socket in this set.
|
||||
|
@ -96,16 +167,16 @@ impl<'a, 'b: 'a, 'c: 'a + 'b> Set<'a, 'b, 'c> {
|
|||
/// This struct is created by the [iter](struct.SocketSet.html#method.iter)
|
||||
/// on [socket sets](struct.SocketSet.html).
|
||||
pub struct Iter<'a, 'b: 'a, 'c: 'a + 'b> {
|
||||
lower: slice::Iter<'a, Option<Socket<'b, 'c>>>
|
||||
lower: slice::Iter<'a, Option<Item<'b, 'c>>>
|
||||
}
|
||||
|
||||
impl<'a, 'b: 'a, 'c: 'a + 'b> Iterator for Iter<'a, 'b, 'c> {
|
||||
type Item = &'a Socket<'b, 'c>;
|
||||
|
||||
fn next(&mut self) -> Option<Self::Item> {
|
||||
while let Some(socket_opt) = self.lower.next() {
|
||||
if let Some(socket) = socket_opt.as_ref() {
|
||||
return Some(socket)
|
||||
while let Some(item_opt) = self.lower.next() {
|
||||
if let Some(item) = item_opt.as_ref() {
|
||||
return Some(&item.socket)
|
||||
}
|
||||
}
|
||||
None
|
||||
|
@ -117,16 +188,16 @@ impl<'a, 'b: 'a, 'c: 'a + 'b> Iterator for Iter<'a, 'b, 'c> {
|
|||
/// This struct is created by the [iter_mut](struct.SocketSet.html#method.iter_mut)
|
||||
/// on [socket sets](struct.SocketSet.html).
|
||||
pub struct IterMut<'a, 'b: 'a, 'c: 'a + 'b> {
|
||||
lower: slice::IterMut<'a, Option<Socket<'b, 'c>>>
|
||||
lower: slice::IterMut<'a, Option<Item<'b, 'c>>>
|
||||
}
|
||||
|
||||
impl<'a, 'b: 'a, 'c: 'a + 'b> Iterator for IterMut<'a, 'b, 'c> {
|
||||
type Item = &'a mut Socket<'b, 'c>;
|
||||
|
||||
fn next(&mut self) -> Option<Self::Item> {
|
||||
while let Some(socket_opt) = self.lower.next() {
|
||||
if let Some(socket) = socket_opt.as_mut() {
|
||||
return Some(socket)
|
||||
while let Some(item_opt) = self.lower.next() {
|
||||
if let Some(item) = item_opt.as_mut() {
|
||||
return Some(&mut item.socket)
|
||||
}
|
||||
}
|
||||
None
|
||||
|
|
Loading…
Reference in New Issue