shm

Documentation

Overview

Package shm provides helpers for dealing with shared memory.

Index

• func Create() (*os.File, error)
• type Mmap
  • func MapPrivate(file *os.File, size int, prot int) (Mmap, error)
  • func MapShared(file *os.File, size int, prot int) (Mmap, error)
  • func (mmap Mmap) Unmap() error

Functions

func Create

func Create() (*os.File, error)

Create returns a file that can be mmapped to share memory with another process. It is possible for it to return both a valid file and an error.

Types

type Mmap

type Mmap []byte

Mmap is a []byte that represents a mmapped file.

func MapPrivate

func MapPrivate(file *os.File, size int, prot int) (Mmap, error)

MapPrivate maps file into memory at the given size with the given prot. It maps it in private mode, meaning that writes to the memory will not be reflected in the file.

func MapShared

func MapShared(file *os.File, size int, prot int) (Mmap, error)

MapShared maps file into memory at the given size with the given prot. It maps it in shared mode, meaning that writes to the memory will be reflected in the file.

func (Mmap) Unmap

func (mmap Mmap) Unmap() error

Unmap unmaps mmap.