Show / Hide Table of Contents

# Class ActiveMQMessage

##### Inheritance

System.Object
BaseDataStructure
BaseCommand
Message
ActiveMQMessage
ActiveMQBlobMessage
ActiveMQBytesMessage
ActiveMQMapMessage
ActiveMQObjectMessage
ActiveMQStreamMessage
ActiveMQTextMessage

##### Implements

Command
DataStructure
MessageReference
System.ICloneable
Apache.NMS.IMessage
MarshallAware

##### Inherited Members

Message.ID_MESSAGE
Message.DEFAULT_MINIMUM_MESSAGE_SIZE
Message.ToString()
Message.Size()
Message.OnSend()
Message.OnMessageRollback()
Message.IsExpired()
Message.ProducerId
Message.Destination
Message.TransactionId
Message.OriginalDestination
Message.MessageId
Message.OriginalTransactionId
Message.GroupID
Message.GroupSequence
Message.CorrelationId
Message.Persistent
Message.Expiration
Message.Priority
Message.ReplyTo
Message.Timestamp
Message.Type
Message.Content
Message.MarshalledProperties
Message.DataStructure
Message.TargetConsumerId
Message.Compressed
Message.RedeliveryCounter
Message.BrokerPath
Message.Arrival
Message.UserID
Message.RecievedByDFBridge
Message.Droppable
Message.Cluster
Message.BrokerInTime
Message.BrokerOutTime
Message.JMSXGroupFirstForConsumer
Message.ReadOnlyBody
Message.IsMessage
BaseCommand.CommandId
BaseCommand.GetDataStructureTypeAsString(Int32)
BaseCommand.IsBrokerInfo
BaseCommand.IsConnectionControl
BaseCommand.IsConnectionInfo
BaseCommand.IsConnectionError
BaseCommand.IsConsumerControl
BaseCommand.IsConsumerInfo
BaseCommand.IsControlCommand
BaseCommand.IsDestinationInfo
BaseCommand.IsFlushCommand
BaseCommand.IsKeepAliveInfo
BaseCommand.IsMessageAck
BaseCommand.IsMessageDispatch
BaseCommand.IsMessageDispatchNotification
BaseCommand.IsMessagePull
BaseCommand.IsProducerAck
BaseCommand.IsProducerInfo
BaseCommand.IsRemoveInfo
BaseCommand.IsRemoveSubscriptionInfo
BaseCommand.IsReplayCommand
BaseCommand.IsResponse
BaseCommand.IsSessionInfo
BaseCommand.IsShutdownInfo
BaseCommand.IsTransactionInfo
BaseCommand.IsWireFormatInfo
BaseCommand.ResponseRequired
BaseDataStructure.AfterMarshall(OpenWireFormat)
BaseDataStructure.BeforeUnmarshall(OpenWireFormat)
BaseDataStructure.AfterUnmarshall(OpenWireFormat)
BaseDataStructure.SetMarshalledForm(OpenWireFormat, Byte[])
BaseDataStructure.GetMarshalledForm(OpenWireFormat)
BaseDataStructure.HashCode(Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)

###### Namespace: Apache.NMS.ActiveMQ.Commands

###### Assembly: Apache.NMS.ActiveMQ.dll

##### Syntax

    public class ActiveMQMessage : Message, Command, DataStructure, MessageReference, ICloneable, IMessage, MarshallAware

### Constructors

| Improve this Doc View Source

#### ActiveMQMessage()

##### Declaration

    public ActiveMQMessage()

### Fields

| Improve this Doc View Source

#### ID_ACTIVEMQMESSAGE

##### Declaration

    public const byte ID_ACTIVEMQMESSAGE = 23

##### Field Value

Type | Description
--- | ---
System.Byte |

### Properties

| Improve this Doc View Source

#### Connection

##### Declaration

    public Connection Connection { get; set; }

##### Property Value

Type | Description
--- | ---
Connection |

| Improve this Doc View Source

#### FromDestination

