SALES: 1-800-867-1380

BrokeredMessage Class

 

Represents the unit of communication between AppFabric ServiceBus clients.

Namespace:   Microsoft.ServiceBus.Messaging
Assembly:  Microsoft.ServiceBus (in Microsoft.ServiceBus.dll)

System.Object
  Microsoft.ServiceBus.Messaging.BrokeredMessage

Public NotInheritable Class BrokeredMessage
	Implements IXmlSerializable, IDisposable

NameDescription
System_CAPS_pubmethodBrokeredMessage()

Initializes a new instance of the BrokeredMessage class.

System_CAPS_pubmethodBrokeredMessage(Object)

Initializes a new instance of the BrokeredMessage class from a given object by using DataContractSerializer with a binary XmlDictionaryWriter.

System_CAPS_pubmethodBrokeredMessage(Object, XmlObjectSerializer)

Initializes a new instance of the BrokeredMessage class from a given object using the provided XmlObjectSerializer.

System_CAPS_pubmethodBrokeredMessage(Stream)

Initializes a new instance of the BrokeredMessage class.

System_CAPS_pubmethodBrokeredMessage(Stream, Boolean)

Initializes a new instance of the BrokeredMessage class using the supplied stream as its body.

NameDescription
System_CAPS_pubpropertyContentType

Gets or sets the type of the content.

System_CAPS_pubpropertyCorrelationId

Gets or sets the identifier of the correlation.

System_CAPS_pubpropertyDeliveryCount

Gets the number of deliveries.

System_CAPS_pubpropertyEnqueuedSequenceNumber

Gets or sets the enqueued sequence number of the message.

System_CAPS_pubpropertyEnqueuedTimeUtc

Gets or sets the date and time of the sent time in UTC.

System_CAPS_pubpropertyExpiresAtUtc

Gets the date and time in UTC at which the message is set to expire.

System_CAPS_pubpropertyForcePersistence

Gets or sets a value that indicates whether the message is to be persisted to the database immediately, instead of being held in memory for a short time. This property is ignored if the message is sent to a non-express queue or topic.

System_CAPS_pubpropertyIsBodyConsumed

Specifies whether the message has been consumed.

System_CAPS_pubpropertyLabel

Gets or sets the application specific label.

System_CAPS_pubpropertyLockedUntilUtc

Gets the date and time in UTC until which the message will be locked in the queue/subscription.

System_CAPS_pubpropertyLockToken

Gets the lock token assigned by Service Bus to this message.

System_CAPS_pubpropertyMessageId

Gets or sets the identifier of the message.

System_CAPS_pubpropertyPartitionKey

Gets or sets a partition key for sending a transactional message to a queue or topic that is not session-aware.

System_CAPS_pubpropertyProperties

Gets the application specific message properties.

System_CAPS_pubpropertyReplyTo

Gets or sets the address of the queue to reply to.

System_CAPS_pubpropertyReplyToSessionId

Gets or sets the session identifier to reply to.

System_CAPS_pubpropertyScheduledEnqueueTimeUtc

Gets or sets the date and time in UTC at which the message will be enqueued. This property returns the time in UTC; when setting the property, the supplied DateTime value must also be in UTC.

System_CAPS_pubpropertySequenceNumber

Gets the unique number assigned to a message by the Service Bus.

System_CAPS_pubpropertySessionId

Gets or sets the identifier of the session.

System_CAPS_pubpropertySize

Gets the size of the message in bytes.

System_CAPS_pubpropertyState

Gets or sets the state of the message.

System_CAPS_pubpropertyTimeToLive

Gets or sets the message’s time to live value. This is the duration after which the message expires, starting from when the message is sent to the Service Bus.

Messages older than their TimeToLive value will expire and no longer be retained in the message store. Subscribers will be unable to receive expired messages.

TimeToLive is the maximum lifetime that a message can receive, but its value cannot exceed the entity specified the DefaultMessageTimeToLive value on the destination queue or subscription. If a lower TimeToLive value is specified, it will be applied to the individual message. However, a larger value specified on the message will be overridden by the entity’s DefaultMessageTimeToLive value.

System_CAPS_pubpropertyTo

Gets or sets the send to address.

System_CAPS_pubpropertyViaPartitionKey

Gets or sets a partition key value when a transaction is to be used to send messages via a transfer queue.

NameDescription
System_CAPS_pubmethodAbandon()

Abandons the lock on a peek-locked message.

System_CAPS_pubmethodAbandon(IDictionary(Of String, Object))

Abandons the lock on a peek-locked message.

System_CAPS_pubmethodAbandonAsync()

Asynchronously abandons the lock on a peek-locked message.

System_CAPS_pubmethodAbandonAsync(IDictionary(Of String, Object))

