<commit_before>node-snmp-native
================

This is a native SNMP library for Node.js. The goal is to provide
enough functionality to perform basic monitoring of network equipment. This
includes:

 - Compatibility with SNMPv2c, including 64 bit data types.
 - Support for Get and GetNext requests.
 - No unusual external dependencies, no non-JS code.
 - High performance.

It specifically does **not** include:

 - Compatibility with SNMPv1, SNMPv2u or SNMPv3.
 - Support for Set requests. Even though this is easy, it's seldom recommended.
 - MIB parsing.

Everything should naturally happen in a nice non-blocking, asynchronous manner.

Currently, the interface (which might evolve suddenly while the project is in
0.x version territory) looks like this:

    // The snmp object is the main entry point to the library.
    var snmp = require('snmp');
    
    // A session is required to communicate with an agent.
    var session = new snmp.Session('127.0.0.1', 'public');
    
    // All OIDs are represented as integer arrays.
    var oid = [1, 3, 6, 1, 2, 1, 1, 1, 0];
    
    session.get(oid, function (err, pkt) {
        if (err) {
            console.log(err);
        } else {
            // The pkt parameter is a Packet instance, which is closely
            // modelled after the actual layout of an SNMP packet.
            // The least you need to know is that there is an array of varbinds
            // that usually contain exactly one entry, in which the 'value'
            // property holds the reply.
            console.log(pkt.pdu.varbinds[0].value);
        }
    
        // The session must be closed when you're done with it.
        session.close();
    });

There are further usage examples in the `example` directory.

To install, simply drop this directory in `node_modules`. Once we're up to
version 1.0, it will be published to be easily installed with NPM of course.

You can also view the annotated source code at http://nym.se/node-snmp-native/docs/

-- 
<NAME>
<EMAIL><commit_msg>Some kind of terse installation instructions.<commit_after>node-snmp-native
================

This is a native SNMP library for Node.js. The goal is to provide
enough functionality to perform basic monitoring of network equipment. This
includes:

 - Compatibility with SNMPv2c, including 64 bit data types.
 - Support for Get and GetNext requests.
 - No unusual external dependencies, no non-JS code.
 - High performance.

It specifically does **not** include:

 - Compatibility with SNMPv1, SNMPv2u or SNMPv3.
 - Support for Set requests. Even though this is easy, it's seldom recommended.
 - MIB parsing.

Everything should naturally happen in a nice non-blocking, asynchronous manner.

Currently, the interface (which might evolve suddenly while the project is in
0.x version territory) looks like this:

    // The snmp object is the main entry point to the library.
    var snmp = require('snmp');
    
    // A session is required to communicate with an agent.
    var session = new snmp.Session('127.0.0.1', 'public');
    
    // All OIDs are represented as integer arrays.
    var oid = [1, 3, 6, 1, 2, 1, 1, 1, 0];
    
    session.get(oid, function (err, pkt) {
        if (err) {
            console.log(err);
        } else {
            // The pkt parameter is a Packet instance, which is closely
            // modelled after the actual layout of an SNMP packet.
            // The least you need to know is that there is an array of varbinds
            // that usually contain exactly one entry, in which the 'value'
            // property holds the reply.
            console.log(pkt.pdu.varbinds[0].value);
        }
    
        // The session must be closed when you're done with it.
        session.close();
    });

There are further usage examples in the `example` directory.

To install:

 - Drop this directory in `node_modules`. Call it `snmp`.
 - Enter the `snmp` directory and run `npm install` to pull the dependencies.
 - Enjoy!

Once we're up to version 1.0, it will be published to be easily installed with
NPM of course.

You can also view the annotated source code at http://nym.se/node-snmp-native/docs/

-- 
<NAME>
<EMAIL>
{'fraction_non_alphanumeric': 0.08815097945532728, 'fraction_numerical': 0.011944577161968466, 'mean_word_length': 2.656768558951965, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 2, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '547595', 'n_tokens_mistral': 1199, 'n_tokens_neox': 1140, 'n_words': 541}