Class NetInterfaceSet

A collection of NetInterfaces managed as a unit.

Hierarchy (view full)

TransportInterfaceSet<NetInterface>
- NetInterfaceSet

Index

Constructors

Accessors

added deleted size

Methods

[iterator] add clear close create delete filter find get has hasInterfaceFor interfaceFor map [create]

Constructors

constructor

new NetInterfaceSet(...initialInterfaces): NetInterfaceSet
Parameters
- Rest...initialInterfaces: NetInterface[]
Returns NetInterfaceSet
Inherited from TransportInterfaceSet.constructor
- Defined in packages/general/src/net/TransportInterface.ts:32

Accessors

added

get added(): Observable<[T], void>
Returns Observable<[T], void>
Inherited from TransportInterfaceSet.added
- Defined in packages/general/src/util/Set.ts:172

deleted

get deleted(): Observable<[T], void>
Returns Observable<[T], void>
Inherited from TransportInterfaceSet.deleted
- Defined in packages/general/src/util/Set.ts:179

size

get size(): number
Returns number
Inherited from TransportInterfaceSet.size
- Defined in packages/general/src/util/Set.ts:67

Methods

[iterator]

[iterator](): SetIterator<NetInterface>
Returns SetIterator<NetInterface>
Inherited from TransportInterfaceSet.[iterator]
- Defined in packages/general/src/util/Set.ts:63

add

add(item): void
Parameters
- item: NetInterface
Returns void
Inherited from TransportInterfaceSet.add
- Defined in packages/general/src/util/Set.ts:97

clear

clear(): void
Returns void
Inherited from TransportInterfaceSet.clear
- Defined in packages/general/src/util/Set.ts:168

close

close(): Promise<void>
Closes all interfaces.

Returns Promise<void>
Inherited from TransportInterfaceSet.close
- Defined in packages/general/src/net/TransportInterface.ts:45

`Protected`create

create(definition): NetInterface
Parameters
- definition: NetInterface
Returns NetInterface
Inherited from TransportInterfaceSet.create
- Defined in packages/general/src/util/Set.ts:186

delete

delete(item): boolean
Parameters
- item: NetInterface
Returns boolean
Inherited from TransportInterfaceSet.delete
- Defined in packages/general/src/util/Set.ts:144

filter

filter(predicate): NetInterface[]
Parameters
- predicate: ((item: NetInterface) => undefined | boolean)
  - - (item): undefined | boolean
    - Parameters
      item: NetInterface
      Returns undefined | boolean
Returns NetInterface[]
Inherited from TransportInterfaceSet.filter
- Defined in packages/general/src/util/Set.ts:83

find

find(predicate): undefined | NetInterface
Parameters
- predicate: ((item: NetInterface) => undefined | boolean)
  - - (item): undefined | boolean
    - Parameters
      item: NetInterface
      Returns undefined | boolean
Returns undefined | NetInterface
Inherited from TransportInterfaceSet.find
- Defined in packages/general/src/util/Set.ts:75

get

get<F>(field, value): undefined | NetInterface
Type Parameters
- F extends keyof NetInterface
Parameters
- field: F
- value: NetInterface[F]
Returns undefined | NetInterface
Inherited from TransportInterfaceSet.get
- Defined in packages/general/src/util/Set.ts:125

has

has(item): boolean
Parameters
- item: NetInterface
Returns boolean
Inherited from TransportInterfaceSet.has
- Defined in packages/general/src/util/Set.ts:93

hasInterfaceFor

hasInterfaceFor(type, address?): boolean
Obtain an interface of specific type.
Parameters
- type: ChannelType
- Optionaladdress: string
Returns boolean
Inherited from TransportInterfaceSet.hasInterfaceFor
- Defined in packages/general/src/net/TransportInterface.ts:61

interfaceFor

interfaceFor(type, address?): undefined | NetInterface
Obtain an interface capable of routing an address.
Parameters
- type: ChannelType
- Optionaladdress: string
Returns undefined | NetInterface
Inherited from TransportInterfaceSet.interfaceFor
- Defined in packages/general/src/net/TransportInterface.ts:54

map

map<R>(mapper): R[]
Type Parameters
- R
Parameters
- mapper: ((item: NetInterface) => R)
  - - (item): R
    - Parameters
      item: NetInterface
      Returns R
Returns R[]
Inherited from TransportInterfaceSet.map
- Defined in packages/general/src/util/Set.ts:71

`Static`[create]

[create](env): NetInterfaceSet
Parameters
- env: Environment
Returns NetInterfaceSet
Overrides TransportInterfaceSet.[create]
- Defined in packages/general/src/net/NetInterface.ts:28