org.opendaylight.controller.cluster.access.commands.SkipTransactionsRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of controller-docs Show documentation
Controller documentation
There is a newer version: 10.0.4
/*
 * Copyright (c) 2021 PANTHEON.tech, s.r.o. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.controller.cluster.access.commands;

import akka.actor.ActorRef;
import com.google.common.base.MoreObjects.ToStringHelper;
import com.google.common.collect.ImmutableList;
import com.google.common.primitives.UnsignedLong;
import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectOutput;
import java.util.Collection;
import java.util.List;
import org.eclipse.jdt.annotation.NonNull;
import org.opendaylight.controller.cluster.access.ABIVersion;
import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
import org.opendaylight.yangtools.concepts.WritableObjects;

/**
 * Request to skip a number of {@link TransactionIdentifier}s within a {code local history}. This request is essentially
 * equivalent to {@link TransactionPurgeRequest} for {@link #getTarget()}, but also carries additional sibling
 * {@link TransactionIdentifier}s in {@link #getOthers()}.
 *
 * 
 * This request is sent by the frontend to inform the backend that a set of {@link TransactionIdentifier}s are
 * explicitly retired and are guaranteed to never be used by the frontend.
 */
public final class SkipTransactionsRequest extends TransactionRequest {
    interface SerialForm extends TransactionRequest.SerialForm {
        @Override
        default SkipTransactionsRequest readExternal(final ObjectInput in, final TransactionIdentifier target,
                final long sequence, final ActorRef replyTo) throws IOException {
            final int size = in.readInt();
            final var builder = ImmutableList.builderWithExpectedSize(size);
            int idx;
            if (size % 2 != 0) {
                builder.add(UnsignedLong.fromLongBits(WritableObjects.readLong(in)));
                idx = 1;
            } else {
                idx = 0;
            }
            for (; idx < size; idx += 2) {
                final byte hdr = WritableObjects.readLongHeader(in);
                builder.add(UnsignedLong.fromLongBits(WritableObjects.readFirstLong(in, hdr)));
                builder.add(UnsignedLong.fromLongBits(WritableObjects.readSecondLong(in, hdr)));
            }

            return new SkipTransactionsRequest(target, sequence, replyTo, builder.build());
        }

        @Override
        default void writeExternal(final ObjectOutput out, final SkipTransactionsRequest msg) throws IOException {
            TransactionRequest.SerialForm.super.writeExternal(out, msg);

            final var others = msg.others;
            final int size = others.size();
            out.writeInt(size);

            int idx;
            if (size % 2 != 0) {
                WritableObjects.writeLong(out, others.get(0).longValue());
                idx = 1;
            } else {
                idx = 0;
            }
            for (; idx < size; idx += 2) {
                WritableObjects.writeLongs(out, others.get(idx).longValue(), others.get(idx + 1).longValue());
            }
        }
    }

    @java.io.Serial
    private static final long serialVersionUID = 1L;

    // Note: UnsignedLong is arbitrary, yang.common.Uint64 would work just as well, we really want an immutable
    //       List, though.
    private final @NonNull ImmutableList others;

    public SkipTransactionsRequest(final TransactionIdentifier target, final long sequence,
            final ActorRef replyTo, final Collection others) {
        super(target, sequence, replyTo);
        this.others = ImmutableList.copyOf(others);
    }

    private SkipTransactionsRequest(final SkipTransactionsRequest request, final ABIVersion version) {
        super(request, version);
        others = request.others;
    }

    /**
     * Return this {@link #getTarget()}s sibling {@link TransactionIdentifier}s.
     *
     * @return Siblings values of {@link TransactionIdentifier#getTransactionId()}
     */
    public List getOthers() {
        return others;
    }

    @Override
    protected SerialForm externalizableProxy(final ABIVersion version) {
        return new STR(this);
    }

    @Override
    protected SkipTransactionsRequest cloneAsVersion(final ABIVersion version) {
        return new SkipTransactionsRequest(this, version);
    }

    @Override
    protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
        final var helper = super.addToStringAttributes(toStringHelper);
        if (!others.isEmpty()) {
            helper.add("others", others);
        }
        return helper;
    }
}