Mmap

The Mmap class implement memory-mapped file objects

WARNING

The variables $' and $` are not available with gsub! and sub!

SuperClass

Object

Included Modules

Comparable
Enumerable

Class Methods

lockall(flag)

disable paging of all pages mapped. flag can be Mmap::MCL_CURRENT or Mmap::MCL_FUTURE

new(file, mode = "r", protection = Mmap::MAP_SHARED, options = {})

new(nil, length, protection = Mmap::MAP_SHARED, options = {})

create a new Mmap object

Pathname of the file, if nil is given an anonymous map is created Mmanp::MAP_ANON

Mode to open the file, it can be "r", "w", "rw", "a"

protection

specify the nature of the mapping

Mmap::MAP_SHARED: Creates a mapping that's shared with all other processes mapping the same areas of the file. The default value is Mmap::MAP_SHARED
Mmap::MAP_PRIVATE: Creates a private copy-on-write mapping, so changes to the contents of the mmap object will be private to this process

Hash. If one of the options length or offset is specified it will not possible to modify the size of the mapped file.

length: Maps length bytes from the file
offset: The mapping begin at offset
advice: The type of the access (see #madvise)

unlockall

reenable paging

Methods

extend(count): add count bytes to the file (i.e. pre-extend the file)
madvise(advice): advice can have the value Mmap::MADV_NORMAL, Mmap::MADV_RANDOM, Mmap::MADV_SEQUENTIAL, Mmap::MADV_WILLNEED, Mmap::MADV_DONTNEED
mprotect(mode): change the mode, value must be "r", "w" or "rw"
mlock: disable paging
msync
flush: flush the file
munlock: reenable paging
munmap: terminate the association

Other methods with the same syntax than for the class String