Class ListSource

Hierarchy

AsyncEventEmitter
- ListSource

Implements

IListSource

Constructors

constructor

new ListSource(readingSession: SourceReadingSession, subject: IBlockchainSourceSubject, source: LowLevelMessagesSource): ListSource
Parameters
- readingSession: SourceReadingSession
- subject: IBlockchainSourceSubject
- source: LowLevelMessagesSource
Returns ListSource
Overrides AsyncEventEmitter.constructor
- Defined in src/messages-list/mid-level/ListSource.ts:35

Properties

`Private` `Readonly` cache

cache: ListCache<IMessage<any>>

`Private` connectCriticalSection

connectCriticalSection: CriticalSection = ...

`Private` isListInitializationLoading

isListInitializationLoading: boolean = false

`Private` listInitializationPromise

listInitializationPromise: null | Promise<void> = null

`Private` listInitializationPromiseResolver

listInitializationPromiseResolver: (() => void)

Type declaration

- (): void
- Returns void

listeners

listeners: Record<string, EventHandler[]> = {}

`Private` loadingCriticalSection

loadingCriticalSection: CriticalSection = ...

`Protected` newMessagesSubscriptions

newMessagesSubscriptions: Set<{
callback: (() => void);
name: string;
}> = ...

`Readonly` readingSession

readingSession: SourceReadingSession

`Private` requestCriticalSection

requestCriticalSection: CriticalSection = ...

`Readonly` source

source: LowLevelMessagesSource

`Private` `Readonly` storage

storage: ListStorage<IMessage<any>>

`Private` storageInitializationPromise

storageInitializationPromise: Promise<void>

`Private` storageInitializationPromiseResolver

storageInitializationPromiseResolver: (() => void)

Type declaration

- (): void
- Returns void

`Readonly` subject

subject: IBlockchainSourceSubject

`Private` trackingNewMessagesDispose

trackingNewMessagesDispose: null | (() => void) = null

Accessors

guaranteedSegment

get guaranteedSegment(): null | ExtendedDoublyLinkedList<IMessage<any>>
Returns null | ExtendedDoublyLinkedList<IMessage<any>>
Implementation of IListSource.guaranteedSegment
- Defined in src/messages-list/mid-level/ListSource.ts:79

readToBottom

get readToBottom(): boolean
Returns boolean
Implementation of IListSource.readToBottom
- Defined in src/messages-list/mid-level/ListSource.ts:75

Methods

compare

compare(a: IMessage<any>, b: IMessage<any>): number
Parameters
- a: IMessage<any>
- b: IMessage<any>
Returns number
Implementation of IListSource.compare
- Defined in src/messages-list/mid-level/ListSource.ts:71

connect

connect(subscriptionName: string, newMessagesCallback: (() => void)): Promise<{
dispose: (() => void);
request: ((...args: [from: IMessage<any>, limit: number]) => Promise<void>);
}>
Parameters
- subscriptionName: string
- newMessagesCallback: (() => void)
  - - (): void
    - Returns void
Returns Promise<{
dispose: (() => void);
request: ((...args: [from: IMessage<any>, limit: number]) => Promise<void>);
}>
Implementation of IListSource.connect
- Defined in src/messages-list/mid-level/ListSource.ts:189

emit

emit(event: string, data?: any, shouldWait?: boolean): Promise<void>
Parameters
- event: string
- Optional data: any
- shouldWait: boolean = true
Returns Promise<void>
Implementation of IListSource.emit

Inherited from AsyncEventEmitter.emit
- Defined in src/common/AsyncEventEmitter.ts:6

getName

getName(): string
Returns string
Implementation of IListSource.getName
- Defined in src/messages-list/mid-level/ListSource.ts:67

`Private` handleNewMessages

handleNewMessages(__namedParameters: {
afterMsgId?: string;
messages: IMessage<any>[];
}): Promise<void>
Parameters
- __namedParameters: {
  afterMsgId?: string;
  messages: IMessage<any>[];
  }
  - Optional afterMsgId?: string
  - messages: IMessage<any>[]
Returns Promise<void>
- Defined in src/messages-list/mid-level/ListSource.ts:167

has

has(event: string, handler: EventHandler): boolean
Parameters
- event: string
- handler: EventHandler
Returns boolean
Implementation of IListSource.has

