Class FrcService

Embedded FRC API service

Hierarchy (View Summary)

BaseEmbedService
- FrcService

Index

Constructors

Methods

buildOptionsWithRequest extraResult send sendSelective setParams

Constructors

constructor

new FrcService(): FrcService
Returns FrcService
Inherited from BaseEmbedService.constructor

Methods

`Protected` `Static`buildOptionsWithRequest

buildOptionsWithRequest(
    mType: string,
    shared: EmbedSharedParams,
    params?: null | EmbedRequestParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Construct embedded peripheral request object
Parameters
- mType: string
  Message type
- shared: EmbedSharedParams
  Shared request parameters
- params: null | EmbedRequestParams = null
  Request specific parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
Inherited from BaseEmbedService.buildOptionsWithRequest
- Defined in services/BaseEmbedService.ts:17

`Static`extraResult

extraResult(
shared: EmbedSharedParams,
options: DaemonMessageOptions,
): DaemonMessageOptions
Get extra FRC data that did not fit in buffer
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/FrcService.ts:25

`Static`send

send(
    shared: EmbedSharedParams,
    params: FrcSendParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Send FRC request
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: FrcSendParams
  Send FRC request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/FrcService.ts:41

`Static`sendSelective

sendSelective(
    shared: EmbedSharedParams,
    params: FrcSendSelectiveParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Send FRC request to selected nodes
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: FrcSendSelectiveParams
  Send selective FRC request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/FrcService.ts:57

`Static`setParams

setParams(
    shared: EmbedSharedParams,
    params: EmbedFrcSetParams,
    options: DaemonMessageOptions,
): DaemonMessageOptions
Set FRC parameters
Parameters
- shared: EmbedSharedParams
  Shared request parameters
- params: EmbedFrcSetParams
  Set FRC params request parameters
- options: DaemonMessageOptions
  Message options
Returns DaemonMessageOptions
Message options with request
- Defined in services/embed/FrcService.ts:73