source: code/trunk/ring.go@ 50

Last change on this file since 50 was 50, checked in by contact, 5 years ago

Add an in-memory ring buffer

References: https://todo.sr.ht/~emersion/jounce/2

File size: 1.3 KB
RevLine 
[50]1package jounce
2
3import (
4 "gopkg.in/irc.v3"
5)
6
7// Ring implements a single producer, multiple consumer ring buffer. The ring
8// buffer size is fixed. The ring buffer is stored in memory.
9type Ring struct {
10 buffer []*irc.Message
11 cap, cur uint64
12
13 consumers []RingConsumer
14}
15
16func NewRing(capacity int) *Ring {
17 return &Ring{
18 buffer: make([]*irc.Message, capacity),
19 cap: uint64(capacity),
20 }
21}
22
23func (r *Ring) Produce(msg *irc.Message) {
24 i := int(r.cur % r.cap)
25 r.buffer[i] = msg
26 r.cur++
27}
28
29func (r *Ring) Consumer() *RingConsumer {
30 return &RingConsumer{
31 ring: r,
32 cur: 0, // r.cur
33 }
34}
35
36type RingConsumer struct {
37 ring *Ring
38 cur uint64
39}
40
41func (rc *RingConsumer) Diff() uint64 {
42 if rc.cur > rc.ring.cur {
43 panic("jounce: consumer cursor greater than producer cursor")
44 }
45 return rc.ring.cur - rc.cur
46}
47
48func (rc *RingConsumer) Peek() *irc.Message {
49 diff := rc.Diff()
50 if diff == 0 {
51 return nil
52 }
53 if diff > rc.ring.cap {
54 // Consumer drops diff - cap entries
55 rc.cur = rc.ring.cur - rc.ring.cap
56 }
57 i := int(rc.cur % rc.ring.cap)
58 msg := rc.ring.buffer[i]
59 if msg == nil {
60 panic("jounce: unexpected nil ring buffer entry")
61 }
62 return msg
63}
64
65func (rc *RingConsumer) Consume() *irc.Message {
66 msg := rc.Peek()
67 if msg != nil {
68 rc.cur++
69 }
70 return msg
71}
Note: See TracBrowser for help on using the repository browser.