Inherited from AsyncEventEmitter.has
- Defined in src/common/AsyncEventEmitter.ts:36

`Private` initializeList

initializeList(): Promise<void>
Returns Promise<void>
- Defined in src/messages-list/mid-level/ListSource.ts:92

`Private` initializeStorage

initializeStorage(): Promise<void>
Returns Promise<void>
- Defined in src/messages-list/mid-level/ListSource.ts:87

`Private` loadMore

loadMore(afterOrBefore: "after" | "before", limit?: number): Promise<void>
Parameters
- afterOrBefore: "after" | "before"
- limit: number = 10
Returns Promise<void>
- Defined in src/messages-list/mid-level/ListSource.ts:107

off

off(event: string, handler: EventHandler): void
Parameters
- event: string
- handler: EventHandler
Returns void
Implementation of IListSource.off

Inherited from AsyncEventEmitter.off
- Defined in src/common/AsyncEventEmitter.ts:26

on

on(event: string, handler: EventHandler): void
Parameters
- event: string
- handler: EventHandler
Returns void
Implementation of IListSource.on

Inherited from AsyncEventEmitter.on
- Defined in src/common/AsyncEventEmitter.ts:19

`Private` ready

ready(): Promise<void>
Returns Promise<void>
- Defined in src/messages-list/mid-level/ListSource.ts:83

`Private` request

request(name: string, from: IMessage<any>, limit?: number): Promise<void>
Parameters
- name: string
- from: IMessage<any>
- limit: number = 10
Returns Promise<void>
- Defined in src/messages-list/mid-level/ListSource.ts:138

Class ListSource

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

readingSession: SourceReadingSession

subject: IBlockchainSourceSubject

source: LowLevelMessagesSource

Returns ListSource

Properties

Private Readonly cache

Private connectCriticalSection

Private isListInitializationLoading

Private listInitializationPromise

Private listInitializationPromiseResolver

Type declaration

Returns void

listeners

Private loadingCriticalSection

Protected newMessagesSubscriptions

Readonly readingSession

Private requestCriticalSection

Readonly source

Private Readonly storage

Private storageInitializationPromise

Private storageInitializationPromiseResolver

Type declaration

Returns void

Readonly subject

Private trackingNewMessagesDispose

Accessors

guaranteedSegment

Returns null | ExtendedDoublyLinkedList<IMessage<any>>

readToBottom

Returns boolean

Methods

compare

Parameters

a: IMessage<any>

b: IMessage<any>

Returns number

connect

Parameters

subscriptionName: string

newMessagesCallback: (() => void)

Returns void

Returns Promise<{ dispose: (() => void); request: ((...args: [from: IMessage<any>, limit: number]) => Promise<void>); }>

emit

Parameters

event: string

Optional data: any

shouldWait: boolean = true

Returns Promise<void>

getName

Returns string

Private handleNewMessages

Parameters

__namedParameters: { afterMsgId?: string; messages: IMessage<any>[]; }

Optional afterMsgId?: string

messages: IMessage<any>[]

Returns Promise<void>

has

Parameters

event: string

handler: EventHandler

Returns boolean

Private initializeList

Returns Promise<void>

Private initializeStorage

Returns Promise<void>

Private loadMore

Parameters

afterOrBefore: "after" | "before"

limit: number = 10

`Private` `Readonly` cache

`Private` connectCriticalSection

`Private` isListInitializationLoading

`Private` listInitializationPromise

`Private` listInitializationPromiseResolver

`Private` loadingCriticalSection

`Protected` newMessagesSubscriptions

`Readonly` readingSession

`Private` requestCriticalSection

`Readonly` source

`Private` `Readonly` storage

`Private` storageInitializationPromise

`Private` storageInitializationPromiseResolver

`Readonly` subject

`Private` trackingNewMessagesDispose

Returns Promise<{
dispose: (() => void);
request: ((...args: [from: IMessage<any>, limit: number]) => Promise<void>);
}>

`Optional` data: any

`Private` handleNewMessages

__namedParameters: {
afterMsgId?: string;
messages: IMessage<any>[];
}

`Optional` afterMsgId?: string

`Private` initializeList

`Private` initializeStorage

`Private` loadMore

`Private` ready

`Private` request