Skip to main content

IOpProcessingController Interface

Exposes fine-grained control over the Container's inbound and outbound op queues

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/test-utils/legacy.

For more information about our API support guarantees, see here.

Signature​

export interface IOpProcessingController

Methods​

Method Alerts Return Type Description
pauseProcessing(containers) Alpha Promise<void> Process all queue activities, to prepare for fine-grained control via processIncoming and processOutgoing
processIncoming(containers) Alpha Promise<void> Process all ops sitting in the inbound queue, leaving the inbound queue paused afterwards
processOutgoing(containers) Alpha Promise<void> Process all ops sitting in the outbound queue, leaving the inbound queue paused afterwards. Also waits for the outbound ops to arrive in the inbound queue.
resumeProcessing(containers) Alpha void Resume all queue activities for normal operation of the container

Method Details​

pauseProcessing​

Process all queue activities, to prepare for fine-grained control via processIncoming and processOutgoing

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

pauseProcessing(...containers: IContainer[]): Promise<void>;

Parameters​

Parameter Type Description
containers IContainer[] optional subset of all open containers

Returns​

Return type: Promise<void>

processIncoming​

Process all ops sitting in the inbound queue, leaving the inbound queue paused afterwards

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

processIncoming(...containers: IContainer[]): Promise<void>;

Parameters​

Parameter Type Description
containers IContainer[] optional subset of all open containers

Returns​

Return type: Promise<void>

processOutgoing​

Process all ops sitting in the outbound queue, leaving the inbound queue paused afterwards. Also waits for the outbound ops to arrive in the inbound queue.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

processOutgoing(...containers: IContainer[]): Promise<void>;

Parameters​

Parameter Type Description
containers IContainer[] optional subset of all open containers

Returns​

Return type: Promise<void>

resumeProcessing​

Resume all queue activities for normal operation of the container

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature​

resumeProcessing(...containers: IContainer[]): void;

Parameters​

Parameter Type Description
containers IContainer[] optional subset of all open containers