Network
Method Summary
| Public Methods | ||
| public |
async ban(address: PeerAddress | Client.BasicAddress | string): Promise<void> |
|
| public |
async connect(address: PeerAddress | Client.BasicAddress | string): Promise<void> |
|
| public |
async disconnect(address: PeerAddress | Client.BasicAddress | string): Promise<void> |
|
| public |
async getAddress(address: PeerAddress | Client.AddressInfo | string): PromiseClient.AddressInfo> |
|
| public |
async getAddresses(): Promise<Array<Client.AddressInfo>> |
|
| public |
async getOwnAddress(): Promise<Client.BasicAddress> |
|
| public |
async getPeer(address: PeerAddress | Client.AddressInfo | string): PromiseClient.PeerInfo> |
|
| public |
async getPeers(): Promise<Array<Client.PeerInfo>> |
|
| public |
async getStatistics(): Promise<Client.NetworkStatistics> |
|
| public |
async unban(address: *) |
|
Public Methods
public async ban(address: PeerAddress | Client.BasicAddress | string): Promise<void> source
Params:
| Name | Type | Attribute | Description |
| address | PeerAddress | Client.BasicAddress | string |
Return:
| Promise<void> |
public async connect(address: PeerAddress | Client.BasicAddress | string): Promise<void> source
Params:
| Name | Type | Attribute | Description |
| address | PeerAddress | Client.BasicAddress | string |
Return:
| Promise<void> |
public async disconnect(address: PeerAddress | Client.BasicAddress | string): Promise<void> source
Params:
| Name | Type | Attribute | Description |
| address | PeerAddress | Client.BasicAddress | string |
Return:
| Promise<void> |
public async getAddress(address: PeerAddress | Client.AddressInfo | string): PromiseClient.AddressInfo> source
Params:
| Name | Type | Attribute | Description |
| address | PeerAddress | Client.AddressInfo | string |
Return:
| PromiseClient.AddressInfo> |
public async getAddresses(): Promise<Array<Client.AddressInfo>> source
Return:
| Promise<Array<Client.AddressInfo>> | List of addresses known to this node. |
public async getOwnAddress(): Promise<Client.BasicAddress> source
Return:
| Promise<Client.BasicAddress> |
public async getPeer(address: PeerAddress | Client.AddressInfo | string): PromiseClient.PeerInfo> source
Params:
| Name | Type | Attribute | Description |
| address | PeerAddress | Client.AddressInfo | string |
Return:
| PromiseClient.PeerInfo> |
public async getPeers(): Promise<Array<Client.PeerInfo>> source
Return:
| Promise<Array<Client.PeerInfo>> | List of peers currently connected to this node. |
public async getStatistics(): Promise<Client.NetworkStatistics> source
Return:
| Promise<Client.NetworkStatistics> | Statistics on the network |
public async unban(address: *) source
Params:
| Name | Type | Attribute | Description |
| address | * |