config

package

v0.2.0 Latest Latest Go to latest Published: May 3, 2025 License: MIT Imports: 1 Imported by: 2

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/AlexsanderHamir/ringbuffer

Links

Open Source Insights

Documentation ¶

Index ¶

type RingBufferConfig

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type RingBufferConfig ¶

type RingBufferConfig struct {
	Block             bool
	RTimeout          time.Duration
	WTimeout          time.Duration
	PreReadBlockHook  func() bool
	PreWriteBlockHook func() bool
}

RingBufferConfig holds the configuration for a RingBuffer

func (*RingBufferConfig) GetPreReadBlockHook ¶

func (c *RingBufferConfig) GetPreReadBlockHook() func() bool

GetPreReadBlockHook returns the pre-read block hook function

func (*RingBufferConfig) GetPreWriteBlockHook ¶

func (c *RingBufferConfig) GetPreWriteBlockHook() func() bool

GetPreWriteBlockHook returns the pre-write block hook function

func (*RingBufferConfig) GetReadTimeout ¶

func (c *RingBufferConfig) GetReadTimeout() time.Duration

GetReadTimeout returns the read timeout duration

func (*RingBufferConfig) GetWriteTimeout ¶

func (c *RingBufferConfig) GetWriteTimeout() time.Duration

GetWriteTimeout returns the write timeout duration

func (*RingBufferConfig) IsBlocking ¶

func (c *RingBufferConfig) IsBlocking() bool

IsBlocking returns whether the buffer is in blocking mode

Source Files ¶

View all Source files

config.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL