Class default

Index

Constructors

Methods

createGroupIfNotExist debugDump getGroup getGroups removeGroup

Constructors

constructor

new default(): default
Returns default

Methods

createGroupIfNotExist

createGroupIfNotExist(
    localPublicKey: PublicKey,
    remotePublicKey: PublicKey,
    connectionRoutesGroupName: string,
    isCatchAllGroup: boolean,
): ConnectionRoutesGroup
Create a connection route group if it does not exist.
Parameters
- localPublicKey: PublicKey
- remotePublicKey: PublicKey
- connectionRoutesGroupName: string
- isCatchAllGroup: boolean
Returns ConnectionRoutesGroup
- Defined in misc/ConnectionEstablishment/ConnectionRoutesGroupMap.ts:45

debugDump

debugDump(header?: string): void
Dump the content of the map as string to console.
Parameters
- header: string = ''
  Prefix the header with this string
Returns void
- Defined in misc/ConnectionEstablishment/ConnectionRoutesGroupMap.ts:228

getGroup

getGroup(
    localPublicKey: PublicKey,
    remotePublicKey: PublicKey,
    connectionRoutesGroupName: string,
): undefined | ConnectionRoutesGroup
Get the corresponding entry or undefined if none exists.
Parameters
- localPublicKey: PublicKey
- remotePublicKey: PublicKey
- connectionRoutesGroupName: string
Returns undefined | ConnectionRoutesGroup
- Defined in misc/ConnectionEstablishment/ConnectionRoutesGroupMap.ts:99

getGroups

getGroups(
    localPublicKey?: PublicKey,
    remotePublicKey?: PublicKey,
    connectionRoutesGroupName?: string,
    catchAll?: boolean,
): ConnectionRoutesGroup[]
Get all matching entries.

If one parameter is omitted, then this parameter is not matched against all entries. So omitting all parameters means that you will get all entries.
Parameters
- OptionallocalPublicKey: PublicKey
- OptionalremotePublicKey: PublicKey
- OptionalconnectionRoutesGroupName: string
- OptionalcatchAll: boolean
Returns ConnectionRoutesGroup[]
- Defined in misc/ConnectionEstablishment/ConnectionRoutesGroupMap.ts:125

removeGroup

removeGroup(
    localPublicKey: PublicKey,
    remotePublicKey: PublicKey,
    connectionRoutesGroupName: string,
): void
Remove a specific entry from the map.
Parameters
- localPublicKey: PublicKey
- remotePublicKey: PublicKey
- connectionRoutesGroupName: string
Returns void
- Defined in misc/ConnectionEstablishment/ConnectionRoutesGroupMap.ts:187