README
¶
shm-go
A high-performance shared memory communications library for Go.
Download
go get github.com/tmthrgd/shm-go
License
Unless otherwise noted, the shm-go source files are distributed under the Modified BSD License found in the LICENSE file.
Documentation
¶
Index ¶
- Variables
- func Unlink(name string) error
- type Buffer
- type ReadWriteCloser
- func CreateDuplex(name string, perm os.FileMode, blockCount, blockSize int) (*ReadWriteCloser, error)
- func CreateSimplex(name string, perm os.FileMode, blockCount, blockSize int) (*ReadWriteCloser, error)
- func OpenDuplex(name string) (*ReadWriteCloser, error)
- func OpenSimplex(name string) (*ReadWriteCloser, error)
- func (rw *ReadWriteCloser) Close() error
- func (rw *ReadWriteCloser) GetReadBuffer() (Buffer, error)
- func (rw *ReadWriteCloser) GetWriteBuffer() (Buffer, error)
- func (rw *ReadWriteCloser) Name() string
- func (rw *ReadWriteCloser) Read(p []byte) (n int, err error)
- func (rw *ReadWriteCloser) ReadFrom(r io.Reader) (n int64, err error)
- func (rw *ReadWriteCloser) SendReadBuffer(buf Buffer) error
- func (rw *ReadWriteCloser) SendWriteBuffer(buf Buffer) (n int, err error)
- func (rw *ReadWriteCloser) Unlink() error
- func (rw *ReadWriteCloser) Write(p []byte) (n int, err error)
- func (rw *ReadWriteCloser) WriteTo(w io.Writer) (n int64, err error)
Constants ¶
This section is empty.
Variables ¶
View Source
var ( ErrNotMultipleOf64 = errors.New("blockSize is not a multiple of 64") ErrInvalidBuffer = errors.New("invalid buffer") )
Functions ¶
func Unlink ¶
Unlink removes the previously created blocker.
Taken from shm_unlink(3):
The operation of shm_unlink() is analogous to unlink(2): it removes a shared memory object name, and, once all processes have unmapped the object, de-allocates and destroys the contents of the associated memory region. After a successful shm_unlink(), attempts to shm_open() an object with the same name will fail (unless O_CREAT was specified, in which case a new, distinct object is created).
Types ¶
type ReadWriteCloser ¶
type ReadWriteCloser struct {
// Must be accessed using atomic operations
Flags *[sharedFlagsSize]uint32
// contains filtered or unexported fields
}
func CreateDuplex ¶
func CreateSimplex ¶
func OpenDuplex ¶
func OpenDuplex(name string) (*ReadWriteCloser, error)
func OpenSimplex ¶
func OpenSimplex(name string) (*ReadWriteCloser, error)
func (*ReadWriteCloser) Close ¶
func (rw *ReadWriteCloser) Close() error
func (*ReadWriteCloser) GetReadBuffer ¶
func (rw *ReadWriteCloser) GetReadBuffer() (Buffer, error)
func (*ReadWriteCloser) GetWriteBuffer ¶
func (rw *ReadWriteCloser) GetWriteBuffer() (Buffer, error)
func (*ReadWriteCloser) Name ¶
func (rw *ReadWriteCloser) Name() string
Name returns the name of the shared memory.
func (*ReadWriteCloser) ReadFrom ¶
func (rw *ReadWriteCloser) ReadFrom(r io.Reader) (n int64, err error)
func (*ReadWriteCloser) SendReadBuffer ¶
func (rw *ReadWriteCloser) SendReadBuffer(buf Buffer) error
func (*ReadWriteCloser) SendWriteBuffer ¶
func (rw *ReadWriteCloser) SendWriteBuffer(buf Buffer) (n int, err error)
func (*ReadWriteCloser) Unlink ¶
func (rw *ReadWriteCloser) Unlink() error
Unlink removes the shared memory.
It is the equivalent to calling Unlink(string) with the same name as Create* or Open*.
Taken from shm_unlink(3):
The operation of shm_unlink() is analogous to unlink(2): it removes a shared memory object name, and, once all processes have unmapped the object, de-allocates and destroys the contents of the associated memory region. After a successful shm_unlink(), attempts to shm_open() an object with the same name will fail (unless O_CREAT was specified, in which case a new, distinct object is created).
Source Files
¶
Directories
Click to show internal directories.
Click to hide internal directories.