net.grinder.communication.Receiver Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of grinder-core Show documentation

The Grinder.

The newest version!

// Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005 Philip Aston
// All rights reserved.
//
// This file is part of The Grinder software distribution. Refer to
// the file LICENSE which is part of The Grinder distribution for
// licensing details. The Grinder distribution is available on the
// Internet at http://grinder.sourceforge.net/
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
// FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
// COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
// HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
// OF THE POSSIBILITY OF SUCH DAMAGE.

package net.grinder.communication;


/**
 * Interface for classes that manage the receipt of  messages.
 *
 * @author Philip Aston
 */
public interface Receiver {
  /**
   * Block until a message is available, or another thread has
   * called {@link #shutdown}. Typically called from a message
   * dispatch loop.
   *
   * Multiple threads can call this method, but only one thread
   * will receive a given message.
   *
   * @return The message or null if shut down.
   * @throws CommunicationException If an IO exception occurs
   * reading the message.
   */
  Message waitForMessage() throws CommunicationException;

  /**
   * Shut down this receiver.
   */
  void shutdown();
}