Show / Hide Table of Contents

    Class MessageConsumer

    An object capable of receiving messages from some destination

    Inheritance
    System.Object
    MessageConsumer
    NetTxMessageConsumer
    QueueBrowser.BrowsingMessageConsumer
    Implements
    Apache.NMS.IMessageConsumer
    System.IDisposable
    IDispatcher
    Inherited Members
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: Apache.NMS.ActiveMQ
    Assembly: Apache.NMS.ActiveMQ.dll
    Syntax
    public class MessageConsumer : IMessageConsumer, IDisposable, IDispatcher

    Fields

    | Improve this Doc View Source

    disposed

    Declaration
    protected bool disposed
    Field Value
    Type Description
    System.Boolean

    Properties

    | Improve this Doc View Source

    ConsumerId

    Declaration
    public ConsumerId ConsumerId { get; }
    Property Value
    Type Description
    ConsumerId
    | Improve this Doc View Source

    ConsumerInfo

    Declaration
    public ConsumerInfo ConsumerInfo { get; }
    Property Value
    Type Description
    ConsumerInfo
    | Improve this Doc View Source

    ConsumerTransformer

    A Delegate that is called each time a Message is dispatched to allow the client to do any necessary transformations on the received message before it is delivered.

    Declaration
    public ConsumerTransformerDelegate ConsumerTransformer { get; set; }
    Property Value
    Type Description
    Apache.NMS.ConsumerTransformerDelegate
    | Improve this Doc View Source

    FailoverRedeliveryWaitPeriod

    Declaration
    public long FailoverRedeliveryWaitPeriod { get; set; }
    Property Value
    Type Description
    System.Int64
    | Improve this Doc View Source

    FailureError

    Declaration
    public Exception FailureError { get; set; }
    Property Value
    Type Description
    System.Exception
    | Improve this Doc View Source

    IgnoreExpiration

    Declaration
    public bool IgnoreExpiration { get; set; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    IsAutoAcknowledgeBatch

    Declaration
    protected bool IsAutoAcknowledgeBatch { get; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    IsAutoAcknowledgeEach

    Declaration
    protected bool IsAutoAcknowledgeEach { get; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    IsClientAcknowledge

    Declaration
    protected bool IsClientAcknowledge { get; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    IsIndividualAcknowledge

    Declaration
    protected bool IsIndividualAcknowledge { get; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    LastDeliveredSequenceId

    Declaration
    public long LastDeliveredSequenceId { get; }
    Property Value
    Type Description
    System.Int64
    | Improve this Doc View Source

    NonBlockingRedelivery

    Declaration
    public bool NonBlockingRedelivery { get; set; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    OptimizeAcknowledge

    Declaration
    public bool OptimizeAcknowledge { get; set; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    OptimizeAcknowledgeTimeOut

    Declaration
    public long OptimizeAcknowledgeTimeOut { get; set; }
    Property Value
    Type Description
    System.Int64
    | Improve this Doc View Source

    OptimizedAckScheduledAckInterval

    Declaration
    public long OptimizedAckScheduledAckInterval { get; set; }
    Property Value
    Type Description
    System.Int64
    | Improve this Doc View Source

    PrefetchSize

    Declaration
    public int PrefetchSize { get; }
    Property Value
    Type Description
    System.Int32
    | Improve this Doc View Source

    RedeliveryPolicy

    Declaration
    public IRedeliveryPolicy RedeliveryPolicy { get; set; }
    Property Value
    Type Description
    Apache.NMS.IRedeliveryPolicy
    | Improve this Doc View Source

    RedeliveryTimeout

    Declaration
    public int RedeliveryTimeout { get; set; }
    Property Value
    Type Description
    System.Int32
    | Improve this Doc View Source

    TransactedIndividualAck

    Declaration
    public bool TransactedIndividualAck { get; set; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    UnconsumedMessageCount

    Declaration
    public long UnconsumedMessageCount { get; }
    Property Value
    Type Description
    System.Int64

    Methods

    | Improve this Doc View Source

    AfterMessageIsConsumed(MessageDispatch, Boolean)

    Declaration
    public virtual void AfterMessageIsConsumed(MessageDispatch dispatch, bool expired)
    Parameters
    Type Name Description
    MessageDispatch dispatch
    System.Boolean expired
    | Improve this Doc View Source

    BeforeMessageIsConsumed(MessageDispatch)

    Declaration
    public virtual void BeforeMessageIsConsumed(MessageDispatch dispatch)
    Parameters
    Type Name Description
    MessageDispatch dispatch
    | Improve this Doc View Source

    Close()

    Declaration
    public virtual void Close()
    | Improve this Doc View Source

    DeliverAcks()

    Declaration
    public void DeliverAcks()
    | Improve this Doc View Source

    Dispatch(MessageDispatch)

    Declaration
    public virtual void Dispatch(MessageDispatch dispatch)
    Parameters
    Type Name Description
    MessageDispatch dispatch
    | Improve this Doc View Source

    Dispose()

    Declaration
    public void Dispose()
    | Improve this Doc View Source

    Dispose(Boolean)

    Declaration
    protected void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing
    | Improve this Doc View Source

    DoClientAcknowledge(ActiveMQMessage)

    Declaration
    protected void DoClientAcknowledge(ActiveMQMessage message)
    Parameters
    Type Name Description
    ActiveMQMessage message
    | Improve this Doc View Source

    DoIndividualAcknowledge(ActiveMQMessage)

    Declaration
    protected void DoIndividualAcknowledge(ActiveMQMessage message)
    Parameters
    Type Name Description
    ActiveMQMessage message
    | Improve this Doc View Source

    DoNothingAcknowledge(ActiveMQMessage)

    Declaration
    protected void DoNothingAcknowledge(ActiveMQMessage message)
    Parameters
    Type Name Description
    ActiveMQMessage message
    | Improve this Doc View Source

    Finalize()

    Declaration
    protected void Finalize()
    | Improve this Doc View Source

    Iterate()

    Declaration
    public bool Iterate()
    Returns
    Type Description
    System.Boolean
    | Improve this Doc View Source

    Receive()

    Declaration
    public IMessage Receive()
    Returns
    Type Description
    Apache.NMS.IMessage
    | Improve this Doc View Source

    Receive(TimeSpan)

    Declaration
    public IMessage Receive(TimeSpan timeout)
    Parameters
    Type Name Description
    System.TimeSpan timeout
    Returns
    Type Description
    Apache.NMS.IMessage
    | Improve this Doc View Source

    ReceiveNoWait()

    Declaration
    public IMessage ReceiveNoWait()
    Returns
    Type Description
    Apache.NMS.IMessage
    | Improve this Doc View Source

    SendPullRequest(Int64)

    Declaration
    protected void SendPullRequest(long timeout)
    Parameters
    Type Name Description
    System.Int64 timeout
    | Improve this Doc View Source

    Start()

    Declaration
    public void Start()
    | Improve this Doc View Source

    Stop()

    Declaration
    public void Stop()

    Events

    | Improve this Doc View Source

    Listener

    Declaration
    public event MessageListener Listener
    Event Type
    Type Description
    Apache.NMS.MessageListener

    Implements

    Apache.NMS.IMessageConsumer
    System.IDisposable
    IDispatcher
    • Improve this Doc
    • View Source
    Back to top Copyright � 2005-2019 Apache Software Foundation project
    Generated by DocFX