org.voltcore.messaging.HeartbeatMessage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of voltdb Show documentation
VoltDB server libraries
There is a newer version: 10.1.1
/* This file is part of VoltDB.
 * Copyright (C) 2008-2020 VoltDB Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with VoltDB.  If not, see .
 */

package org.voltcore.messaging;

import java.io.IOException;
import java.nio.ByteBuffer;

import org.voltcore.utils.CoreUtils;

public class HeartbeatMessage extends TransactionInfoBaseMessage {

    long m_lastSafeTxnId; // this is the largest txn acked by all partitions running the java for it

    HeartbeatMessage() {
        super();
    }

    public HeartbeatMessage(long initiatorHSId, long txnId, long lastSafeTxnId) {
        super(initiatorHSId, -1, txnId, txnId, true, false);
        m_lastSafeTxnId = lastSafeTxnId;
    }

    public long getLastSafeTxnId() {
        return m_lastSafeTxnId;
    }

    @Override
    public int getSerializedSize() {
        int msgsize = super.getSerializedSize() +  8;
        return msgsize;
    }

    @Override
    public void flattenToBuffer(ByteBuffer buf) throws IOException {
        buf.put(VoltMessageFactory.HEARTBEAT_ID);
        super.flattenToBuffer(buf);

        buf.putLong(m_lastSafeTxnId);

        assert(buf.capacity() == buf.position());
        buf.limit(buf.position());
    }

    @Override
    public void initFromBuffer(ByteBuffer buf) throws IOException {
        super.initFromBuffer(buf);

        m_lastSafeTxnId = buf.getLong();

        assert(buf.capacity() == buf.position());
    }

    @Override
    public void toDuplicateCounterString(StringBuilder sb) {
        sb.append("UNEXPECTED HEARTBEAT");
    }

    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();

        sb.append("HEARTBEAT (FROM ");
        sb.append(CoreUtils.hsIdToString(m_sourceHSId));
        sb.append(") FOR TXN ");
        sb.append(m_txnId);
        sb.append(" and LAST SAFE ");
        sb.append(m_lastSafeTxnId);

        return sb.toString();
    }
}