Asynchronously abandons the lock on a peek-locked message.

System_CAPS_pubmethodBeginAbandon(AsyncCallback, Object)

Begins an asynchronous operation to abandon the lock on a peek-locked message.

System_CAPS_pubmethodBeginAbandon(IDictionary(Of String, Object), AsyncCallback, Object)

Begins an asynchronous operation to abandon the lock on a peek-locked message.

System_CAPS_pubmethodBeginComplete(AsyncCallback, Object)

Begins an asynchronous operation to complete a message.

System_CAPS_pubmethodBeginDeadLetter(AsyncCallback, Object)

Begins an asynchronous operation to move the message to the dead letter queue.

System_CAPS_pubmethodBeginDeadLetter(IDictionary(Of String, Object), AsyncCallback, Object)

Begins an asynchronous operation to move the message to the dead letter queue.

System_CAPS_pubmethodBeginDeadLetter(String, String, AsyncCallback, Object)

Begins an asynchronous operation to move the message to the dead letter queue.

System_CAPS_pubmethodBeginDefer(AsyncCallback, Object)

Begins an asynchronous operation to defer a message.

System_CAPS_pubmethodBeginDefer(IDictionary(Of String, Object), AsyncCallback, Object)

Begins an asynchronous operation to defer a message.

System_CAPS_pubmethodBeginRenewLock(AsyncCallback, Object)

Begins an asynchronous operation to renew lock on a message.

System_CAPS_pubmethodClone()

Clones a message, so that it is possible to send a clone of a message as a new message.

System_CAPS_pubmethodComplete()

Completes the receive operation of a message and indicates that the message should be marked as processed and deleted.

System_CAPS_pubmethodCompleteAsync()

Asynchronously completes the receive operation of a message and indicates that the message should be marked as processed and deleted.

System_CAPS_pubmethodDeadLetter()

Moves the message to the dead letter queue.

System_CAPS_pubmethodDeadLetter(IDictionary(Of String, Object))

Moves the message to the dead letter queue.

System_CAPS_pubmethodDeadLetter(String, String)

Moves the message to the dead letter queue.

System_CAPS_pubmethodDeadLetterAsync()

Asynchronously moves the message to the dead letter queue.

System_CAPS_pubmethodDeadLetterAsync(IDictionary(Of String, Object))

Asynchronously moves the message to the dead letter queue.

System_CAPS_pubmethodDeadLetterAsync(String, String)

Asynchronously moves the message to the dead letter queue.

System_CAPS_pubmethodDefer()

Indicates that the receiver wants to defer the processing for this message.

System_CAPS_pubmethodDefer(IDictionary(Of String, Object))

Indicates that the receiver wants to defer the processing for this message.

System_CAPS_pubmethodDeferAsync()

Asynchronously indicates that the receiver wants to defer the processing for this message.

System_CAPS_pubmethodDeferAsync(IDictionary(Of String, Object))

Asynchronously indicates that the receiver wants to defer the processing for this message.

System_CAPS_pubmethodDispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

System_CAPS_pubmethodEndAbandon(IAsyncResult)

Ends an asynchronous request to abandon the lock on a peek-locked message.

System_CAPS_pubmethodEndComplete(IAsyncResult)

Ends an asynchronous operation to complete a message.

System_CAPS_pubmethodEndDeadLetter(IAsyncResult)

Ends an asynchronous request to move the message to the dead letter queue.

System_CAPS_pubmethodEndDefer(IAsyncResult)

Ends an asynchronous request to defer a message.

System_CAPS_pubmethodEndRenewLock(IAsyncResult)

Ends an asynchronous request to renew lock on a message.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetBody(Of T)()

Deserializes the brokered message body into an object of the specified type by using the DataContractSerializer with a binary XmlDictionaryReader.

System_CAPS_pubmethodGetBody(Of T)(XmlObjectSerializer)

Deserializes the brokered message body into an object of the specified type by using the supplied XmlObjectSerializer.

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodRenewLock()

Renews the lock on a message.

System_CAPS_pubmethodRenewLockAsync()

Asynchronously renews the lock on a message.

System_CAPS_pubmethodToString()

Returns a string that represents the current message.(Overrides Object.ToString().)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIXmlSerializable.GetSchema()

This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the XmlSchemaProviderAttribute to the class.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIXmlSerializable.ReadXml(XmlReader)

Generates an object from its XML representation. This method is reserved for internal use and should not be used directly or indirectly (for example, using a serializer or a formatter).

System_CAPS_pubinterfaceSystem_CAPS_privmethodIXmlSerializable.WriteXml(XmlWriter)

Converts an object into its XML representation. This method is reserved for internal use and should not be used directly or indirectly (e.g. using a serializer or a formatter).

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft