Closes the given barrier.
This operation signals that no more new elements will be inserted in the given barrier. Subsequent InsertMany that try to introduce a new key will fail. Subsequent InsertMany operations that just add missing components to already existing elements will continue to succeed. Subsequent TakeMany operations will continue to succeed if sufficient completed elements remain in the barrier. Subsequent TakeMany operations that would block will fail immediately.
Nested Classes
class | BarrierClose.Options | Optional attributes for BarrierClose
|
Public Methods
static BarrierClose.Options |
cancelPendingEnqueues(Boolean cancelPendingEnqueues)
|
static BarrierClose |
create(Scope scope, Operand<String> handle, Options... options)
Factory method to create a class wrapping a new BarrierClose operation.
|
Inherited Methods
Public Methods
public static BarrierClose.Options cancelPendingEnqueues (Boolean cancelPendingEnqueues)
Parameters
cancelPendingEnqueues | If true, all pending enqueue requests that are blocked on the barrier's queue will be canceled. InsertMany will fail, even if no new key is introduced. |
---|
public static BarrierClose create (Scope scope, Operand<String> handle, Options... options)
Factory method to create a class wrapping a new BarrierClose operation.
Parameters
scope | current scope |
---|---|
handle | The handle to a barrier. |
options | carries optional attributes values |
Returns
- a new instance of BarrierClose