Class TCPTransport

TCP based transport.

Hierarchy

AbstractTransport
- TCPTransport

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new TCPTransport(options: TCPTransportOptions): TCPTransport

Overrides AbstractTransport.constructor
- Defined in packages/tcp/src/TCPTransport.ts:49
Create a new instance.

Parameters
- options: TCPTransportOptions
Returns TCPTransport

Properties

Protected debug

debug: Debugger

Protected Readonly peers

peers: Set<Peer>

Accessors

onPeerConnect

get onPeerConnect(): Subscribable<this, [peer: Peer]>

Inherited from AbstractTransport.onPeerConnect
- Defined in packages/transport/src/AbstractTransport.ts:57
Event for when a new peer is connected via this transport.

Returns Subscribable<this, [peer: Peer]>
Subscribable that can be used to register listeners

port

get port(): number

- Defined in packages/tcp/src/TCPTransport.ts:75
Get the port number the transport was bound to.

Returns number
port number, or 0 if no server was started

started

get started(): boolean

Inherited from AbstractTransport.started
- Defined in packages/transport/src/AbstractTransport.ts:67
Get if transport is started.

Returns boolean
true if transport is started

transportOptions

get transportOptions(): TransportOptions

Inherited from AbstractTransport.transportOptions
- Defined in packages/transport/src/AbstractTransport.ts:43
Returns TransportOptions

Methods

addManualPeer

addManualPeer(hostAndPort: { host: string; port: number }): void

- Defined in packages/tcp/src/TCPTransport.ts:202
Parameters
- hostAndPort: { host: string; port: number }
  - host: string
  - port: number
Returns void

Protected addPeer

addPeer(peer: Peer): void

Inherited from AbstractTransport.addPeer
- Defined in packages/transport/src/AbstractTransport.ts:120
Add a peer to this transport. This will start monitoring this peer for connection events and make it available/unavailable as it connects/disconnects.

Parameters
- peer: Peer
  - peer to track
Returns void

start

start(options: TransportOptions): Promise<boolean>

Overrides AbstractTransport.start
- Defined in packages/tcp/src/TCPTransport.ts:79
Start this transport.

Parameters
- options: TransportOptions
Returns Promise<boolean>
boolean indicating if the transport was started

stop

stop(): Promise<boolean>

Overrides AbstractTransport.stop
- Defined in packages/tcp/src/TCPTransport.ts:178
Stop this transport.

Returns Promise<boolean>
boolean indicating if the transport was stopped.

Generated using TypeDoc