WebSocketHandler | AWS SDK for JavaScript v3

Base handler for websocket requests. By default, the request input and output body will be in a ReadableStream, because of interface consistency among middleware. If ReadableStream is not available, like in React-Native, the response body will be an async iterable.

Hierarchy

WebSocketHandler

Implements

RequestHandler

Index

Constructors

constructor

Properties

Methods

Object literals

metadata

Constructors

constructor

new WebSocketHandler(__namedParameters?: { connectionTimeout: number }): WebSocketHandler

- Defined in packages/middleware-sdk-transcribe-streaming/src/websocket-handler.ts:25
Parameters
- Default value __namedParameters: { connectionTimeout: number } = {}
  - connectionTimeout: number
Returns WebSocketHandler

Properties

Private Readonly connectionTimeout

connectionTimeout: number

Private Readonly sockets

sockets: Record<string, WebSocket[]>

Methods

Private connect

connect(socket: WebSocket, data: AsyncIterable<Uint8Array>): AsyncIterable<Uint8Array>

- Defined in packages/middleware-sdk-transcribe-streaming/src/websocket-handler.ts:97
Parameters
- socket: WebSocket
- data: AsyncIterable<Uint8Array>
Returns AsyncIterable<Uint8Array>

destroy

destroy(): void

- Defined in packages/middleware-sdk-transcribe-streaming/src/websocket-handler.ts:35
Destroys the WebSocketHandler. Closes all sockets from the socket pool.

Returns void

handle

handle(request: HttpRequest): Promise<{ response: HttpResponse }>

- Defined in packages/middleware-sdk-transcribe-streaming/src/websocket-handler.ts:53
Parameters
- request: HttpRequest
Returns Promise<{ response: HttpResponse }>

Private removeNotUsableSockets

removeNotUsableSockets(url: string): void

- Defined in packages/middleware-sdk-transcribe-streaming/src/websocket-handler.ts:47
Removes all closing/closed sockets from the socket pool for URL.

Parameters
- url: string
Returns void

Private waitForReady

waitForReady(socket: WebSocket, connectionTimeout: number): Promise<void>

- Defined in packages/middleware-sdk-transcribe-streaming/src/websocket-handler.ts:79
Parameters
- socket: WebSocket
- connectionTimeout: number
Returns Promise<void>

Hierarchy

Implements

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

Parameters

Default value __namedParameters: { connectionTimeout: number } = {}

connectionTimeout: number

Returns WebSocketHandler

Properties

Private Readonly connectionTimeout

Private Readonly sockets

Methods

Private connect

Parameters

socket: WebSocket

data: AsyncIterable<Uint8Array>

Returns AsyncIterable<Uint8Array>

destroy

Returns void

handle

Parameters

request: HttpRequest

Returns Promise<{ response: HttpResponse }>

Private removeNotUsableSockets

Parameters

url: string

Returns void

Private waitForReady

Parameters

socket: WebSocket

connectionTimeout: number

Returns Promise<void>

Object literals

Readonly metadata

handlerProtocol