summaryrefslogtreecommitdiffstats
path: root/mmap.rd
diff options
context:
space:
mode:
authorguy Decoux <ts@moulon.inra.fr>2009-02-28 20:04:27 +0100
committerguy Decoux <ts@moulon.inra.fr>2009-02-28 20:04:27 +0100
commit375efb32b274d134db753d1550e7bafcfac44c6e (patch)
tree353d4efd7efa5aaaae7b848b7094005a6d8e74cb /mmap.rd
parent5ddb005992b57f89ee974c22b89a91f06e7fc2e3 (diff)
downloadmmap-ruby-375efb32b274d134db753d1550e7bafcfac44c6e.zip
mmap-ruby-375efb32b274d134db753d1550e7bafcfac44c6e.tar.gz
mmap-0.1.2
Diffstat (limited to 'mmap.rd')
-rw-r--r--mmap.rd17
1 files changed, 16 insertions, 1 deletions
diff --git a/mmap.rd b/mmap.rd
index e7a2ad0..d73f2b2 100644
--- a/mmap.rd
+++ b/mmap.rd
@@ -19,11 +19,16 @@ Object
== Class Methods
+--- lockall(flag)
+ disable paging of all pages mapped. ((|flag|)) can be
+ ((|Mmap::MCL_CURRENT|)) or ((|Mmap::MCL_FUTURE|))
+
--- new(file, [mode [, protection [, options]]])
create a new object
: ((|file|))
- Pathname of the file
+ Pathname of the file, if ((|nil|)) is given an anonymous map
+ is created ((|Mmanp::MAP_ANON|))
: ((|mode|))
Mode to open the file, it can be "r", "w" or "rw"
@@ -54,6 +59,10 @@ Object
: ((|advice|))
The type of the access (see #madvise)
+
+--- unlockall
+ reenable paging
+
== Methods
--- extend(count)
@@ -67,10 +76,16 @@ Object
--- 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