JSDoc: Class: NetAddress

Constructor

new NetAddress(options)

Create a network address.

Parameters:

Name Type Description

options

Object

Properties

Name	Type	Attributes	Description
`time`	Number	<nullable>	Timestamp.
`services`	Number	<nullable>	Service bits.
`host`	String	<nullable>	IP address (IPv6 or IPv4).
`port`	Number	<nullable>	Port.

Properties:

Name	Type	Description
`host`	Host
`port`	Number
`services`	Number
`time`	Number

Source:

net/netaddress.js, line 33

Members

(static, constant) DEFAULT_SERVICES :Number

Default services for unknown outbound peers.

Type:

Number

Source:

net/netaddress.js, line 537

Methods

(static) fromHost(host, port, networknullable) → {NetAddress}

Instantiate a network address from a host and port.

Parameters:

Name	Type	Attributes
`host`	String
`port`	Number
`network`	Network \| NetworkType	<nullable>

Source:

net/netaddress.js, line 362

Returns:

Type: NetAddress

(static) fromHostname(hostname, networknullable) → {NetAddress}

Instantiate a network address from a hostname (i.e. 127.0.0.1:8333).

Parameters:

Name	Type	Attributes	Description
`hostname`	String
`network`	Network \| NetworkType	<nullable>

Source:

net/netaddress.js, line 392

Returns:

Type: NetAddress

(static) fromSocket(socket) → {NetAddress}

Instantiate a network address from a socket.

Parameters:

Name	Type	Description
`socket`	net.Socket

Source:

net/netaddress.js, line 417

Returns:

Type: NetAddress

compare() → {Number}

Compare against another network address.

Source:

net/netaddress.js, line 232

Returns:

Type: Number

equal() → {Boolean}

Compare against another network address.

Source:

net/netaddress.js, line 223

Returns:

Type: Boolean

format() → {Object}

Inspect the network address.

Source:

net/netaddress.js, line 521

Returns:

Type: Object

(private) fromHost(host, port, networknullable)

Inject properties from host, port, and network.

Parameters:

Name	Type	Attributes
`host`	String
`port`	Number
`network`	Network \| NetworkType	<nullable>

Source:

net/netaddress.js, line 335

(private) fromHostname(hostname, networknullable)

Inject properties from hostname and network.

Parameters:

Name	Type	Attributes	Description
`hostname`	String
`network`	Network \| NetworkType	<nullable>

Source:

net/netaddress.js, line 373

(private) fromJSON(json) → {NetAddress}

Inject properties from json object.

Parameters:

Name	Type	Description
`json`	Object

Source:

net/netaddress.js, line 501

Returns:

Type: NetAddress

(private) fromOptions(options)

Inject properties from options object.

Parameters:

Name	Type	Description
`options`	Object

Source:

net/netaddress.js, line 65

(private) fromSocket(socket)

Inject properties from socket.

Parameters:

Name	Type	Description
`socket`	net.Socket

Source:

net/netaddress.js, line 402

getGroup() → {Buffer}

Get the canonical identifier of our network group

Source:

net/netaddress.js, line 256

Returns:

Type: Buffer

getJSON() → {Object}

Convert net address to json-friendly object.

Source:

net/netaddress.js, line 484

Returns:

Type: Object

getKey(enc) → {String|Buffer}

Get key.

Parameters:

Name	Type	Description
`enc`	String

Source:

net/netaddress.js, line 314

Returns:

Type: String | Buffer

getReachability(dest) → {Number}

Get reachable score to destination.

Parameters:

Name	Type	Description
`dest`	NetAddress

Source:

net/netaddress.js, line 247

Returns:

Type: Number

getSize() → {Number}

Calculate serialization size of address.

Source:

net/netaddress.js, line 426

Returns:

Type: Number

hasKey() → {Boolean}

Test whether the peer has a key.

Source:

net/netaddress.js, line 214

Returns:

Type: Boolean

hasServices(services) → {Boolean}

Test whether required services are available.

Parameters:

Name	Type	Description
`services`	Number

Source:

net/netaddress.js, line 106

Returns:

Type: Boolean

isIPv4() → {Boolean}

Test whether the address is IPv4.

Source:

net/netaddress.js, line 115

Returns:

Type: Boolean

isIPv6() → {Boolean}

Test whether the address is IPv6.

Source:

net/netaddress.js, line 124

Returns:

Type: Boolean

isLocal() → {Boolean}

Test whether the host is a local address.

Source:

net/netaddress.js, line 178

Returns:

Type: Boolean

isNull() → {Boolean}

Test whether the host is null.

Source:

net/netaddress.js, line 169

Returns:

Type: Boolean

isOnion() → {Boolean}

Test whether the host is an onion address.

Source:

net/netaddress.js, line 205

Returns:

Type: Boolean

isRFC3964() → {Boolean}

Test whether the address is RFC3964.

Source:

net/netaddress.js, line 133

Returns:

Type: Boolean

isRFC4380() → {Boolean}

Test whether the address is RFC4380.

Source:

net/netaddress.js, line 142

Returns:

Type: Boolean

isRFC6052() → {Boolean}

Test whether the address is RFC6052.

Source:

net/netaddress.js, line 151

Returns:

Type: Boolean

isRFC6145() → {Boolean}

Test whether the address is RFC6145.

Source:

net/netaddress.js, line 160

Returns:

Type: Boolean

isRoutable() → {Boolean}

Test whether the host is routable.

Source:

net/netaddress.js, line 196

Returns:

Type: Boolean

isValid() → {Boolean}

Test whether the host is valid.

Source:

net/netaddress.js, line 187

Returns:

Type: Boolean

(private) read(br)

Inject properties from buffer reader.

Parameters:

Name	Type	Description
`br`	BufferReader

Source:

net/netaddress.js, line 454

setHost(host)

Set host.

Parameters:

Name	Type	Description
`host`	String

Source:

net/netaddress.js, line 276

setKey(key)

Set key.

Parameters:

Name	Type	Description
`key`	Buffer

Source:

net/netaddress.js, line 298

setNull()

Set null host.

Source:

net/netaddress.js, line 264

setPort(port)

Set port.

Parameters:

Name	Type	Description
`port`	Number

Source:

net/netaddress.js, line 287

write(bw) → {Buffer}

Write network address to a buffer writer.

Parameters:

Name	Type	Description
`bw`	BufferWriter

Source:

net/netaddress.js, line 436

Returns:

Type: Buffer