Interface FwFace

A socket or network interface associated with forwarding plane.

interface FwFace {
    attributes: FwFace.Attributes;
    fw: Forwarder;
    running: boolean;
    addAnnouncement(name): void;
    addRoute(name, announcement?): void;
    close(): void;
    hasRoute(name): boolean;
    removeAnnouncement(name): void;
    removeRoute(name, announcement?): void;
    toString(): string;
}

Hierarchy

TypedEventTarget<EventMap>
- FwFace

Index

Properties

attributes fw running

Methods

addAnnouncement addRoute close hasRoute removeAnnouncement removeRoute toString

Properties

`Readonly` attributes

attributes: FwFace.Attributes

`Readonly` fw

`Readonly` running

running: boolean

Methods

addAnnouncement

addAnnouncement(name): void
Add a prefix announcement associated with the face.
Parameters
- name: NameLike
Returns void
- Defined in face.ts:40

addRoute

addRoute(name, announcement?): void
Add a route toward the face.
Parameters
- name: NameLike
- Optional announcement: FwFace.RouteAnnouncement
Returns void
- Defined in face.ts:34

close

close(): void
Shutdown the face.

Returns void
- Defined in face.ts:26

hasRoute

hasRoute(name): boolean
Determine if a route is present on the face.
Parameters
- name: NameLike
Returns boolean
- Defined in face.ts:31

removeAnnouncement

removeAnnouncement(name): void
Remove a prefix announcement associated with the face.
Parameters
- name: NameLike
Returns void
- Defined in face.ts:43

removeRoute

removeRoute(name, announcement?): void
Remove a route toward the face.
Parameters
- name: NameLike
- Optional announcement: FwFace.RouteAnnouncement
Returns void
- Defined in face.ts:37

toString

toString(): string
Returns string
- Defined in face.ts:28

Generated using TypeDoc