Class RtNetlinkSocket

TODO

This socket silently discards invalid messages (see invalid event).

Hierarchy

EventEmitter
- RtNetlinkSocket

Constructors

constructor

new RtNetlinkSocket(socket: NetlinkSocket, options?: RtNetlinkSocketOptions): RtNetlinkSocket

Overrides EventEmitter.constructor
- Defined in rt/rt.ts:48
Parameters
- socket: NetlinkSocket
- Optional options: RtNetlinkSocketOptions
Returns RtNetlinkSocket

Properties

Readonly socket

socket: NetlinkSocket

Methods

delAddress

delAddress(data: Address, attrs?: AddressAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<AddressMessage[]>

- Defined in rt/rt.ts:129
Parameters
- data: Address
- Optional attrs: AddressAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<AddressMessage[]>

delLink

delLink(data: Link, attrs?: LinkAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<LinkMessage[]>

- Defined in rt/rt.ts:167
Parameters
- data: Link
- Optional attrs: LinkAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<LinkMessage[]>

delNeighbor

delNeighbor(data: Neighbor, attrs?: NeighborAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<NeighborMessage[]>

- Defined in rt/rt.ts:227
Parameters
- data: Neighbor
- Optional attrs: NeighborAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<NeighborMessage[]>

delQdisc

delQdisc(data: Tc, attrs?: TcAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<TcMessage[]>

- Defined in rt/rt.ts:314
Parameters
- data: Tc
- Optional attrs: TcAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<TcMessage[]>

delRoute

delRoute(data: Route, attrs?: RouteAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<RouteMessage[]>

- Defined in rt/rt.ts:352
Parameters
- data: Route
- Optional attrs: RouteAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<RouteMessage[]>

delRule

delRule(data: Rule, attrs?: RuleAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<RuleMessage[]>

- Defined in rt/rt.ts:390
Parameters
- data: Rule
- Optional attrs: RuleAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<RuleMessage[]>

delTrafficAction

delTrafficAction(data: TcAction, attrs?: {}, options?: RtNetlinkSendOptions & RequestOptions): Promise<TcActionMessage[]>

- Defined in rt/rt.ts:91
Parameters
- data: TcAction
- Optional attrs: {}
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<TcActionMessage[]>

delTrafficClass

delTrafficClass(data: Tc, attrs?: TcAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<TcMessage[]>

- Defined in rt/rt.ts:428
Parameters
- data: Tc
- Optional attrs: TcAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<TcMessage[]>

delTrafficFilter

delTrafficFilter(data: Tc, attrs?: TcAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<TcMessage[]>

- Defined in rt/rt.ts:466
Parameters
- data: Tc
- Optional attrs: TcAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<TcMessage[]>

getAddress

getAddress(data: Address, attrs?: AddressAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<AddressMessage[]>

- Defined in rt/rt.ts:140
Parameters
- data: Address
- Optional attrs: AddressAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<AddressMessage[]>

getAddresses

getAddresses(data?: Address, attrs?: AddressAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<AddressMessage[]>

- Defined in rt/rt.ts:151
Parameters
- Optional data: Address
- Optional attrs: AddressAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<AddressMessage[]>

getLink

getLink(data: Link, attrs?: LinkAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<LinkMessage[]>

- Defined in rt/rt.ts:178
Parameters
- data: Link
- Optional attrs: LinkAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<LinkMessage[]>

getLinks

getLinks(data?: Link, attrs?: LinkAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<LinkMessage[]>

- Defined in rt/rt.ts:200
Parameters
- Optional data: Link
- Optional attrs: LinkAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<LinkMessage[]>

getNeighbor

getNeighbor(data: Neighbor, attrs?: NeighborAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<NeighborMessage[]>

- Defined in rt/rt.ts:238
Parameters
- data: Neighbor
- Optional attrs: NeighborAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<NeighborMessage[]>

getNeighborTable

getNeighborTable(data: NeighborTable, attrs?: NeighborTableAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<NeighborTableMessage[]>

- Defined in rt/rt.ts:265
Parameters
- data: NeighborTable
- Optional attrs: NeighborTableAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<NeighborTableMessage[]>

getNeighborTables

getNeighborTables(data?: NeighborTable, attrs?: NeighborTableAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<NeighborTableMessage[]>

- Defined in rt/rt.ts:287
Parameters
- Optional data: NeighborTable
- Optional attrs: NeighborTableAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<NeighborTableMessage[]>

getNeighbors

getNeighbors(data?: Neighbor, attrs?: NeighborAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<NeighborMessage[]>

- Defined in rt/rt.ts:249
Parameters
- Optional data: Neighbor
- Optional attrs: NeighborAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<NeighborMessage[]>

getQdisc

getQdisc(data: Tc, attrs?: TcAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<TcMessage[]>

- Defined in rt/rt.ts:325
Parameters
- data: Tc
- Optional attrs: TcAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<TcMessage[]>

getQdiscs

getQdiscs(data?: Tc, attrs?: TcAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<TcMessage[]>

- Defined in rt/rt.ts:336
Parameters
- Optional data: Tc
- Optional attrs: TcAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<TcMessage[]>

getRoute

getRoute(data: Route, attrs?: RouteAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<RouteMessage[]>

- Defined in rt/rt.ts:363
Parameters
- data: Route
- Optional attrs: RouteAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<RouteMessage[]>

getRoutes

getRoutes(data?: Route, attrs?: RouteAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<RouteMessage[]>

- Defined in rt/rt.ts:374
Parameters
- Optional data: Route
- Optional attrs: RouteAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<RouteMessage[]>

getRule

getRule(data: Rule, attrs?: RuleAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<RuleMessage[]>

- Defined in rt/rt.ts:401
Parameters
- data: Rule
- Optional attrs: RuleAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<RuleMessage[]>

getRules

getRules(data?: Rule, attrs?: RuleAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<RuleMessage[]>

- Defined in rt/rt.ts:412
Parameters
- Optional data: Rule
- Optional attrs: RuleAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<RuleMessage[]>

getTrafficAction

getTrafficAction(data: TcAction, attrs?: {}, options?: RtNetlinkSendOptions & RequestOptions): Promise<TcActionMessage[]>

- Defined in rt/rt.ts:102
Parameters
- data: TcAction
- Optional attrs: {}
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<TcActionMessage[]>

getTrafficActions

getTrafficActions(data?: TcAction, attrs?: {}, options?: RtNetlinkSendOptions & RequestOptions): Promise<TcActionMessage[]>

- Defined in rt/rt.ts:113
Parameters
- Optional data: TcAction
- Optional attrs: {}
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<TcActionMessage[]>

getTrafficClass

getTrafficClass(data: Tc, attrs?: TcAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<TcMessage[]>

- Defined in rt/rt.ts:439
Parameters
- data: Tc
- Optional attrs: TcAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<TcMessage[]>

getTrafficClasses

getTrafficClasses(data?: Tc, attrs?: TcAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<TcMessage[]>

- Defined in rt/rt.ts:450
Parameters
- Optional data: Tc
- Optional attrs: TcAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<TcMessage[]>

getTrafficFilter

getTrafficFilter(data: Tc, attrs?: TcAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<TcMessage[]>

- Defined in rt/rt.ts:477
Parameters
- data: Tc
- Optional attrs: TcAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<TcMessage[]>

getTrafficFilters

getTrafficFilters(data?: Tc, attrs?: TcAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<TcMessage[]>

- Defined in rt/rt.ts:488
Parameters
- Optional data: Tc
- Optional attrs: TcAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<TcMessage[]>

newAddress

newAddress(data: Address, attrs?: AddressAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<AddressMessage[]>

- Defined in rt/rt.ts:118
Parameters
- data: Address
- Optional attrs: AddressAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<AddressMessage[]>

newLink

newLink(data: Link, attrs?: LinkAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<LinkMessage[]>

- Defined in rt/rt.ts:156
Parameters
- data: Link
- Optional attrs: LinkAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<LinkMessage[]>

newNdUserOption

newNdUserOption(data: NdUserOption, attrs?: NdUserOptionAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<NdUserOptionMessage[]>

- Defined in rt/rt.ts:205
Parameters
- data: NdUserOption
- Optional attrs: NdUserOptionAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<NdUserOptionMessage[]>

newNeighbor

newNeighbor(data: Neighbor, attrs?: NeighborAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<NeighborMessage[]>

- Defined in rt/rt.ts:216
Parameters
- data: Neighbor
- Optional attrs: NeighborAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<NeighborMessage[]>

newNeighborTable

newNeighborTable(data: NeighborTable, attrs?: NeighborTableAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<NeighborTableMessage[]>

- Defined in rt/rt.ts:254
Parameters
- data: NeighborTable
- Optional attrs: NeighborTableAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<NeighborTableMessage[]>

newPrefix

newPrefix(data: Prefix, attrs?: PrefixAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<PrefixMessage[]>

- Defined in rt/rt.ts:292
Parameters
- data: Prefix
- Optional attrs: PrefixAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<PrefixMessage[]>

newQdisc

newQdisc(data: Tc, attrs?: TcAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<TcMessage[]>

- Defined in rt/rt.ts:303
Parameters
- data: Tc
- Optional attrs: TcAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<TcMessage[]>

newRoute

newRoute(data: Route, attrs?: RouteAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<RouteMessage[]>

- Defined in rt/rt.ts:341
Parameters
- data: Route
- Optional attrs: RouteAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<RouteMessage[]>

newRule

newRule(data: Rule, attrs?: RuleAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<RuleMessage[]>

- Defined in rt/rt.ts:379
Parameters
- data: Rule
- Optional attrs: RuleAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<RuleMessage[]>

newTrafficAction

newTrafficAction(data: TcAction, attrs?: {}, options?: RtNetlinkSendOptions & RequestOptions): Promise<TcActionMessage[]>

- Defined in rt/rt.ts:80
Parameters
- data: TcAction
- Optional attrs: {}
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<TcActionMessage[]>

newTrafficClass

newTrafficClass(data: Tc, attrs?: TcAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<TcMessage[]>

- Defined in rt/rt.ts:417
Parameters
- data: Tc
- Optional attrs: TcAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<TcMessage[]>

newTrafficFilter

newTrafficFilter(data: Tc, attrs?: TcAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<TcMessage[]>

- Defined in rt/rt.ts:455
Parameters
- data: Tc
- Optional attrs: TcAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<TcMessage[]>

request

request(type: MessageType, data: Uint8Array | Uint8Array[], options?: RtNetlinkSendOptions & RequestOptions): Promise<Message[]>

- Defined in rt/rt.ts:71
Parameters
- type: MessageType
- data: Uint8Array | Uint8Array[]
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<Message[]>

send

send(type: MessageType, data: Uint8Array | Uint8Array[], options?: RtNetlinkSendOptions & RequestOptions, callback?: (error?: Error) => any): number

- Defined in rt/rt.ts:62
Parameters
- type: MessageType
- data: Uint8Array | Uint8Array[]
- Optional options: RtNetlinkSendOptions & RequestOptions
- Optional callback: (error?: Error) => any
  - - (error?: Error): any
    - Parameters
      - Optional error: Error
      Returns any
Returns number

setLink

setLink(data: Link, attrs?: LinkAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<LinkMessage[]>

- Defined in rt/rt.ts:189
Parameters
- data: Link
- Optional attrs: LinkAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<LinkMessage[]>

setNeighborTable

setNeighborTable(data: NeighborTable, attrs?: NeighborTableAttrs, options?: RtNetlinkSendOptions & RequestOptions): Promise<NeighborTableMessage[]>

- Defined in rt/rt.ts:276
Parameters
- data: NeighborTable
- Optional attrs: NeighborTableAttrs
- Optional options: RtNetlinkSendOptions & RequestOptions
Returns Promise<NeighborTableMessage[]>

Generated using TypeDoc