mlock

Documentation

Overview

Package mlock allows for locking memory, providing implementations for different operating systems.

Index

• Variables
• func LockMemory() error
• func Supported() bool

Variables

var (

	// ErrNotSupported is returned when mlock is not available for the platform
	ErrNotSupported = errMlock.Code("not_supported").Error("mlock is not supported")
)

Functions

func LockMemory

func LockMemory() error

LockMemory prevents any memory being written to disk as swap.

func Supported

func Supported() bool

Supported returns true if LockMemory is available on the system.