Module com.erudika.para.core
Package com.erudika.para.core.queue

Interface Queue

All Known Implementing Classes:
MockQueue
public interface Queue
The core queue interface. Pushes messages to a queue and pulls them for processing.
Author:
Alex Bogdanovski [[email protected]]

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    Returns the name of the queue.
    String
    pull()
    Pulls one or more messages from a queue.
    void
    push(String task)
    Pushes a message to a queue.
    void
    setName(String name)
    Sets the name of the queue.
    void
    startPolling()
    Start a new async task which polls the queue and automatically processes the messages.
    void
    stopPolling()
    Stops the polling async task manually.

  • Method Details

    • pull

      String pull()
      Pulls one or more messages from a queue.
      Returns:
      the message

    • push

      void push(String task)
      Pushes a message to a queue.
      Parameters:
      task - the message

    • getName

      String getName()
      Returns the name of the queue.
      Returns:
      the queue name

    • setName

      void setName(String name)
      Sets the name of the queue.
      Parameters:
      name - a name

    • startPolling

      void startPolling()
      Start a new async task which polls the queue and automatically processes the messages. This was inspired by Elasticsearch rivers.

    • stopPolling

      void stopPolling()
      Stops the polling async task manually. This method should always be called on shutdown.