Changed discover option to dnsSeed for clarity and added comments to documentation for the options.
This commit is contained in:
parent
ae97e36ff0
commit
c07bc0461d
@ -36,9 +36,9 @@ By default, peers will be added via DNS discovery and as peers are announced in
|
|||||||
```javascript
|
```javascript
|
||||||
|
|
||||||
var pool = new Pool(Networks.livenet, {
|
var pool = new Pool(Networks.livenet, {
|
||||||
discover: false,
|
dnsSeed: false, // prevent seeding with DNS discovered known peers upon connecting
|
||||||
listenAddr: false,
|
listenAddr: false, // prevent new peers being added from addr messages
|
||||||
addrs: [
|
addrs: [ // initial peers to connect to
|
||||||
{
|
{
|
||||||
ip: {
|
ip: {
|
||||||
v4: '127.0.0.1'
|
v4: '127.0.0.1'
|
||||||
|
|||||||
@ -44,15 +44,15 @@ function Pool(network, options) {
|
|||||||
this._addrs = [];
|
this._addrs = [];
|
||||||
|
|
||||||
this.listenAddr = true;
|
this.listenAddr = true;
|
||||||
this.discover = true;
|
this.dnsSeed = true;
|
||||||
|
|
||||||
// define configuration options
|
// define configuration options
|
||||||
if (options) {
|
if (options) {
|
||||||
if (options.listenAddr === false) {
|
if (options.listenAddr === false) {
|
||||||
this.listenAddr = false;
|
this.listenAddr = false;
|
||||||
}
|
}
|
||||||
if (options.discover === false) {
|
if (options.dnsSeed === false) {
|
||||||
this.discover = false;
|
this.dnsSeed = false;
|
||||||
}
|
}
|
||||||
if (options.addrs) {
|
if (options.addrs) {
|
||||||
for(var i = 0; i < options.addrs.length; i++) {
|
for(var i = 0; i < options.addrs.length; i++) {
|
||||||
@ -119,7 +119,7 @@ Pool.PeerEvents = ['version', 'inv', 'getdata', 'ping', 'pong', 'addr',
|
|||||||
Pool.prototype.connect = function connect() {
|
Pool.prototype.connect = function connect() {
|
||||||
this.keepalive = true;
|
this.keepalive = true;
|
||||||
var self = this;
|
var self = this;
|
||||||
if (this.discover) {
|
if (this.dnsSeed) {
|
||||||
self._addAddrsFromSeeds();
|
self._addAddrsFromSeeds();
|
||||||
} else {
|
} else {
|
||||||
self._fillConnections();
|
self._fillConnections();
|
||||||
|
|||||||
@ -48,7 +48,7 @@ describe('Pool', function() {
|
|||||||
throw new Error('DNS should not be called');
|
throw new Error('DNS should not be called');
|
||||||
});
|
});
|
||||||
var options = {
|
var options = {
|
||||||
discover: false,
|
dnsSeed: false,
|
||||||
addrs: [
|
addrs: [
|
||||||
{
|
{
|
||||||
ip: {
|
ip: {
|
||||||
@ -66,7 +66,7 @@ describe('Pool', function() {
|
|||||||
|
|
||||||
it('will add addrs via options argument', function() {
|
it('will add addrs via options argument', function() {
|
||||||
var options = {
|
var options = {
|
||||||
discover: false,
|
dnsSeed: false,
|
||||||
addrs: [
|
addrs: [
|
||||||
{
|
{
|
||||||
ip: {
|
ip: {
|
||||||
@ -100,7 +100,7 @@ describe('Pool', function() {
|
|||||||
});
|
});
|
||||||
|
|
||||||
var options = {
|
var options = {
|
||||||
discover: false,
|
dnsSeed: false,
|
||||||
addrs: [
|
addrs: [
|
||||||
{
|
{
|
||||||
ip: {
|
ip: {
|
||||||
@ -150,7 +150,7 @@ describe('Pool', function() {
|
|||||||
});
|
});
|
||||||
|
|
||||||
var options = {
|
var options = {
|
||||||
discover: false,
|
dnsSeed: false,
|
||||||
listenAddr: false,
|
listenAddr: false,
|
||||||
addrs: [
|
addrs: [
|
||||||
{
|
{
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user