##### Declaration

    public IDestination FromDestination { get; set; }

##### Property Value

Type | Description
--- | ---
Apache.NMS.IDestination |

| Improve this Doc View Source

#### NMSCorrelationID

The correlation ID used to correlate messages with conversations or long running business processes

##### Declaration

    public string NMSCorrelationID { get; set; }

##### Property Value

Type | Description
--- | ---
System.String |

| Improve this Doc View Source

#### NMSDeliveryMode

Whether or not this message is persistent

##### Declaration

    public MsgDeliveryMode NMSDeliveryMode { get; set; }

##### Property Value

Type | Description
--- | ---
Apache.NMS.MsgDeliveryMode |

| Improve this Doc View Source

#### NMSDestination

The destination of the message

##### Declaration

    public IDestination NMSDestination { get; set; }

##### Property Value

Type | Description
--- | ---
Apache.NMS.IDestination |

| Improve this Doc View Source

#### NMSMessageId

The message ID which is set by the provider

##### Declaration

    public string NMSMessageId { get; set; }

##### Property Value

Type | Description
--- | ---
System.String |

| Improve this Doc View Source

#### NMSPriority

The Priority on this message

##### Declaration

    public MsgPriority NMSPriority { get; set; }

##### Property Value

Type | Description
--- | ---
Apache.NMS.MsgPriority |

| Improve this Doc View Source

#### NMSRedelivered

Returns true if this message has been redelivered to this or another consumer before being acknowledged successfully.

##### Declaration

    public bool NMSRedelivered { get; set; }

##### Property Value

Type | Description
--- | ---
System.Boolean |

| Improve this Doc View Source

#### NMSReplyTo

The destination that the consumer of this message should send replies to

##### Declaration

    public IDestination NMSReplyTo { get; set; }

##### Property Value

Type | Description
--- | ---
Apache.NMS.IDestination |

| Improve this Doc View Source

#### NMSTimestamp

The timestamp the broker added to the message

##### Declaration

    public DateTime NMSTimestamp { get; set; }

##### Property Value

Type | Description
--- | ---
System.DateTime |

| Improve this Doc View Source

#### NMSTimeToLive

The time in milliseconds that this message should expire in

##### Declaration

    public TimeSpan NMSTimeToLive { get; set; }

##### Property Value

Type | Description
--- | ---
System.TimeSpan |

| Improve this Doc View Source

#### NMSType

The type name of this message

##### Declaration

    public string NMSType { get; set; }

##### Property Value

Type | Description
--- | ---
System.String |

| Improve this Doc View Source

#### NMSXDeliveryCount

Returns the number of times this message has been redelivered to other consumers without being acknowledged successfully.

##### Declaration

    public int NMSXDeliveryCount { get; }

##### Property Value

Type | Description
--- | ---
System.Int32 |

| Improve this Doc View Source

#### NMSXGroupID

The Message Group ID used to group messages together to the same consumer for the same group ID value

##### Declaration

    public string NMSXGroupID { get; set; }

##### Property Value

Type | Description
--- | ---
System.String |

| Improve this Doc View Source

#### NMSXGroupSeq

The Message Group Sequence counter to indicate the position in a group

##### Declaration

    public int NMSXGroupSeq { get; set; }

##### Property Value

Type | Description
--- | ---
System.Int32 |

| Improve this Doc View Source

#### NMSXProducerTXID

Returns the ID of the producers transaction

##### Declaration

    public string NMSXProducerTXID { get; }

##### Property Value

Type | Description
--- | ---
System.String |

| Improve this Doc View Source

#### Properties

##### Declaration

    public IPrimitiveMap Properties { get; }

##### Property Value

Type | Description
--- | ---
Apache.NMS.IPrimitiveMap |

| Improve this Doc View Source

#### ReadOnlyProperties

##### Declaration

    public override bool ReadOnlyProperties { get; set; }

##### Property Value

Type | Description
--- | ---
System.Boolean |

