JSPrismarine

API reference / @jsprismarine/nethernet / PortAllocator

Class: PortAllocator ​

Defined in: packages/nethernet/src/PortAllocator.ts:34

Hands each new peer a port of a range through a PortSelectionStrategy, and takes it back when the peer leaves. A single port is a range of one, which every peer shares.

Constructors ​

Constructor ​

new PortAllocator(range, strategy?): PortAllocator

Defined in: packages/nethernet/src/PortAllocator.ts:41

Parameters ​

range ​

PortRange

The local ports.

strategy? ​

PortSelectionStrategy = fewestPeers

How a port is picked; the fewest peers by default.

Returns ​

PortAllocator

Properties ​

range ​

readonly range: PortRange

Defined in: packages/nethernet/src/PortAllocator.ts:42

The local ports.

Methods ​

acquire() ​

acquire(): number

Defined in: packages/nethernet/src/PortAllocator.ts:49

Takes a port for a new peer.

Returns ​

number

loads() ​

loads(): PortLoad[]

Defined in: packages/nethernet/src/PortAllocator.ts:68

Every port of the range and its peers, lowest first.

Returns ​

PortLoad[]

release() ​

release(port): void

Defined in: packages/nethernet/src/PortAllocator.ts:62

Gives a peer's port back.

Parameters ​

port ​

number

The port PortAllocator.acquire gave it.

Returns ​

void