Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

raw-socket-ts

Package Overview
Dependencies
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

raw-socket-ts - npm Package Compare versions

Comparing version 2.0.0 to 2.0.1

2

package.json
{
"name": "raw-socket-ts",
"version": "2.0.0",
"version": "2.0.1",
"description": "Raw sockets for Node.js with TypeScript typing.",

@@ -5,0 +5,0 @@ "main": "index.js",

612

README.md

@@ -0,20 +1,23 @@

# raw-socket (typed)
# raw-socket
**This module is a fork of [node-raw-socket](https://github.com/nospaceships/node-raw-socket) as the original repository has been unmaintained for a while. The first goal was to add typings but other improvements are welcomed.**
This module implements raw sockets for [Node.js][nodejs].
*This module has been created primarily to facilitate implementation of the
[net-ping][net-ping] module.*
_This module has been created primarily to facilitate implementation of the
[net-ping][net-ping] module._
This module is installed using [node package manager (npm)][npm]:
# This module contains C++ source code which will be compiled
# during installation using node-gyp. A suitable build chain
# must be configured before installation.
npm install raw-socket
This module contains C++ source code which will be compiled during installation using node-gyp. A suitable build chain must be configured before installation.
```shell
npm install raw-socket-ts
```
It is loaded using the `require()` function:
var raw = require ("raw-socket");
```js
const raw = require('raw-socket-ts');
```

@@ -24,17 +27,20 @@ Raw sockets can then be created, and data sent using [Node.js][nodejs]

var socket = raw.createSocket ({protocol: raw.Protocol.None});
```js
const socket = raw.createSocket({ protocol: raw.Protocol.None });
socket.on ("message", function (buffer, source) {
console.log ("received " + buffer.length + " bytes from " + source);
});
socket.send (buffer, 0, buffer.length, "1.1.1.1", function (error, bytes) {
if (error)
console.log (error.toString ());
});
socket.on('message', (buffer, source) => {
console.log('received ' + buffer.length + ' bytes from ' + source);
});
[nodejs]: http://nodejs.org "Node.js"
[net-ping]: https://npmjs.org/package/net-ping "net-ping"
[npm]: https://npmjs.org/ "npm"
socket.send(buffer, 0, buffer.length, '1.1.1.1', (error, bytes) => {
if (error) {
console.error(error.toString());
}
});
```
[nodejs]: http://nodejs.org 'Node.js'
[net-ping]: https://npmjs.org/package/net-ping 'net-ping'
[npm]: https://npmjs.org/ 'npm'
# Network Protocol Support

@@ -53,3 +59,3 @@

Some operating system versions may restrict the use of raw sockets to
privileged users. If this is the case an exception will be thrown on socket
privileged users. If this is the case an exception will be thrown on socket
creation using a message similar to `Operation not permitted` (this message

@@ -60,5 +66,5 @@ is likely to be different depending on operating system version).

re-attempt to create a socket using the `SOCK_DGRAM` socket type for when the
protocol specified is `IPPROTO_ICMP` before throwing an exception. This
protocol specified is `IPPROTO_ICMP` before throwing an exception. This
interface on the MAC OS X platform provides non-privileged users access to the
ICMP protocol without requiring root-level access. More information on this
ICMP protocol without requiring root-level access. More information on this
subject can be found in the MAC OS X [documentation][mac-osx-icmp-ref].

@@ -74,3 +80,3 @@

Under load raw socket can experience packet loss, this may vary from system to
system depending on hardware. On some systems the `SO_RCVBUF` socket option to
system depending on hardware. On some systems the `SO_RCVBUF` socket option to
will help to alleviate packet loss.

@@ -81,4 +87,4 @@

This module uses the `libuv` library to integrate into the [Node.js][nodejs]
event loop - this library is also used by [Node.js][nodejs]. An underlying
`libuv` library `poll_handle_t` event watcher is used to monitor the
event loop - this library is also used by [Node.js][nodejs]. An underlying
`libuv` library `poll_handle_t` event watcher is used to monitor the
underlying operating system raw socket used by a socket object.

@@ -95,3 +101,3 @@

event watcher used by a socket from monitoring for readable and writeable
events. While the `resumeRecv()` and `resumeSend()` methods start the
events. While the `resumeRecv()` and `resumeSend()` methods start the
underlying `poll_handle_t` event watcher used by a socket allowing it to

@@ -109,4 +115,4 @@ monitor for readable and writeable events.

The [Node.js][nodejs] [net-ping][net-ping] module offers a concrete example
of using these methods. Since [Node.js][nodejs] offers no raw socket support
this module is used to implement ICMP echo (ping) support. Once all ping
of using these methods. Since [Node.js][nodejs] offers no raw socket support
this module is used to implement ICMP echo (ping) support. Once all ping
requests have been processed by the [net-ping][net-ping] module the

@@ -120,9 +126,15 @@ `pauseRecv()` and `pauseSend()` methods are used to allow a program to exit if

if (! socket.recvPaused)
socket.pauseRecv ();
```js
if (!socket.recvPaused) {
socket.pauseRecv();
}
```
The following can the be used to resume readable events:
if (socket.recvPaused)
socket.resumeRecv ();
```js
if (socket.recvPaused) {
socket.resumeRecv();
}
```

@@ -133,14 +145,24 @@ The following example stops the underlying `poll_handle_t` event watcher used

if (! socket.recvPaused)
socket.pauseRecv ();
if (! socket.sendPaused)
socket.pauseSend ();
```js
if (!socket.recvPaused) {
socket.pauseRecv();
}
if (!socket.sendPaused) {
socket.pauseSend();
}
```
The following can the be used to resume both readable and writeable events:
if (socket.recvPaused)
socket.resumeRecv ();
if (socket.sendPaused)
socket.resumeSend ();
```js
if (socket.recvPaused) {
socket.resumeRecv();
}
if (socket.sendPaused) {
socket.resumeSend();
}
```
When data is sent using a sockets `send()` method the `resumeSend()` method

@@ -151,4 +173,4 @@ will be called if the sockets `sendPaused` attribute is `true`, however the

[nodejs]: http://nodejs.org "Node.js"
[net-ping]: http://npmjs.org/package/net-ping "net-ping"
[nodejs]: http://nodejs.org 'Node.js'
[net-ping]: http://npmjs.org/package/net-ping 'net-ping'

@@ -162,3 +184,3 @@ # Constants

This object contains constants which can be used for the `addressFamily`
option to the `createSocket()` function exposed by this module. This option
option to the `createSocket()` function exposed by this module. This option
specifies the IP protocol version to use when creating the raw socket.

@@ -168,4 +190,4 @@

* `IPv4` - IPv4 protocol
* `IPv6` - IPv6 protocol
- `IPv4` - IPv4 protocol
- `IPv6` - IPv6 protocol

@@ -175,3 +197,3 @@ ## raw.Protocol

This object contains constants which can be used for the `protocol` option to
the `createSocket()` function exposed by this module. This option specifies
the `createSocket()` function exposed by this module. This option specifies
the protocol number to place in the protocol field of IP headers generated by

@@ -182,7 +204,7 @@ the operating system.

* `None` - protocol number 0
* `ICMP` - protocol number 1
* `TCP` - protocol number 6
* `UDP` - protocol number 17
* `ICMPv6` - protocol number 58
- `None` - protocol number 0
- `ICMP` - protocol number 1
- `TCP` - protocol number 6
- `UDP` - protocol number 17
- `ICMPv6` - protocol number 58

@@ -196,5 +218,5 @@ ## raw.SocketLevel

* `SOL_SOCKET`
* `IPPROTO_IP`
* `IPPROTO_IPV6`
- `SOL_SOCKET`
- `IPPROTO_IP`
- `IPPROTO_IPV6`

@@ -208,28 +230,28 @@ ## raw.SocketOption

* `SO_RCVBUF`
* `SO_RCVTIMEO`
* `SO_SNDBUF`
* `SO_SNDTIMEO`
* `IP_HDRINCL`
* `IP_OPTIONS`
* `IP_TOS`
* `IP_TTL`
* `IPV6_TTL`
* `IPV6_UNICAST_HOPS`
* `IPV6_V6ONLY`
- `SO_RCVBUF`
- `SO_RCVTIMEO`
- `SO_SNDBUF`
- `SO_SNDTIMEO`
- `IP_HDRINCL`
- `IP_OPTIONS`
- `IP_TOS`
- `IP_TTL`
- `IPV6_TTL`
- `IPV6_UNICAST_HOPS`
- `IPV6_V6ONLY`
*The `IPV6_TTL` socket option is not known to be defined by any operating
system, it is provided in convenience to be synonymous with IPv4*
_The `IPV6_TTL` socket option is not known to be defined by any operating
system, it is provided in convenience to be synonymous with IPv4_
For Windows platforms the following constant is also defined:
* `IPV6_HDRINCL`
- `IPV6_HDRINCL`
For Linux platforms the following constant is also defined:
* `SO_BINDTODEVICE`
- `SO_BINDTODEVICE`
# Using This Module
Raw sockets are represented by an instance of the `Socket` class. This
Raw sockets are represented by an instance of the `Socket` class. This
module exports the `createSocket()` function which is used to create

@@ -247,15 +269,15 @@ instances of the `Socket` class.

of the one's complement sum for all the data specified in one or more
[Node.js][nodejs] `Buffer` objects. This is useful for creating checksums for
[Node.js][nodejs] `Buffer` objects. This is useful for creating checksums for
protocols such as IP, TCP, UDP and ICMP.
The `bufferOrObject` parameter can be one of two types. The first is a
[Node.js][nodejs] `Buffer` object. In this case a checksum is calculated from
all the data it contains. The `bufferOrObject` parameter can also be an
The `bufferOrObject` parameter can be one of two types. The first is a
[Node.js][nodejs] `Buffer` object. In this case a checksum is calculated from
all the data it contains. The `bufferOrObject` parameter can also be an
object which must contain the following attributes:
* `buffer` - A [Node.js][nodejs] `Buffer` object which contains data which
to generate a checksum for
* `offset` - Skip this number of bytes from the beginning of `buffer`
* `length` - Only generate a checksum for this number of bytes in `buffer`
from `offset`
- `buffer` - A [Node.js][nodejs] `Buffer` object which contains data which
to generate a checksum for
- `offset` - Skip this number of bytes from the beginning of `buffer`
- `length` - Only generate a checksum for this number of bytes in `buffer`
from `offset`

@@ -266,3 +288,3 @@ The second parameter type provides control over how much of the data in a

When more than one parameter is passed a single checksum is calculated as if
the data in in all parameters were in a single buffer. This is useful for
the data in in all parameters were in a single buffer. This is useful for
when calulating checksums for TCP and UDP for example - where a psuedo header

@@ -278,4 +300,9 @@ must be created and used for checksum calculation.

var sum = raw.createChecksum (pseudo_header, {buffer: tcp_packet,
offset: 20, length: tcp_packet.length - 20});
```js
const sum = raw.createChecksum(pseudo_header, {
buffer: tcp_packet,
offset: 20,
length: tcp_packet.length - 20,
});
```

@@ -289,3 +316,3 @@ Both buffers will be treated as one, i.e. as if the data at offset `20` in

The `writeChecksum()` function writes a checksum created by the
`raw.createChecksum()` function to the [Node.js][nodejs] `Buffer` object
`raw.createChecksum()` function to the [Node.js][nodejs] `Buffer` object
`buffer` at offsets `offset` and `offset` + 1.

@@ -296,3 +323,5 @@

raw.writeChecksum (buffer, 2, raw.createChecksum (buffer));
```js
raw.writeChecksum(buffer, 2, raw.createChecksum(buffer));
```

@@ -302,3 +331,3 @@ ## raw.htonl (uint32)

The `htonl()` function converts a 32 bit unsigned integer from host byte
order to network byte order and returns the result. This function is simply
order to network byte order and returns the result. This function is simply
a stub through to the operating systems `htonl()` function.

@@ -309,3 +338,3 @@

The `htons()` function converts a 16 bit unsigned integer from host byte
order to network byte order and returns the result. This function is simply
order to network byte order and returns the result. This function is simply
a stub through to the operating systems `htons()` function.

@@ -316,3 +345,3 @@

The `ntohl()` function converts a 32 bit unsigned integer from network byte
order to host byte order and returns the result. This function is simply
order to host byte order and returns the result. This function is simply
a stub through to the operating systems `ntohl()` function.

@@ -323,3 +352,3 @@

The `ntohs()` function converts a 16 bit unsigned integer from network byte
order to host byte order and returns the result. This function is simply
order to host byte order and returns the result. This function is simply
a stub through to the operating systems `ntohs()` function.

@@ -332,29 +361,31 @@

// Default options
var options = {
addressFamily: raw.AddressFamily.IPv4,
protocol: raw.Protocol.None,
bufferSize: 4096,
generateChecksums: false,
checksumOffset: 0
};
var socket = raw.createSocket (options);
```js
// Default options
const options = {
addressFamily: raw.AddressFamily.IPv4,
protocol: raw.Protocol.None,
bufferSize: 4096,
generateChecksums: false,
checksumOffset: 0,
};
const socket = raw.createSocket(options);
```
The optional `options` parameter is an object, and can contain the following
items:
* `addressFamily` - Either the constant `raw.AddressFamily.IPv4` or the
constant `raw.AddressFamily.IPv6`, defaults to the constant
`raw.AddressFamily.IPv4`
* `protocol` - Either one of the constants defined in the `raw.Protocol`
object or the protocol number to use for the socket, defaults to the
consant `raw.Protocol.None`
* `bufferSize` - Size, in bytes, of the sockets internal receive buffer,
defaults to 4096
* `generateChecksums` - Either `true` or `false` to enable or disable the
automatic checksum generation feature, defaults to `false`
* `checksumOffset` - When `generateChecksums` is `true` specifies how many
bytes to index into the send buffer to write automatically generated
checksums, defaults to `0`
- `addressFamily` - Either the constant `raw.AddressFamily.IPv4` or the
constant `raw.AddressFamily.IPv6`, defaults to the constant
`raw.AddressFamily.IPv4`
- `protocol` - Either one of the constants defined in the `raw.Protocol`
object or the protocol number to use for the socket, defaults to the
consant `raw.Protocol.None`
- `bufferSize` - Size, in bytes, of the sockets internal receive buffer,
defaults to 4096
- `generateChecksums` - Either `true` or `false` to enable or disable the
automatic checksum generation feature, defaults to `false`
- `checksumOffset` - When `generateChecksums` is `true` specifies how many
bytes to index into the send buffer to write automatically generated
checksums, defaults to `0`

@@ -378,5 +409,7 @@ An exception will be thrown if the underlying raw socket could not be created.

socket.on ("close", function () {
console.log ("socket closed");
});
```js
socket.on('close', () => {
console.log('socket closed');
});
```

@@ -390,4 +423,4 @@ ## socket.on ("error", callback)

* `error` - An instance of the `Error` class, the exposed `message` attribute
will contain a detailed error message.
- `error` - An instance of the `Error` class, the exposed `message` attribute
will contain a detailed error message.

@@ -397,6 +430,8 @@ The following example prints a message to the console when an error occurs,

socket.on ("error", function (error) {
console.log (error.toString ());
socket.close ();
});
```js
socket.on('error', (error) => {
console.log(error.toString());
socket.close();
});
```

@@ -409,16 +444,18 @@ ## socket.on ("message", callback)

* `buffer` - A [Node.js][nodejs] `Buffer` object containing the data
received, the buffer will be sized to fit the data received, that is the
`length` attribute of buffer will specify how many bytes were received
* `address` - For IPv4 raw sockets the dotted quad formatted source IP
address of the message, e.g `192.168.1.254`, for IPv6 raw sockets the
compressed formatted source IP address of the message, e.g.
`fe80::a00:27ff:fe2a:3427`
- `buffer` - A [Node.js][nodejs] `Buffer` object containing the data
received, the buffer will be sized to fit the data received, that is the
`length` attribute of buffer will specify how many bytes were received
- `address` - For IPv4 raw sockets the dotted quad formatted source IP
address of the message, e.g `192.168.1.254`, for IPv6 raw sockets the
compressed formatted source IP address of the message, e.g.
`fe80::a00:27ff:fe2a:3427`
The following example prints received messages in hexadecimal to the console:
socket.on ("message", function (buffer, address) {
console.log ("received " + buffer.length + " bytes from " + address
+ ": " + buffer.toString ("hex"));
});
```js
socket.on('message', (buffer, address) => {
const message = buffer.toString('hex');
console.log(`received ${buffer.length} bytes from ${address}: ${message}`);
});
```

@@ -431,3 +468,3 @@ ## socket.generateChecksums (generate, offset)

The `generate` parameter is either `true` or `false` to enable or disable the
feature. The optional `offset` parameter specifies how many bytes to index
feature. The optional `offset` parameter specifies how many bytes to index
into the send buffer when writing the generated checksum to the send buffer.

@@ -439,3 +476,5 @@

socket.generateChecksums (true, 2);
```js
socket.generateChecksums(true, 2);
```

@@ -448,5 +487,5 @@ ## socket.getOption (level, option, buffer, length)

The `level` parameter is one of the constants defined in the `raw.SocketLevel`
object. The `option` parameter is one of the constants defined in the
`raw.SocketOption` object. The `buffer` parameter is a [Node.js][nodejs]
`Buffer` object where the socket option value will be written. The `length`
object. The `option` parameter is one of the constants defined in the
`raw.SocketOption` object. The `buffer` parameter is a [Node.js][nodejs]
`Buffer` object where the socket option value will be written. The `length`
parameter specifies the size of the `buffer` parameter.

@@ -462,12 +501,14 @@

var level = raw.SocketLevel.IPPROTO_IP;
var option = raw.SocketOption.IP_TTL;
# IP_TTL is a signed integer on some platforms so a 4 byte buffer is used
var buffer = new Buffer (4);
var written = socket.getOption (level, option, buffer, buffer.length);
console.log (buffer.toString ("hex"), 0, written);
```js
const level = raw.SocketLevel.IPPROTO_IP;
const option = raw.SocketOption.IP_TTL;
// IP_TTL is a signed integer on some platforms so a 4 byte buffer is used
const buffer = new Buffer(4);
const written = socket.getOption(level, option, buffer, buffer.length);
console.log(buffer.toString('hex'), 0, written);
```
## socket.send (buffer, offset, length, address, beforeCallback, afterCallback)

@@ -478,17 +519,17 @@

The `buffer` parameter is a [Node.js][nodejs] `Buffer` object containing the
data to be sent. The `length` parameter specifies how many bytes from
`buffer`, beginning at offset `offset`, to send. For IPv4 raw sockets the
data to be sent. The `length` parameter specifies how many bytes from
`buffer`, beginning at offset `offset`, to send. For IPv4 raw sockets the
`address` parameter contains the dotted quad formatted IP address of the
remote host to send the data to, e.g `192.168.1.254`, for IPv6 raw sockets the
`address` parameter contains the compressed formatted IP address of the remote
host to send the data to, e.g. `fe80::a00:27ff:fe2a:3427`. If provided the
host to send the data to, e.g. `fe80::a00:27ff:fe2a:3427`. If provided the
optional `beforeCallback` function is called right before the data is actually
sent using the underlying raw socket, giving users the opportunity to perform
pre-send actions such as setting a socket option, e.g. the IP header TTL. No
arguments are passed to the `beforeCallback` function. The `afterCallback`
function is called once the data has been sent. The following arguments will
pre-send actions such as setting a socket option, e.g. the IP header TTL. No
arguments are passed to the `beforeCallback` function. The `afterCallback`
function is called once the data has been sent. The following arguments will
be passed to the `afterCallback` function:
* `error` - Instance of the `Error` class, or `null` if no error occurred
* `bytes` - Number of bytes sent
- `error` - Instance of the `Error` class, or `null` if no error occurred
- `bytes` - Number of bytes sent

@@ -499,28 +540,31 @@ The following example sends a ICMP ping message to a remote host, before the

// ICMP echo (ping) request, checksum should be ok
var buffer = new Buffer ([
0x08, 0x00, 0x43, 0x52, 0x00, 0x01, 0x0a, 0x09,
0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68,
0x69, 0x6a, 0x6b, 0x6c, 0x6d, 0x6e, 0x6f, 0x70,
0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x61,
0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69]);
```js
// ICMP echo (ping) request, checksum should be ok
const buffer = new Buffer([
0x08, 0x00, 0x43, 0x52, 0x00, 0x01, 0x0a, 0x09, 0x61, 0x62, 0x63, 0x64, 0x65,
0x66, 0x67, 0x68, 0x69, 0x6a, 0x6b, 0x6c, 0x6d, 0x6e, 0x6f, 0x70, 0x71, 0x72,
0x73, 0x74, 0x75, 0x76, 0x77, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68,
0x69,
]);
var socketLevel = raw.SocketLevel.IPPROTO_IP
var socketOption = raw.SocketOption.IP_TTL;
const socketLevel = raw.SocketLevel.IPPROTO_IP;
const socketOption = raw.SocketOption.IP_TTL;
function beforeSend () {
socket.setOption (socketLevel, socketOption, 1);
}
function afterSend (error, bytes) {
if (error)
console.log (error.toString ());
else
console.log ("sent " + bytes + " bytes");
socket.setOption (socketLevel, socketOption, 1);
}
function beforeSend() {
socket.setOption(socketLevel, socketOption, 1);
}
socket.send (buffer, 0, buffer.length, target, beforeSend, afterSend);
function afterSend(error, bytes) {
if (error) {
console.error(error.toString());
} else {
console.log(`sent ${bytes} bytes`);
}
socket.setOption(socketLevel, socketOption, 1);
}
socket.send(buffer, 0, buffer.length, target, beforeSend, afterSend);
```
## socket.setOption (level, option, buffer, length)

@@ -532,5 +576,5 @@

The `level` parameter is one of the constants defined in the `raw.SocketLevel`
object. The `option` parameter is one of the constants defined in the
`raw.SocketOption` object. The `buffer` parameter is a [Node.js][nodejs]
`Buffer` object where the socket option value is specified. The `length`
object. The `option` parameter is one of the constants defined in the
`raw.SocketOption` object. The `buffer` parameter is a [Node.js][nodejs]
`Buffer` object where the socket option value is specified. The `length`
parameter specifies how much space the option value occupies in the `buffer`

@@ -544,24 +588,30 @@ parameter.

var level = raw.SocketLevel.IPPROTO_IP;
var option = raw.SocketOption.IP_TTL;
# IP_TTL is a signed integer on some platforms so a 4 byte buffer is used,
# x86 computers use little-endian format so specify bytes reverse order
var buffer = new Buffer ([0x01, 0x00, 0x00, 0x00]);
socket.setOption (level, option, buffer, buffer.length);
```js
const level = raw.SocketLevel.IPPROTO_IP;
const option = raw.SocketOption.IP_TTL;
// IP_TTL is a signed integer on some platforms so a 4 byte buffer is used,
// x86 computers use little-endian format so specify bytes reverse order
const buffer = new Buffer([0x01, 0x00, 0x00, 0x00]);
socket.setOption(level, option, buffer, buffer.length);
```
To avoid dealing with endianess the `setOption()` method supports a three
argument form which can be used for socket options requiring a 32bit unsigned
integer value (for example the `IP_TTL` socket option used in the previous
example). Its signature is as follows:
example). Its signature is as follows:
socket.setOption (level, option, value)
```js
socket.setOption(level, option, value);
```
The previous example can be re-written to use this form:
var level = raw.SocketLevel.IPPROTO_IP;
var option = raw.SocketOption.IP_TTL;
```js
const level = raw.SocketLevel.IPPROTO_IP;
const option = raw.SocketOption.IP_TTL;
socket.setOption (level, option, 1);
socket.setOption(level, option, 1);
```

@@ -572,178 +622,2 @@ # Example Programs

# Changes
## Version 1.0.0 - 29/01/2013
* Initial release
## Version 1.0.1 - 01/02/2013
* Move `SOCKET_ERRNO` define from `raw.cc` to `raw.h`
* Error in exception thrown by `SocketWrap::New` in `raw.cc` stated that two
arguments were required, this should be one
* Corrections to the README.md
* Missing includes causes compilation error on some systems (maybe Node
version dependant)
## Version 1.0.2 - 02/02/2013
* Support automatic checksum generation
## Version 1.1.0 - 13/02/2013
* The [net-ping][net-ping] module is now implemented so update the note about
it in the first section of the README.md
* Support IPv6
* Support the `IP_HDRINCL` socket option via the `noIpHeader` option to the
`createSocket()` function and the `noIpHeader()` method exposed by the
`Socket` class
## Version 1.1.1 - 14/02/2013
* IP addresses not being validated
## Version 1.1.2 - 15/02/2013
* Default protocol option to `createSession()` was incorrect in the README.md
* The `session.on("message")` example used `message` instead of `buffer` in
the README.md
## Version 1.1.3 - 04/03/2013
* `raw.Socket.onSendReady()` emit's an error when `raw.SocketWrap.send()`
throws an exception when it should call the `req.callback` callback
* Added the `pauseRecv()`, `resumeRecv()`, `pauseSend()` and `resumeSend()`
methods
[net-ping]: https://npmjs.org/package/net-ping "net-ping"
## Version 1.1.4 - 05/03/2013
* Cleanup documentation for the `pauseSend()`, `pauseRecv()`, `resumeSend()`
and `resumeRecv()` methods in the README.md
## Version 1.1.5 - 09/05/2013
* Reformated lines in the README.md file inline with the rest of the file
* Removed the `noIpHeader()` method (the `setOption()` method should be
used to configure the `IP_HDRINCL` socket option - and possibly
`IPV6_HDRINCL` on Windows platforms), and removed the `Automatic IP Header
Generation` section from the README.md file
* Added the `setOption()` and `getOption()` methods, and added the
`SocketLevel` and `SocketOption` constants
* Tidied up the example program `ping-no-ip-header.js` (now uses the
`setOption()` method to configure the `IP_HDRINCL` socket option)
* Tidied up the example program `ping6-no-ip-header.js` (now uses the
`setOption()` method to configure the `IPV6_HDRINCL` socket option)
* Added the example program `get-option.js`
* Added the example program `ping-set-option-ip-ttl.js`
* Use MIT license instead of GPL
## Version 1.1.6 - 18/05/2013
* Added the `beforeCallback` parameter to the `send()` method, and renamed the
`callback` parameter to `afterCallback`
* Fixed a few typos in the README.md file
* Modified the example program `ping-set-option-ip-ttl.js` to use the
`beforeCallback` parameter to the `send()` method
* The example program `ping6-no-ip-header.js` was not passing the correct
arguments to the `setOption()` method
## Version 1.1.7 - 23/06/2013
* Added the `htonl()`, `htons()`, `ntohl()`, and `ntohs()` functions, and
associated example programs
* Added the `createChecksum()` function, and associated example program
## Version 1.1.8 - 01/07/2013
* Added the `writeChecksum()` function
* Removed the "Automated Checksum Generation" feature - this has been
replaced with the `createChecksum()` and `writeChecksum()` functions
## Version 1.2.0 - 02/07/2013
* Up version number to 1.2.0 (we should have done this for 1.1.8 because it
introduced some API breaking changes)
## Version 1.2.1 - 15/08/2013
* Receiving `Assertion '!(handle->flags & (UV_CLOSING | UV_CLOSED))' failed`
error after a number of pings - the underlying `uv_poll_t` handle was being
closed twice
## Version 1.2.2 - 21/09/2013
* Using uint16_t instead of uint32_t on line 87 in src/raw.cc for a value
that is out of range
* raw::SocketWrap::pause() only uses the first argument
* Delete uv_poll_t watcher in uv_close() OnClose callback instead of in the
wrapped C++ objects deconstructor
## Version 1.3.0 - 10/07/2015
* Support Node.js 0.12.x using the Native Abstractions for Node interface
* Added export for the `SO_BINDTODEVICE` socket option for Linux platforms
* On MAC OS X platforms re-attempt to create a socket using `SOCK_DGRAM`
instead of `SOCK_RAW` when `IPPROTO_ICMP` was requested by the user, this
provides non-privileged users access to the ICMP protocol on this platform
## Version 1.3.1 - 10/07/2015
* Missing bracket for when compiling under the MAC OS X platform :(
## Version 1.3.2 - 03/08/2015
* Add version dependency "<2.0.0" for the "nan" module to prevent build
failures during installation because of breaking API changes
## Version 1.3.3 - 22/09/2015
* Host repository on GitHub
## Version 1.4.0 - 09/10/2015
* Support Native Abstractions for Node 2.x
* Add-on module crashes when emitting `close` events during garbage collection
of a wrapped object
* Support Node.js 4.x
## Version 1.5.0 - 15/05/2016
* Require nan 2.3.x to support node version 6
## Version 1.5.1 - 16/11/2016
* Explicitly publish to npm using UNIX line endings
## Version 1.5.2 - 11/01/2018
* Add note to README.md on how to reduce packet loss using the `SO_RCVBUF`
socket option
* Address warnings for `v8::Value::ToUint32 was declared deprecated`
## Version 1.6.0 - 02/05/2018
* Support Node.js 10
## Version 1.6.1 - 06/06/2018
* Set NoSpaceships Ltd to be the owner and maintainer
## Version 1.6.2 - 07/06/2018
* Remove redundant sections from README.md
## Version 1.6.3 - 03/10/2018
* Include addon `.node` file extension for node-webkit compatibility
## Version 1.6.4 - 02/11/2018
* Prevent assertion failures when closing a socket and calling pauseRecv()
## Version 1.7.0 - 12/06/2019
* Support Node.js 12 using nan 2.14
# License

@@ -750,0 +624,0 @@

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc