Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

getrusage(2) bindings

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 .gitignore
Octocat-spinner-32 LICENSE
Octocat-spinner-32 README
Octocat-spinner-32 binding.gyp
Octocat-spinner-32 package.json
Octocat-spinner-32 rusage.cc
README
NODE-RUSAGE
==============

getrusage(2) bindings for node.js.

This module exports the RUSAGE_* constants that are available on your
platform:

  * RUSAGE_SELF      All platforms
  * RUSAGE_CHILDREN  All platforms.
  * RUSAGE_THREAD    Linux, FreeBSD (but not NetBSD and OpenBSD.)
  * RUSAGE_LWP       Linux, Solaris. (Alias for RUSAGE_THREAD on Linux.)


USAGE
=====

Example:

    var RUSAGE_SELF = require('rusage').RUSAGE_SELF;
    var getrusage = require('rusage').getrusage;
    var ru = getrusage(RUSAGE_SELF);
    console.log(ru);
    // { ru_utime: { sec: 0, usec: 51160 },
    //   ru_stime: { sec: 0, usec: 21980 },
    //   ru_maxrss: 13791232,
    //   ru_ixrss: 0,
    //   ru_idrss: 0,
    //   ru_isrss: 0,
    //   ru_minflt: 3607,
    //   ru_majflt: 0,
    //   ru_nswap: 0,
    //   ru_inblock: 0,
    //   ru_oublock: 0,
    //   ru_msgsnd: 0,
    //   ru_msgrcv: 0,
    //   ru_nsignals: 0,
    //   ru_nvcsw: 0,
    //   ru_nivcsw: 63 }

Consult `man 2 getrusage` for details on the meaning of the field names.


API
===

rusage.getrusage([who])  -  Call getrusage(2) and return the result.
                            `who` defaults to RUSAGE_SELF.


KNOWN BUGS
==========

* MS Windows is not supported.


LICENSE
=======

Copyright (c) 2013, Ben Noordhuis <info@bnoordhuis.nl>

Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
Something went wrong with that request. Please try again.