Class HttpClientTransport

HTTP Client Transport

Note: HTTP is stateless, so this transport doesn't maintain a persistent connection. The connect() method is a no-op, and state reflects readiness to make requests.

Server → Client notifications are NOT supported over HTTP (use WebSocket for that).

Hierarchy (view full)

EventEmitter<HttpClientEvents>
- HttpClientTransport

Implements

IClientTransport

Index

Constructors

constructor

new HttpClientTransport(url, options?): HttpClientTransport
Parameters
- url: string
- options: HttpClientOptions = {}
Returns HttpClientTransport
Overrides EventEmitter.constructor
- Defined in transport/http/client.ts:86

Accessors

state

get state(): TransportState
Current transport state

Returns TransportState
Implementation of IClientTransport.state
- Defined in transport/http/client.ts:96

isConnected

get isConnected(): boolean
Whether the transport is currently connected

Returns boolean
Implementation of IClientTransport.isConnected
- Defined in transport/http/client.ts:100

Methods

on

on<K>(event, listener): this
Register an event listener
Type Parameters
- K extends keyof TransportEvents
Parameters
- event: K
- listener: EventListener<HttpClientEvents[K]>
Returns this
Implementation of IClientTransport.on
Inherited from EventEmitter.on
- Defined in transport/event-emitter.ts:17

off

off<K>(event, listener): this
Remove an event listener
Type Parameters
- K extends keyof TransportEvents
Parameters
- event: K
- listener: EventListener<HttpClientEvents[K]>
Returns this
Implementation of IClientTransport.off
Inherited from EventEmitter.off
- Defined in transport/event-emitter.ts:28

once

once<K>(event, listener): this
Register a one-time event listener
Type Parameters
- K extends keyof TransportEvents
Parameters
- event: K
- listener: EventListener<HttpClientEvents[K]>
Returns this
Implementation of IClientTransport.once
Inherited from EventEmitter.once
- Defined in transport/event-emitter.ts:37

`Protected` emit

emit<K>(event, ...args): boolean
Emit an event
Type Parameters
- K extends keyof TransportEvents
Parameters
- event: K
- Rest ...args: HttpClientEvents[K]
Returns boolean
Inherited from EventEmitter.emit
- Defined in transport/event-emitter.ts:48

removeAllListeners

removeAllListeners<K>(event?): this
Remove all listeners for an event, or all events
Type Parameters
- K extends keyof TransportEvents
Parameters
- Optional event: K
Returns this
Inherited from EventEmitter.removeAllListeners
- Defined in transport/event-emitter.ts:76

listenerCount

listenerCount<K>(event): number
Get the number of listeners for an event
Type Parameters
- K extends keyof TransportEvents
Parameters
- event: K
Returns number
Inherited from EventEmitter.listenerCount
- Defined in transport/event-emitter.ts:90

send

send(message): Promise<void>
Send a message and return the response

For HTTP transport, this actually performs the request and returns when the response is received (unlike streaming transports).
Parameters
- message: JsonRpcMessage
Returns Promise<void>
Implementation of IClientTransport.send
- Defined in transport/http/client.ts:110

close

close(_reason?): Promise<void>
Close the transport connection
Parameters
- Optional _reason: string
  Optional reason for closing
Returns Promise<void>
Implementation of IClientTransport.close
- Defined in transport/http/client.ts:120

connect

connect(): Promise<void>
Connect to the server

Returns Promise<void>
Implementation of IClientTransport.connect
- Defined in transport/http/client.ts:135

reconnect

reconnect(): Promise<void>
Reconnect to the server (if disconnected)

Returns Promise<void>
Implementation of IClientTransport.reconnect
- Defined in transport/http/client.ts:143

request

request<TResult>(message, signal?): Promise<JsonRpcResponse<TResult>>
Make a JSON-RPC request and return the response

This is the primary method for HTTP transport, providing a more natural request-response pattern.
Type Parameters
- TResult = unknown
Parameters
- message: JsonRpcMessage
- Optional signal: AbortSignal
Returns Promise<JsonRpcResponse<TResult>>
- Defined in transport/http/client.ts:158

batchRequest

batchRequest(messages, signal?): Promise<JsonRpcBatchResponse>
Make a batch request and return all responses
Parameters
- messages: JsonRpcMessage[]
- Optional signal: AbortSignal
Returns Promise<JsonRpcBatchResponse>
- Defined in transport/http/client.ts:172

Class HttpClientTransport

Hierarchy (view full)

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns HttpClientTransport

Accessors

state

Returns TransportState

isConnected

Returns boolean

Methods

on

Type Parameters

Parameters

Returns this

off

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

Protected emit

Type Parameters

Parameters

Returns boolean

removeAllListeners

Type Parameters

Parameters

Returns this

listenerCount

Type Parameters

Parameters

Returns number

send

Parameters

Returns Promise<void>

close

Parameters

Returns Promise<void>

connect

Returns Promise<void>

reconnect

Returns Promise<void>

request

Type Parameters

Parameters

Returns Promise<JsonRpcResponse<TResult>>

batchRequest

Parameters

Returns Promise<JsonRpcBatchResponse>

Settings

Member Visibility

Theme

On This Page

`Protected` emit