Skip to content

Commit

Permalink
Proof read the README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Stephen Vickers committed Jul 14, 2017
1 parent 939da34 commit 776ed64
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -245,9 +245,9 @@ other outstanding ping requests.

## session.getSocket ()

The `getSocket()` method returns the underlying `Socket` instance used by
the session. Refer to the [raw-socket][raw-socket] module for documentation
related to the `Socket` class.
The `getSocket()` method returns the underlying raw socket used by the session.
This class is an instance of the `Socket` class exposed by the
[raw-socket][raw-socket] module.

In the following example the network interface from which to send ICMP messages
is set:
Expand All @@ -261,6 +261,8 @@ is set:

session.getSocket().setOption(level, option, iface, iface.length)

[raw-socket]: https://www.npmjs.com/package/raw-socket "raw-socket"

## session.pingHost (target, callback)

The `pingHost()` method sends a ping request to a remote host.
Expand Down

0 comments on commit 776ed64

Please sign in to comment.