Skip to content

Documentation / @agentick/gateway / HTTPTransport

Class: HTTPTransport

Defined in: gateway/src/http-transport.ts:194

Base class with shared transport functionality.

Extends

Constructors

Constructor

new HTTPTransport(config): HTTPTransport

Defined in: gateway/src/http-transport.ts:200

Parameters

config

HTTPTransportConfig

Returns

HTTPTransport

Overrides

BaseTransport.constructor

Properties

type

readonly type: "http"

Defined in: gateway/src/http-transport.ts:195

Transport type - must be set by subclass

Overrides

BaseTransport.type

Accessors

clientCount

Get Signature

get clientCount(): number

Defined in: gateway/src/transport.ts:165

Number of connected clients

Returns

number

Number of connected clients

Inherited from

BaseTransport.clientCount

Methods

broadcast()

broadcast(message): void

Defined in: gateway/src/transport.ts:159

Broadcast to all authenticated clients

Parameters

message

GatewayMessage

Returns

void

Inherited from

BaseTransport.broadcast


getAuthenticatedClients()

getAuthenticatedClients(): TransportClient[]

Defined in: gateway/src/transport.ts:155

Get authenticated clients

Returns

TransportClient[]

Inherited from

BaseTransport.getAuthenticatedClients


getClient()

getClient(id): TransportClient | undefined

Defined in: gateway/src/transport.ts:147

Get a client by ID

Parameters

id

string

Returns

TransportClient | undefined

Inherited from

BaseTransport.getClient


getClients()

getClients(): TransportClient[]

Defined in: gateway/src/transport.ts:151

Get all connected clients

Returns

TransportClient[]

Inherited from

BaseTransport.getClients


handleExpressRequest()

handleExpressRequest(req, res, next): void

Defined in: gateway/src/http-transport.ts:863

Handle a request from Express middleware. This allows the gateway to be mounted in an existing Express app.

Parameters

req

IncomingMessage & object

res

ServerResponse<IncomingMessage> & object

next

(err?) => void

Returns

void


on()

on<K>(event, handler): void

Defined in: gateway/src/transport.ts:143

Register event handlers

Type Parameters

K

K extends keyof TransportEvents

Parameters

event

K

handler

TransportEvents[K]

Returns

void

Inherited from

BaseTransport.on


start()

start(): Promise<void>

Defined in: gateway/src/http-transport.ts:205

Start the transport server

Returns

Promise<void>

Overrides

BaseTransport.start


stop()

stop(): Promise<void>

Defined in: gateway/src/http-transport.ts:240

Stop the transport server

Returns

Promise<void>

Overrides

BaseTransport.stop

Released under the ISC License.