sync: Found a way to make Gate work

This commit is contained in:
Sasha Koshka 2025-01-26 00:09:02 -05:00
parent 2173550bc8
commit fd85de4a44

View File

@ -1,6 +1,6 @@
package usync package usync
import "sync" import "sync/atomic"
// Error defines errors that this package can produce // Error defines errors that this package can produce
type Error string; const ( type Error string; const (
@ -12,83 +12,74 @@ func (err Error) Error () string {
return string(err) return string(err)
} }
// if you know of a better way, i'd like to hear of it. otherwise, STFU!!!!
// Gate wraps a channel and allows the receiver to abruptly stop receiving // Gate wraps a channel and allows the receiver to abruptly stop receiving
// messages without causing the sender to lock up. // messages without causing the sender to lock up.
type Gate[T any] struct { type Gate[T any] struct {
channel chan T channel atomic.Value
lock sync.RWMutex
open bool
bufferSize int bufferSize int
} }
// NewGate creates a new gate with no buffer. // NewGate creates a new gate with no buffer.
func NewGate[T any] () Gate[T] { func NewGate[T any] () Gate[T] {
return Gate[T] { return NewBufferedGate[T](0)
channel: make(chan T),
open: true,
}
} }
// NewBufferedGate creates a new gate with a buffer. // NewBufferedGate creates a new gate with a buffer.
func NewBufferedGate[T any] (buffer int) Gate[T] { func NewBufferedGate[T any] (buffer int) Gate[T] {
return Gate[T] { gate := Gate[T] {
channel: make(chan T, buffer),
open: true,
bufferSize: buffer, bufferSize: buffer,
} }
gate.channel.Store(make(chan T, buffer))
return gate
} }
// Send sends and item to the channel, returning whether the item was sent. // Send sends and item to the channel, returning whether the item was sent.
func (this *Gate[T]) Send (item T) bool { func (this *Gate[T]) Send (item T) (ok bool) {
this.lock.RLock() channel := this.load()
defer this.lock.RUnlock() if channel == nil { return false }
if !this.open { return false } // if the channel send panics, "return true" never gets run so it just
this.channel <- item // returns false after recovering
defer func() { recover() }()
channel <- item
return true return true
} }
// Receive returns a receive-only channel that can be used to receive items. // Receive returns a receive-only channel that can be used to receive items.
func (this *Gate[T]) Receive () <- chan T { func (this *Gate[T]) Receive () <- chan T {
this.lock.RLock() return this.load()
defer this.lock.RUnlock()
return this.channel
} }
// Close closes the gate, drains all remaining messages, and closes the channel. // Close closes the gate, drains all remaining messages, and closes the channel.
func (this *Gate[T]) Close () error { func (this *Gate[T]) Close () error {
this.lock.Lock() channel := this.channel.Swap((chan T)(nil)).(chan T)
if !this.open { return ErrAlreadyClosed } if channel == nil { return ErrAlreadyClosed }
this.open = false close(channel)
this.lock.Unlock()
for len(this.channel) > 0 { <- this.channel }
close(this.channel)
return nil return nil
} }
// Reset re-opens the gate if it is closed, and creates a new channel. // Reset re-opens the gate if it is closed, and creates a new channel.
func (this *Gate[T]) Reset () error { func (this *Gate[T]) Reset () error {
this.lock.Lock() this.channel.Store(make(chan T, this.bufferSize))
defer this.lock.Unlock()
this.open = true
if this.channel != nil { close(this.channel) }
this.channel = make(chan T, this.bufferSize)
return nil return nil
} }
// Open returns whether the gate is open. // Open returns whether the gate is open.
func (this *Gate[T]) Open () bool { func (this *Gate[T]) Open () bool {
this.lock.RLock() return this.load() != nil
defer this.lock.RUnlock()
return this.open
} }
// Len returns the amount of items in the channel. // Len returns the amount of items in the channel.
func (this *Gate[T]) Len () int { func (this *Gate[T]) Len () int {
return len(this.channel) return len(this.load())
} }
// Cap returns the amount of items the channel can hold. // Cap returns the amount of items the channel can hold.
func (this *Gate[T]) Cap () int { func (this *Gate[T]) Cap () int {
return cap(this.channel) return cap(this.load())
} }
func (this *Gate[T]) load() chan T {
return this.channel.Load().(chan T)
}