Show / Hide Table of Contents

    Interface IQueueBrowser

    A client uses a QueueBrowser object to look at messages on a queue without removing them.

    The Enumeration method returns a java.util.Enumeration that is used to scan the queue's messages. It may be an enumeration of the entire content of a queue, or it may contain only the messages matching a message selector.

    Messages may be arriving and expiring while the scan is done. The NMS API does not require the content of an enumeration to be a static snapshot of queue content. Whether these changes are visible or not depends on the NMS provider.

    Inherited Members
    System.Collections.IEnumerable.GetEnumerator()
    System.IDisposable.Dispose()
    Namespace: Apache.NMS
    Assembly: Apache.NMS.dll
    Syntax
    public interface IQueueBrowser : IEnumerable, IDisposable

    Properties

    | Improve this Doc View Source

    MessageSelector

    Declaration
    string MessageSelector { get; }
    Property Value
    Type Description
    System.String

    Gets this queue browser's message selector expression. If no Message selector was specified than this method returns null.

    Exceptions
    Type Condition
    NMSException

    If NMS Provider fails to get the Message Selector for some reason.

    | Improve this Doc View Source

    Queue

    Declaration
    IQueue Queue { get; }
    Property Value
    Type Description
    IQueue

    Gets the queue associated with this queue browser.

    Exceptions
    Type Condition
    NMSException

    If NMS Provider fails to retrieve the IQueue associated with the Browser doe to some internal error.

    Methods

    | Improve this Doc View Source

    Close()

    Closes the QueueBrowser.

    Declaration
    void Close()
    Exceptions
    Type Condition
    NMSException

    If NMS Provider fails to close the Browser for some reason.

    • Improve this Doc
    • View Source
    Back to top Copyright © 2005-2023 Apache Software Foundation project
    Generated by DocFX