org.opendaylight.mdsal.common.api

Interface PostPreCommitStep

All Superinterfaces:

ThreePhaseCommitStep

@Beta
public interface PostPreCommitStep
extends ThreePhaseCommitStep

User implementation of steps following pre-commit from Three-Phase Protocol.

Field Summary

Fields

Modifier and Type	Field and Description
static PostPreCommitStep	NOOP No-op implementation of ThreePhaseCommitStep.abort() and commit() method, which always success calls.
static @NonNull ListenableFuture<?>	NOOP_COMMIT_FUTURE
static @NonNull ListenableFuture<? extends PostPreCommitStep>	NOOP_FUTURE

Fields inherited from interface org.opendaylight.mdsal.common.api.ThreePhaseCommitStep

NOOP_ABORT_FUTURE

Method Summary

Modifier and Type	Method and Description
@NonNull ListenableFuture<?>	commit() Commits cohort transaction.

Methods inherited from interface org.opendaylight.mdsal.common.api.ThreePhaseCommitStep

abort

Field Detail

NOOP

static final PostPreCommitStep NOOP

No-op implementation of ThreePhaseCommitStep.abort() and commit() method, which always success calls. This implementation is intended for users which may not need to implement commit and abort method.

NOOP_COMMIT_FUTURE

static final @NonNull ListenableFuture<?> NOOP_COMMIT_FUTURE

NOOP_FUTURE

static final @NonNull ListenableFuture<? extends PostPreCommitStep> NOOP_FUTURE

Method Detail

commit

@NonNull ListenableFuture<?> commit()

Commits cohort transaction. This callback is invoked by three-phase commit coordinator if associated data transaction finished pre-commit phase and will be commited. Implementation should make state, which were derived by implementation from associated data visible.

Returns:

Listenable Future which will complete once commit is finished.