Class RadixNodeConnection

Hierarchy

EventEmitter
- RadixNodeConnection

Index

Constructors

constructor

Properties

Constructors

constructor

new RadixNodeConnection(node: RadixNode): RadixNodeConnection

- Defined in modules/universe/RadixNodeConnection.ts:53
Parameters
- node: RadixNode
Returns RadixNodeConnection

Properties

Private _addressSubscriptions

_addressSubscriptions: object

Type declaration

[address: string]: string

Private _atomUpdateSubjects

_atomUpdateSubjects: object

Type declaration

[subscriberId: string]: BehaviorSubject<any>

Private _socket

_socket: Client

Private _subscriptions

_subscriptions: object

Type declaration

[subscriberId: string]: Subject<RadixAtomUpdate>

address

address: string

Private lastSubscriberId

lastSubscriberId: number = 1

node

node: RadixNode

Private pingInterval

pingInterval: any

Static defaultMaxListeners

defaultMaxListeners: number

Methods

Private _onAtomReceivedNotification

_onAtomReceivedNotification(notification: AtomReceivedNotification): void

- Defined in modules/universe/RadixNodeConnection.ts:370
Parameters
- notification: AtomReceivedNotification
Returns void

Private _onAtomStatusNotification

_onAtomStatusNotification(notification: AtomStatusNotification): void

- Defined in modules/universe/RadixNodeConnection.ts:320
Parameters
- notification: AtomStatusNotification
Returns void

Private _onAtomSubmissionStateUpdate

_onAtomSubmissionStateUpdate(notification: AtomSubmissionStateUpdateNotification): void

- Defined in modules/universe/RadixNodeConnection.ts:343
Parameters
- notification: AtomSubmissionStateUpdateNotification
Returns void

Private _onClosed

_onClosed(): void

- Defined in modules/universe/RadixNodeConnection.ts:297
Returns void

addListener

addListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in /Users/dparrino/doca/doca/test/tmp/node_modules/@types/node/events.d.ts:10
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

close

close(): void

- Defined in modules/universe/RadixNodeConnection.ts:291
Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in /Users/dparrino/doca/doca/test/tmp/node_modules/@types/node/events.d.ts:22
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in /Users/dparrino/doca/doca/test/tmp/node_modules/@types/node/events.d.ts:23
Returns Array<string | symbol>

getAtomById

getAtomById(id: RadixEUID): Promise<any>

- Defined in modules/universe/RadixNodeConnection.ts:282
NOT IMPLEMENTED Query the ledger for an atom by its id

Parameters
- id: RadixEUID
Returns Promise<any>

The atom

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in /Users/dparrino/doca/doca/test/tmp/node_modules/@types/node/events.d.ts:19
Returns number

Private getSubscriberId

getSubscriberId(): string

- Defined in modules/universe/RadixNodeConnection.ts:60
Returns string

isReady

isReady(): boolean

- Defined in modules/universe/RadixNodeConnection.ts:69
Check whether the node connection is ready for requests

Returns boolean

true if ready

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in /Users/dparrino/doca/doca/test/tmp/node_modules/@types/node/events.d.ts:24
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in /Users/dparrino/doca/doca/test/tmp/node_modules/@types/node/events.d.ts:20
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: function): this

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in /Users/dparrino/doca/doca/test/tmp/node_modules/@types/node/events.d.ts:16
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: "closed" | "open", listener: function): this

Overrides EventEmitter.on
- Defined in modules/universe/RadixNodeConnection.ts:39
Parameters
- event: "closed" | "open"
- listener: function
  - - (): void
    - Returns void
Returns this

once

once(event: string | symbol, listener: function): this

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in /Users/dparrino/doca/doca/test/tmp/node_modules/@types/node/events.d.ts:12
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

openConnection

openConnection(): Promise<any>

- Defined in modules/universe/RadixNodeConnection.ts:88
Opens connection

Returns Promise<any>

a promise that resolves once the connection is ready, or rejects on error or timeout

Private ping

ping(): void

- Defined in modules/universe/RadixNodeConnection.ts:73
Returns void

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in /Users/dparrino/doca/doca/test/tmp/node_modules/@types/node/events.d.ts:13
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in /Users/dparrino/doca/doca/test/tmp/node_modules/@types/node/events.d.ts:14
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in /Users/dparrino/doca/doca/test/tmp/node_modules/@types/node/events.d.ts:21
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in /Users/dparrino/doca/doca/test/tmp/node_modules/@types/node/events.d.ts:17
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in /Users/dparrino/doca/doca/test/tmp/node_modules/@types/node/events.d.ts:15
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in /Users/dparrino/doca/doca/test/tmp/node_modules/@types/node/events.d.ts:18
Parameters
- n: number
Returns this

submitAtom

submitAtom(atom: RadixAtom): BehaviorSubject<string>

- Defined in modules/universe/RadixNodeConnection.ts:222
Submit an atom to the ledger

Parameters
- atom: RadixAtom
  
  The atom to be submitted
Returns BehaviorSubject<string>

A stream of the status of the atom submission

subscribe

subscribe(address: string): Subject<RadixAtomUpdate>

- Defined in modules/universe/RadixNodeConnection.ts:139
Subscribe for all existing and future atoms for a given address

Parameters
- address: string
  
  Base58 formatted address
Returns Subject<RadixAtomUpdate>

A stream of atoms

unsubscribe

unsubscribe(address: string): Promise<any>

- Defined in modules/universe/RadixNodeConnection.ts:171
Unsubscribe for all existing and future atoms for a given address

Parameters
- address: string
  
  Base58 formatted address
Returns Promise<any>

A promise with the result of the unsubscription call

unsubscribeAll

unsubscribeAll(): Promise<any>

- Defined in modules/universe/RadixNodeConnection.ts:199
Unsubscribes to all the addresses this node is subscribed to

Returns Promise<any>

An array with the result of each unsubscription

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in /Users/dparrino/doca/doca/test/tmp/node_modules/@types/node/events.d.ts:7
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc