AuthClientFlow | Ataraxia

Authentication flow as seen from the client. This flow has an initial message that is sent to the server being connected to. It will then receive additional data from the server until the server replies either accepts or rejects the authentication attempt.

Hierarchy

AuthClientFlow

Index

Methods

destroy

destroy(): Promise<void>

- Defined in packages/transport/src/auth/AuthClientFlow.ts:52
Destroy this flow, releasing any resources it has.

Returns Promise<void>

initialMessage

initialMessage(): Promise<ArrayBuffer>

- Defined in packages/transport/src/auth/AuthClientFlow.ts:37
Get the initial message to send to the server.

Returns Promise<ArrayBuffer>

receiveData

receiveData(data: ArrayBuffer): Promise<AuthClientReply>

- Defined in packages/transport/src/auth/AuthClientFlow.ts:47
Receive additional data from the server. This is used for some flows that need to negotiate additional things. The reply will be sent to the server.

Parameters
- data: ArrayBuffer
  - buffer with data
Returns Promise<AuthClientReply>

Hierarchy

Index

Methods

Methods

destroy

Returns Promise<void>

initialMessage

Returns Promise<ArrayBuffer>

receiveData

Parameters

data: ArrayBuffer

Returns Promise<AuthClientReply>