[−][src]Crate secc
An Skip Enabled Concurrent Channel (SECC) is a bounded capacity channel that supports multiple senders and multiple recievers and allows the receiver to temporarily skip receiving messages if they desire.
The channel is a FIFO structure unless the user intends to skip one or more messages in which case a message could be read in a different order. The channel does, however, guarantee that the messages will remain in the same order as sent and, unless skipped, will be received in order.
The module is implemented using two linked lists where one list acts as a pool of nodes and the other list acts as the queue holding the messages. This allows us to move nodes in and out of the list and even skip a message with O(1) efficiency. If there are 1000 messages and the user desires to skip one in the middle they will incur virtually the exact same performance cost as a normal read operation. There are only a couple of additional pointer operations necessary to remove a node out of the middle of the linked list that implements the queue. When a message is received from the channel the node holding the message is removed from the queue and appended to the tail of the pool. Conversely, when a message is sent to the channel the node moves from the head of the pool to the tail of the queue. In this manner nodes are constantly cycled in and out of the queue so we only need to allocate them once when the channel is created.
Examples
use secc::*; let channel = create::<u8>(5, 10); let (sender, receiver) = channel; assert_eq!(Ok(()), sender.send(17)); assert_eq!(Ok(()), sender.send(19)); assert_eq!(Ok(()), sender.send(23)); assert_eq!(Ok(()), sender.send(29)); assert_eq!(Ok(17), receiver.receive()); assert_eq!(Ok(()), receiver.skip()); assert_eq!(Ok(23), receiver.receive()); assert_eq!(Ok(()), receiver.reset_skip()); assert_eq!(Ok(19), receiver.receive());
Structs
| SeccCore | Data structure that contains the core of the channel including tracking of statistics and node storage. |
| SeccReceiver | Receiver side of the channel. |
| SeccSender | Sender side of the channel. |
Enums
| SeccErrors | Errors potentially returned from channel operations. |
Traits
| SeccCoreOps |
Functions
| create | Creates the sender and receiver sides of this channel and returns them as a tuple. The user
can pass both a channel |