org.objectweb.dream.queue.buffer.BufferMonitoring Maven / Gradle / Ivy

Go to download
/**
 * Dream
 * Copyright (C) 2003-2004 INRIA Rhone-Alpes
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Contact: [email protected]
 *
 * Initial developer(s): Matthieu Leclercq
 * Contributor(s): 
 */

package org.objectweb.dream.queue.buffer;

import org.objectweb.fractal.fraclet.annotation.annotations.Interface;

/**
 * Buffer monitoring interface for buffer implementations. It defines a
 * read only attribute which is the current size of the buffer.
 */
@Interface(name = BufferMonitoring.ITF_NAME)
public interface BufferMonitoring
{
  
  /**
   * The commonly used name to refer to an interface with this signature.
   */
  String ITF_NAME = "buffer-monitoring";

  /**
   * Returns the current size of the queue.
   * 
   * @return the current size of the queue.
   */
  int getCurrentSize();

}