Class Adapter

Connects an AgentHandler to the server.

Example

const adapter = new Adapter(config, new Lotse(), { clock: fake.clock });
adapter.source = new RecordingSource(await adapter.makeSource());
const done = adapter.run();
await adapter.stop();
await done;

Index

Constructors

constructor

new Adapter(
    config: AdapterConfig,
    handler: AgentHandler,
    options?: AdapterOptions,
): Adapter
Creates the adapter; nothing connects before Adapter.run.
Parameters
- config: AdapterConfig
  The adapter configuration.
- handler: AgentHandler
  The runtime side.
- options: AdapterOptions = {}
  Clock, source, inbox, outbox store, fetch, WebSocket and logger.
Returns Adapter
Throws
TypeError when baseUrl uses clear text off the loopback host.

Properties

`Readonly`client

client: ApiClient

The REST client; every request of a run's handler is bound to the run (07 SR9).

`Readonly`clock

clock: Clock

The time source.

`Readonly`config

config: AdapterConfig

The adapter configuration.

`Readonly`handler

handler: AgentHandler

The runtime side.

`Readonly`inbox

inbox: InboxStore

The inbox of accepted events (and the jti store of the verifier).

`Readonly`outbox

outbox: Outbox

The outbox of replies and writes.

`Readonly`settings

settings: SdkSettings

The resolved SDK settings.

source

source: EventSource | undefined

The event source; set it before Adapter.run to wrap the default one.

verifier

verifier: InvocationVerifier | undefined

The token check, created by Adapter.run.

Methods

heartbeat

heartbeat(): {}
Returns the agent heartbeat of this process (09 4.8), active_runs included.

Returns {}
The heartbeat (generated type).

Throws
RangeError when a configured name or version breaks the heartbeat forms.

makeSource

makeSource(): Promise<EventSource>
Builds the source transport names, for a test to wrap before Adapter.run.

Returns Promise<EventSource>
The gateway or polling source of this adapter.
Throws
ProblemError when the discovery failed.
Example
```
adapter.source = new TamperingSource(await adapter.makeSource(), rewrite);
```

run

run(): Promise<CloseReason>
Runs until the source stops or Adapter.stop is called.

Returns Promise<CloseReason>
Why the adapter stopped (for example 4015 when another process took the consumer over, or 1000 after Adapter.stop).

Throws
ProblemError when the discovery or the first JWKS fetch failed.

stop

stop(): Promise<void>
Stops the source; Adapter.run returns after the current delivery. Handler work stops being awaited; an entry whose run has not started stays in the inbox for the next process (09 4.9).

Returns Promise<void>
A promise that resolves once the source is closing.

Class Adapter

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Adapter

Throws

Properties

Readonlyclient

Readonlyclock

Readonlyconfig

Readonlyhandler

Readonlyinbox

Readonlyoutbox

Readonlysettings

source

verifier

Methods

heartbeat

Returns {}

Throws

makeSource

Returns Promise<EventSource>

Throws

Example

run

Returns Promise<CloseReason>

Throws

stop

Returns Promise<void>

Settings

On This Page

`Readonly`client

`Readonly`clock

`Readonly`config

`Readonly`handler

`Readonly`inbox

`Readonly`outbox

`Readonly`settings