SocketmapClient
Defined in: net-socketmap/src/socketmap/socketmap-client.ts:46
Postfix socketmap client.
Implements the socketmap lookup protocol over netstring framing. The protocol is purely request-response with no unsolicited frames, so every inbound netstring answers the preceding lookup.
Spec: http://www.postfix.org/socketmap_table.5.html
Extends
Section titled “Extends”Session<Uint8Array,Uint8Array|string,SocketmapClientEvents>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SocketmapClient(
source,options?):SocketmapClient
Defined in: net-socketmap/src/socketmap/socketmap-client.ts:59
Parameters
Section titled “Parameters”source
Section titled “source”Transport
Any Transport. Postfix socketmaps are usually reached
over a Unix socket — for a Node.js Duplex/net.Socket, wrap it first:
new DuplexTransport(socket) from @ac-kit/net-transport-node.
options?
Section titled “options?”Buffer, payload-length and timeout tuning.
Returns
Section titled “Returns”SocketmapClient
Overrides
Section titled “Overrides”Session< Uint8Array, Uint8Array | string, SocketmapClientEvents >.constructor
Accessors
Section titled “Accessors”buffered
Section titled “buffered”Get Signature
Section titled “Get Signature”get buffered():
number
Defined in: net-core/src/session.ts:243
Bytes received but not yet decoded.
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”Session.buffered
pendingExchanges
Section titled “pendingExchanges”Get Signature
Section titled “Get Signature”get pendingExchanges():
number
Defined in: net-core/src/session.ts:248
Number of outstanding exchanges, including abort tombstones.
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”Session.pendingExchanges
Methods
Section titled “Methods”[asyncDispose]()
Section titled “[asyncDispose]()”[asyncDispose]():
Promise<void>
Defined in: net-core/src/session.ts:277
Destroys the session, so it can be used with await using.
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”Session.[asyncDispose]
destroy()
Section titled “destroy()”destroy(
error?):void
Defined in: net-core/src/session.ts:271
Tear the session down, rejecting every outstanding exchange.
Rejection happens here rather than relying on the transport emitting
close, so callers are never left with promises that hang against a
transport that closes silently.
Parameters
Section titled “Parameters”error?
Section titled “error?”unknown
Optional cause reported to outstanding exchanges.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Session.destroy
end():
Promise<void>
Defined in: net-core/src/session.ts:258
Half-close the outbound direction and flush pending writes.
Prefer this over destroy for protocols with a farewell command, so the peer sees an orderly shutdown.
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”Session.end
isSubscribed()
Section titled “isSubscribed()”isSubscribed<
K>(event,listener):boolean
Defined in: async/src/events/event-dispatcher-map-base.ts:38
Check if a callback is subscribed to a specific event.
Type Parameters
Section titled “Type Parameters”K extends keyof BaseSessionEvents
Parameters
Section titled “Parameters”K
The event name.
listener
Section titled “listener”Callable<BaseSessionEvents[K]>
The callback to check.
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”Session.isSubscribed
lookup()
Section titled “lookup()”lookup(
table,key,options?):Promise<SocketmapResult>
Defined in: net-socketmap/src/socketmap/socketmap-client.ts:76
Look a key up in a table.
Parameters
Section titled “Parameters”string
The socketmap table name, for example forward.
string
The key to look up.
options?
Section titled “options?”ExchangeOptions<Uint8Array<ArrayBufferLike>>
Abort, timeout and abort-policy overrides.
Returns
Section titled “Returns”Promise<SocketmapResult>
The status token and its accompanying value.
subscribe()
Section titled “subscribe()”subscribe<
K>(event,listener,options?):Callable|null
Defined in: async/src/events/event-dispatcher-map-base.ts:23
Type Parameters
Section titled “Type Parameters”K extends keyof BaseSessionEvents
Parameters
Section titled “Parameters”K
listener
Section titled “listener”Callable<BaseSessionEvents[K]>
options?
Section titled “options?”EventDispatcherSubscribeOptions
Returns
Section titled “Returns”Callable | null
Inherited from
Section titled “Inherited from”Session.subscribe
unsubscribe()
Section titled “unsubscribe()”unsubscribe<
K>(event,listener):void
Defined in: async/src/events/event-dispatcher-map-base.ts:31
Unsubscribe a callback from a specific event.
Type Parameters
Section titled “Type Parameters”K extends keyof BaseSessionEvents
Parameters
Section titled “Parameters”K
The event name.
listener
Section titled “listener”Callable<BaseSessionEvents[K]>
The callback to remove.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Session.unsubscribe
wait()
Section titled “wait()”wait<
K>(event,options?):Promise<BaseSessionEvents[K]>
Defined in: async/src/events/event-dispatcher-map-base.ts:45
Wait for the next occurrence of a specific event, optionally matching a predicate.
This is a convenience method that subscribes to the dispatcher, waits for the next event that matches the predicate (if provided), and then unsubscribes automatically.
Type Parameters
Section titled “Type Parameters”K extends keyof BaseSessionEvents
Parameters
Section titled “Parameters”K
The event name to wait for.
options?
Section titled “options?”EventDispatcherWaitOptions<BaseSessionEvents[K]>
Optional settings including predicate and abort signal.
Returns
Section titled “Returns”Promise<BaseSessionEvents[K]>
A promise that resolves with the event arguments as an array.
Inherited from
Section titled “Inherited from”Session.wait