X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FMessageValue.html;h=9b81cccdd537e98a7c877bca584e9e8fce8b6582;hb=2493c34370d0839614058bb55254fd7aec91b664;hp=17cb0e1a50b5609eac49babb6bfbc098e8b3d946;hpb=c02dd5c31cb3ec023721a8564e0c1a1540929226;p=poolifier.git diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index 17cb0e1a..9b81cccd 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -1,45 +1,51 @@ -MessageValue | poolifier - v3.0.10

Interface MessageValue<Data, ErrorData>Internal

Message object that is passed between main worker and worker.

-
interface MessageValue {
    checkActive?: boolean;
    data?: Data;
    kill?: true | "success" | "SOFT" | "HARD" | "failure";
    name?: string;
    port?: MessagePort;
    ready?: boolean;
    statistics?: WorkerStatistics;
    taskFunction?: string;
    taskFunctionName?: string;
    taskFunctionNames?: string[];
    taskFunctionOperation?: "add" | "default" | "remove";
    taskFunctionOperationStatus?: boolean;
    taskId?: string;
    taskPerformance?: TaskPerformance;
    timestamp?: number;
    transferList?: TransferListItem[];
    workerError?: WorkerError<ErrorData>;
    workerId?: number;
}

Type Parameters

  • Data = unknown

    Type of data sent to the worker or execution response. This can only be structured-cloneable data.

    -

  • ErrorData = unknown

    Type of data sent to the worker triggering an error. This can only be structured-cloneable data.

    -

Hierarchy

  • Task<Data>
    • MessageValue

Properties

checkActive? -data? -kill? -name? -port? -ready? -statistics? -taskFunction? -taskFunctionName? -taskFunctionNames? -taskFunctionOperation? -taskFunctionOperationStatus? -taskId? -taskPerformance? -timestamp? -transferList? -workerError? -workerId? -

Properties

Optional Readonly checkActive

checkActive?: boolean

Whether the worker starts or stops its activity check.

-

Optional Readonly data

data?: Data

Task input data that will be passed to the worker.

-

Optional Readonly kill

kill?: true | "success" | "SOFT" | "HARD" | "failure"

Kill code.

-

Optional Readonly name

name?: string

Task name.

-

Optional Readonly port

port?: MessagePort

Message port.

-

Optional Readonly ready

ready?: boolean

Whether the worker is ready or not.

-

Optional Readonly statistics

statistics?: WorkerStatistics

Whether the worker computes the given statistics or not.

-

Optional Readonly taskFunction

taskFunction?: string

Task function serialized to string.

-

Optional Readonly taskFunctionName

taskFunctionName?: string

Task function name.

-

Optional Readonly taskFunctionNames

taskFunctionNames?: string[]

Task function names.

-

Optional Readonly taskFunctionOperation

taskFunctionOperation?: "add" | "default" | "remove"

Task function operation:

+MessageValue | poolifier - v4.0.11

Interface MessageValue<Data, ErrorData>Internal

Message object that is passed between main worker and worker.

+
interface MessageValue<Data, ErrorData> {
    checkActive?: boolean;
    data?: Data;
    kill?: true | "success" | "SOFT" | "HARD" | "failure";
    name?: string;
    port?: MessagePort;
    priority?: number;
    ready?: boolean;
    statistics?: WorkerStatistics;
    strategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN";
    taskFunction?: string;
    taskFunctionOperation?: "add" | "default" | "remove";
    taskFunctionOperationStatus?: boolean;
    taskFunctionProperties?: TaskFunctionProperties;
    taskFunctionsProperties?: TaskFunctionProperties[];
    taskId?: `${string}-${string}-${string}-${string}-${string}`;
    taskPerformance?: TaskPerformance;
    timestamp?: number;
    transferList?: readonly TransferListItem[];
    workerError?: WorkerError<ErrorData>;
    workerId?: number;
}

Type Parameters

  • Data = unknown

    Type of data sent to the worker or execution response. This can only be structured-cloneable data.

    +
  • ErrorData = unknown

    Type of data sent to the worker triggering an error. This can only be structured-cloneable data.

    +

Hierarchy (view full)

Properties

checkActive? +data? +kill? +name? +port? +priority? +ready? +statistics? +strategy? +taskFunction? +taskFunctionOperation? +taskFunctionOperationStatus? +taskFunctionProperties? +taskFunctionsProperties? +taskId? +taskPerformance? +timestamp? +transferList? +workerError? +workerId? +

Properties

Optional Readonly checkActive

checkActive?: boolean

Whether the worker starts or stops its activity check.

+

Optional Readonly data

data?: Data

Task input data that will be passed to the worker.

+

Optional Readonly kill

kill?: true | "success" | "SOFT" | "HARD" | "failure"

Kill code.

+

Optional Readonly name

name?: string

Task name.

+

Optional Readonly port

port?: MessagePort

Message port.

+

Optional Readonly priority

priority?: number

Task priority. Lower values have higher priority.

+

Default Value

0
+
+

Optional Readonly ready

ready?: boolean

Whether the worker is ready or not.

+

Optional Readonly statistics

statistics?: WorkerStatistics

Whether the worker computes the given statistics or not.

+

Optional Readonly strategy

strategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"

Task worker choice strategy.

+

Optional Readonly taskFunction

taskFunction?: string

Task function serialized to string.

+

Optional Readonly taskFunctionOperation

taskFunctionOperation?: "add" | "default" | "remove"

Task function operation:

  • 'add' - Add a task function.
  • 'remove' - Remove a task function.
  • 'default' - Set a task function as default.
-

Optional Readonly taskFunctionOperationStatus

taskFunctionOperationStatus?: boolean

Whether the task function operation is successful or not.

-

Optional Readonly taskId

taskId?: string

Task UUID.

-

Optional Readonly taskPerformance

taskPerformance?: TaskPerformance

Task performance.

-

Optional Readonly timestamp

timestamp?: number

Timestamp.

-

Optional Readonly transferList

transferList?: TransferListItem[]

Array of transferable objects.

-

Optional Readonly workerError

workerError?: WorkerError<ErrorData>

Worker error.

-

Optional Readonly workerId

workerId?: number

Worker id.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Optional Readonly taskFunctionOperationStatus

taskFunctionOperationStatus?: boolean

Whether the task function operation is successful or not.

+

Optional Readonly taskFunctionProperties

taskFunctionProperties?: TaskFunctionProperties

Task function properties.

+

Optional Readonly taskFunctionsProperties

taskFunctionsProperties?: TaskFunctionProperties[]

Task functions properties.

+

Optional Readonly taskId

taskId?: `${string}-${string}-${string}-${string}-${string}`

Task UUID.

+

Optional Readonly taskPerformance

taskPerformance?: TaskPerformance

Task performance.

+

Optional Readonly timestamp

timestamp?: number

Timestamp.

+

Optional Readonly transferList

transferList?: readonly TransferListItem[]

Array of transferable objects.

+

Optional Readonly workerError

workerError?: WorkerError<ErrorData>

Worker error.

+

Optional Readonly workerId

workerId?: number

Worker id.

+

Settings

Member Visibility

Theme

On This Page

checkActivedatakillnameportpriorityreadystatisticsstrategytaskFunctiontaskFunctionOperationtaskFunctionOperationStatustaskFunctionPropertiestaskFunctionsPropertiestaskIdtaskPerformancetimestamptransferListworkerErrorworkerId
\ No newline at end of file