summaryrefslogtreecommitdiff
path: root/vendor/github.com/pbnjay/memory/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/pbnjay/memory/doc.go')
-rw-r--r--vendor/github.com/pbnjay/memory/doc.go24
1 files changed, 24 insertions, 0 deletions
diff --git a/vendor/github.com/pbnjay/memory/doc.go b/vendor/github.com/pbnjay/memory/doc.go
new file mode 100644
index 000000000..4e4f984c0
--- /dev/null
+++ b/vendor/github.com/pbnjay/memory/doc.go
@@ -0,0 +1,24 @@
+// Package memory provides a single method reporting total system memory
+// accessible to the kernel.
+package memory
+
+// TotalMemory returns the total accessible system memory in bytes.
+//
+// The total accessible memory is installed physical memory size minus reserved
+// areas for the kernel and hardware, if such reservations are reported by
+// the operating system.
+//
+// If accessible memory size could not be determined, then 0 is returned.
+func TotalMemory() uint64 {
+ return sysTotalMemory()
+}
+
+// FreeMemory returns the total free system memory in bytes.
+//
+// The total free memory is installed physical memory size minus reserved
+// areas for other applications running on the same system.
+//
+// If free memory size could not be determined, then 0 is returned.
+func FreeMemory() uint64 {
+ return sysFreeMemory()
+}