##### Overrides

Message.ReadOnlyProperties

### Methods

| Improve this Doc View Source

#### Acknowledge()

##### Declaration

    public void Acknowledge()

| Improve this Doc View Source

#### BeforeMarshall(OpenWireFormat)

##### Declaration

    public override void BeforeMarshall(OpenWireFormat wireFormat)

##### Parameters

Type | Name | Description
--- | --- | ---
OpenWireFormat | wireFormat |

##### Overrides

BaseDataStructure.BeforeMarshall(OpenWireFormat)
| Improve this Doc View Source

#### ClearBody()

##### Declaration

    public virtual void ClearBody()

| Improve this Doc View Source

#### ClearProperties()

##### Declaration

    public virtual void ClearProperties()

| Improve this Doc View Source

#### Clone()

##### Declaration

    public override object Clone()

##### Returns

Type | Description
--- | ---
System.Object |

##### Overrides

Message.Clone()
| Improve this Doc View Source

#### Equals(ActiveMQMessage)

##### Declaration

    public virtual bool Equals(ActiveMQMessage that)

##### Parameters

Type | Name | Description
--- | --- | ---
ActiveMQMessage | that |

##### Returns

Type | Description
--- | ---
System.Boolean |

| Improve this Doc View Source

#### Equals(Object)

##### Declaration

    public override bool Equals(object that)

##### Parameters

Type | Name | Description
--- | --- | ---
System.Object | that |

##### Returns

Type | Description
--- | ---
System.Boolean |

##### Overrides

BaseCommand.Equals(Object)
| Improve this Doc View Source

#### FailIfReadOnlyBody()

##### Declaration

    protected void FailIfReadOnlyBody()

| Improve this Doc View Source

#### FailIfWriteOnlyBody()

##### Declaration

    protected void FailIfWriteOnlyBody()

| Improve this Doc View Source

#### GetDataStructureType()

##### Declaration

    public override byte GetDataStructureType()

##### Returns

Type | Description
--- | ---
System.Byte |

##### Overrides

Message.GetDataStructureType()
| Improve this Doc View Source

#### GetHashCode()

##### Declaration

    public override int GetHashCode()

##### Returns

Type | Description
--- | ---
System.Int32 |

##### Overrides

BaseCommand.GetHashCode()
| Improve this Doc View Source

#### GetObjectProperty(String)

##### Declaration

    public object GetObjectProperty(string name)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | name |

##### Returns

Type | Description
--- | ---
System.Object |

| Improve this Doc View Source

#### IsMarshallAware()

##### Declaration

    public override bool IsMarshallAware()

##### Returns

Type | Description
--- | ---
System.Boolean |

##### Overrides

BaseDataStructure.IsMarshallAware()
| Improve this Doc View Source

#### SetObjectProperty(String, Object)

##### Declaration

    public void SetObjectProperty(string name, object value)

##### Parameters

Type | Name | Description
--- | --- | ---
System.String | name |
System.Object | value |

| Improve this Doc View Source

#### Transform(IMessage)

##### Declaration

    public static ActiveMQMessage Transform(IMessage message)

##### Parameters

Type | Name | Description
--- | --- | ---
Apache.NMS.IMessage | message |

##### Returns

Type | Description
--- | ---
ActiveMQMessage |

| Improve this Doc View Source

#### Visit(ICommandVisitor)

##### Declaration

    public override Response Visit(ICommandVisitor visitor)

##### Parameters

Type | Name | Description
--- | --- | ---
ICommandVisitor | visitor |

##### Returns

Type | Description
--- | ---
Response |

##### Overrides

Message.Visit(ICommandVisitor)

### Events

| Improve this Doc View Source

#### Acknowledger

##### Declaration

    public event AcknowledgeHandler Acknowledger

##### Event Type

Type | Description
--- | ---
AcknowledgeHandler |

### Implements

Command
DataStructure
MessageReference
System.ICloneable
Apache.NMS.IMessage
MarshallAware