Class ESPTransportManager

Manages the transport layer for ESP node communication, allowing configuration of local or cloud-based transport modes.

This class abstracts the underlying transport mechanism and provides methods for setting and retrieving node parameters.

Index

Constructors

Methods

getParams setParam

Constructors

constructor

new ESPTransportManager(
transportConfig: ESPTransportConfig,
): ESPTransportManager
Creates an instance of ESPTransportManager with a specified transport configuration.
Parameters
- transportConfig: ESPTransportConfig
  The configuration specifying the type of transport (local or cloud or custom) with any additional metadata and transportManager for custom transport.
Returns ESPTransportManager
- Defined in src/services/ESPTransport/ESPTransportManager.ts:35

Methods

getParams

getParams(
payload: Record<string, any>,
nodeRef?: ESPRMNode,
): Promise<Record<string, any>>
Retrieves parameters from the node using the configured transport mechanism.
Parameters
- payload: Record<string, any>
  A record containing the data required to retrieve node parameters.
- OptionalnodeRef: ESPRMNode
  Optional reference to the ESPRMNode instance for custom transport.
Returns Promise<Record<string, any>>
A promise that resolves to a record of the node parameters.
- Defined in src/services/ESPTransport/ESPTransportManager.ts:73

setParam

setParam(
payload: Record<string, any>,
nodeRef?: ESPRMNode,
): Promise<ESPAPIResponse>
Sets a parameter on the node using the configured transport mechanism.
Parameters
- payload: Record<string, any>
  A record containing the parameter data to set on the node.
- OptionalnodeRef: ESPRMNode
  Optional reference to the ESPRMNode instance for custom transport.
Returns Promise<ESPAPIResponse>
A promise that resolves to the response of the set operation.
- Defined in src/services/ESPTransport/ESPTransportManager.ts:59