Skip to main content

@hyperledger/identus-edge-agent-sdk / Exports / Domain / Protocols / Startable / Controller

Class: Controller

Protocols.Startable.Controller

define the structure of a Startable entity

Hierarchy

Implements

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new Controller(): Controller

Returns

Controller

Properties

state

state: State = State.STOPPED

current status of the entity

Implementation of

IController.state

Defined in

src/domain/protocols/Startable.ts:42

Methods

_start

_start(): Promise<void>

internal method to define specific startup routine

used by start() internally

implement with protected to keep hidden from class interface

Returns

Promise<void>

Defined in

src/domain/protocols/Startable.ts:51


_stop

_stop(): Promise<void>

internal method to define teardown routine

used by stop() internally

implement with protected to keep hidden from class interface

Returns

Promise<void>

Defined in

src/domain/protocols/Startable.ts:60


start

start(): Promise<State>

handle the startup of an entity

updates state according to lifecycle

Returns

Promise<State>

Implementation of

IController.start

Defined in

src/domain/protocols/Startable.ts:62


stop

stop(): Promise<State>

handle the teardown of an entity

updates state according to lifecycle

Returns

Promise<State>

Implementation of

IController.stop

Defined in

src/domain/protocols/Startable.ts:72