Class NetworkService

IQMESH Network API service

Hierarchy

BaseIqmeshService
- NetworkService

Index

Constructors

Methods

buildOptionsWithRequest ping restart

Constructors

constructor

new NetworkService(): NetworkService
Returns NetworkService
Inherited from BaseIqmeshService.constructor

Methods

`Protected` `Static`buildOptionsWithRequest

buildOptionsWithRequest(
    mType: string,
    shared: IqmeshSharedParams,
    params: null | IqmeshRequestParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Construct IQMESH service request object
Parameters
- mType: string
  Message type
- shared: IqmeshSharedParams
  Shared request parameters
- params: null | IqmeshRequestParams
  Request specific parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
Inherited from BaseIqmeshService.buildOptionsWithRequest
- Defined in services/iqmesh/BaseIqmeshService.ts:17

`Static`ping

ping(
    shared: IqmeshSharedParams,
    params: IqmeshNetworkParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Ping network devices to get online status
Parameters
- shared: IqmeshSharedParams
  Shared IQMESH request parameters
- params: IqmeshNetworkParams
  IQMESH Ping request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/iqmesh/NetworkService.ts:19

`Static`restart

restart(
    shared: IqmeshSharedParams,
    params: IqmeshNetworkParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Restart network devices to get online status
Parameters
- shared: IqmeshSharedParams
  Shared IQMESH request parameters
- params: IqmeshNetworkParams
  IQMESH Restart request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/iqmesh/NetworkService.ts:35