oracle.kv.ThroughputLimitException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of oracle-nosql-server Show documentation
NoSQL Database Server - supplies build and runtime support for the server (store) side of the Oracle NoSQL Database.
There is a newer version: 18.3.10
/*-
 * Copyright (C) 2011, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This file was distributed by Oracle as part of a version of Oracle NoSQL
 * Database made available at:
 *
 * http://www.oracle.com/technetwork/database/database-technologies/nosqldb/downloads/index.html
 *
 * Please see the LICENSE file included in the top-level directory of the
 * appropriate version of Oracle NoSQL Database for a copy of the license and
 * additional information.
 */

package oracle.kv;

import static oracle.kv.impl.util.SerializationUtil.readPackedInt;
import static oracle.kv.impl.util.SerializationUtil.writePackedInt;

import java.io.DataInput;
import java.io.DataOutput;
import java.io.IOException;

import oracle.kv.impl.util.SerializationUtil;

/**
 * Thrown when read or write operations cannot be completed because a
 * throughput rate limit has been exceeded. The exception may be due to
 * limits on read or write throughout, or both. If the throughput was associated
 * with a table the table name returned by getTableName will be non-null.
 * 
 * @hiddensee {@link #writeFastExternal FastExternalizable format}
 */
public class ThroughputLimitException extends ResourceLimitException {

    private static final long serialVersionUID = 1L;

    private final int readRate;
    private final int readRateLimit;
    private final int writeRate;
    private final int writeRateLimit;

    /**
     * Constructs an instance of ThroughputLimitException with
     * the specified detail message. The read/write rates and limits may be 0.
     *
     * @param tableName the table name
     * @param readRate read rate
     * @param readRateLimit read rate limit
     * @param writeRate write rate
     * @param writeRateLimit write rate limit
     * @param msg the detail message
     * 
     * @hidden For internal use only
     */
    public ThroughputLimitException(String tableName,
                                    int readRate,
                                    int readRateLimit,
                                    int writeRate,
                                    int writeRateLimit,
                                    String msg) {
        super(tableName, msg);
        assert (readRate > 0) || (writeRate > 0);
        this.readRate = readRate;
        this.readRateLimit = readRateLimit;
        this.writeRate = writeRate;
        this.writeRateLimit = writeRateLimit;
    }

    /**
     * Creates an instance from the input stream.
     *
     * @hidden For internal use only
     */
    public ThroughputLimitException(DataInput in, short serialVersion)
        throws IOException {

        super(in, serialVersion);
        readRate = readPackedInt(in);
        readRateLimit = readPackedInt(in);
        writeRate = readPackedInt(in);
        writeRateLimit = readPackedInt(in);
    }

    /**
     * Gets the read rate at the time of the exception. The returned
     * value will be 0 if this exception was due to a write rate overage.
     *
     * @return the read rate or 0
     * 
     * @hidden For internal use only
     */
    public int getReadRate() {
        return readRate;
    }

    /**
     * Gets the read rate limit at the time of the exception.  The returned
     * value will be 0 if this exception was due to a write rate overage.
     *
     * @return the read rate limit or 0
     * 
     * @hidden For internal use only
     */
    public int getReadRateLimit() {
        return readRateLimit;
    }

    /**
     * Gets the write rate at the time of the exception. The returned
     * value will be 0 if this exception was due to a read rate overage.
     *
     * @return the write rate or 0
     * 
     * @hidden For internal use only
     */
    public int getWriteRate() {
        return writeRate;
    }

    /**
     * Gets the write rate limit at the time of the exception. The returned
     * value will be 0 if this exception was due to a read rate overage.
     *
     * @return the write rate limit or 0
     * 
     * @hidden For internal use only
     */
    public int getWriteRateLimit() {
        return writeRateLimit;
    }

    /**
     * Writes the fields of this object to the output stream.  Format:
     * 
     *  ({@link ResourceLimitException}) {@code super}
     * 
 ({@link SerializationUtil#writePackedInt packedInt})
     *      {@link #getReadRate readRate}
     * 
 ({@link SerializationUtil#writePackedInt packedInt})
     *      {@link #getReadRateLimit readRateLimit}
     * 
 ({@link SerializationUtil#writePackedInt packedInt})
     *      {@link #getWriteRate writeRate}
     * 
 ({@link SerializationUtil#writePackedInt packedInt})
     *      {@link #getWriteRateLimit writeRateLimit}
     * 
     *
     * @hidden For internal use only
     */
    @Override
    public void writeFastExternal(DataOutput out, short serialVersion)
        throws IOException {
        super.writeFastExternal(out, serialVersion);
        writePackedInt(out, readRate);
        writePackedInt(out, readRateLimit);
        writePackedInt(out, writeRate);
        writePackedInt(out, writeRateLimit);
    }
}