org.voltcore.network.QueueMonitor Maven / Gradle / Ivy
/* 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.network;
/**
* An interface for a stream to report how many bytes it has queued or dequed. Supply a negative number of bytes
* if necessary
*/
public interface QueueMonitor {
/**
* Indicates whether the write stream should signal backpressure
* @param bytes
* @return True if the write stream should signal backpressure and false otherwise.
*/
public boolean queue(int bytes);
}