shm

package module

v0.0.2 Latest Latest Go to latest Published: Aug 15, 2022 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

shm is a Go (golang) wrapper for SysV Shared Memory Segments

This section is empty.

View Source

var ErrorGivenSliceBiggerThanData = fmt.Errorf("shm: p is larger than SharedMemory size")

View Source

var ErrorGivenSliceTooBig = fmt.Errorf("shm: slice of bytes provided too big to write")

This section is empty.

type SharedMemory struct {
	// contains filtered or unexported fields
}

SharedMemory is a Wrapper around SysVShm, and is not safe for concurrent access

func New(id int, size int) SharedMemory

New SharedMemory using id, if id is 0, make one there

func (sm *SharedMemory) Close() error

Close *MUST* be called after SharedMemory is finished being used

func (sm *SharedMemory) ID() int

func (sm *SharedMemory) Open() error

Open the SharedMemory (shm) segment, will return nil if called while already open

func (sm *SharedMemory) Read(p []byte) (n int, err error)

func (sm *SharedMemory) ReadAt(p []byte, off int64) (n int, err error)

func (sm *SharedMemory) Size() int

func (sm *SharedMemory) Write(p []byte) (n int, err error)

func (sm *SharedMemory) WriteAt(p []byte, off int64) (n int, err error)

Path	Synopsis
internal
multierror Package multierror contains a Multierror for combining multiple errors and compiling with errors.Is	Package multierror contains a Multierror for combining multiple errors and compiling with errors.Is