Exportera (0) Skriv ut
Visa allt
EN
Det här innehållet finns inte tillgängligt på ditt språk men här finns den engelska versionen,

MessageSession Class

Represents a message session that allows grouping of related messages for processing in a single transaction.

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

public abstract class MessageSession extends MessageReceiver

The MessageSession type exposes the following members.

  NameDescription
Public propertyBatchFlushIntervalGets the batch flush interval. (Inherited from MessageReceiver.)
Protected propertyBatchingEnabledGets a value indicating whether the batching is enabled. (Inherited from MessageReceiver.)
Public propertyIsClosed (Inherited from ClientEntity.)
Public propertyLastPeekedSequenceNumberGets or sets the last peeked sequence number in the session. (Overrides MessageReceiver.LastPeekedSequenceNumber.)
Public propertyLockedUntilUtcGets or sets the date and time at which the message session is unlocked.
Public propertyModeGets the message receive mode. (Inherited from MessageReceiver.)
Protected propertyOffsetInclusive (Inherited from MessageReceiver.)
Public propertyPathGets the path of the queue or topic, relative to the MessagingFactory base address. (Overrides MessageReceiver.Path.)
Public propertyPrefetchCountGets or sets the number of messages that the message receiver can simultaneously request. (Overrides MessageReceiver.PrefetchCount.)
Protected propertyReceiverStartTimeGets or sets the start time of the receiver. (Inherited from MessageReceiver.)
Public propertyRetryPolicy (Inherited from ClientEntity.)
Public propertySessionIdGets or sets the message session identifier.
Protected propertyStartOffsetGets or sets the starting point of the offset. (Inherited from MessageReceiver.)
Protected propertyThisLock (Inherited from ClientEntity.)
Top

  NameDescription
Public methodAbandon(Guid)Discards the message and relinquishes the message lock ownership. (Inherited from MessageReceiver.)
Public methodAbandon(Guid, IDictionary(String, Object))Discards the message and relinquishes the message lock ownership. (Inherited from MessageReceiver.)
Public methodAbandonAsync(Guid)Asynchronously discards the message and relinquishes the message lock ownership. (Inherited from MessageReceiver.)
Public methodAbandonAsync(Guid, IDictionary(String, Object))Asynchronously discards the message and relinquishes the message lock ownership. (Inherited from MessageReceiver.)
Public methodAbortPerforms abort functionality on the messaging entity. (Inherited from ClientEntity.)
Public methodBeginAbandon(Guid, AsyncCallback, Object)Begins an asynchronous operation to abandon the message and relinquish its lock. (Inherited from MessageReceiver.)
Public methodBeginAbandon(Guid, IDictionary(String, Object), AsyncCallback, Object)Begins an asynchronous operation to abandon the message and relinquish its lock. (Inherited from MessageReceiver.)
Public methodBeginCloseBegins an asynchronous operation to close the message client entity. (Inherited from MessageClientEntity.)
Public methodBeginCompleteBegins an asynchronous operation to complete receipt of a message. (Inherited from MessageReceiver.)
Public methodBeginCompleteBatchBegins an asynchronous operation to complete a message batching. (Inherited from MessageReceiver.)
Public methodBeginDeadLetter(Guid, AsyncCallback, Object)Begins an asynchronous operation to move a message to the dead letter queue. (Inherited from MessageReceiver.)
Public methodBeginDeadLetter(Guid, IDictionary(String, Object), AsyncCallback, Object)Begins an asynchronous operation to move a message to the dead letter queue. (Inherited from MessageReceiver.)
Public methodBeginDeadLetter(Guid, String, String, AsyncCallback, Object)Begins an asynchronous operation to move a message to the dead letter queue. (Inherited from MessageReceiver.)
Public methodBeginDefer(Guid, AsyncCallback, Object)Begins an asynchronous operation to suspend receipt of a message. (Inherited from MessageReceiver.)
Public methodBeginDefer(Guid, IDictionary(String, Object), AsyncCallback, Object)Begins an asynchronous operation to suspend receipt of a message. (Inherited from MessageReceiver.)
Public methodBeginGetStateBegins an asynchronous operation to set the state of the message session.
Public methodBeginPeek(AsyncCallback, Object)Begins an operation to peek a message. (Inherited from MessageReceiver.)
Public methodBeginPeek(Int64, AsyncCallback, Object)Begins an operation to peek a message. (Inherited from MessageReceiver.)
Public methodBeginPeekBatch(Int32, AsyncCallback, Object)Begins an operation to peek a batch of message. (Inherited from MessageReceiver.)
Public methodBeginPeekBatch(Int64, Int32, AsyncCallback, Object)Begins an operation to peek a batch of message. (Inherited from MessageReceiver.)
Public methodBeginReceive(AsyncCallback, Object)Begins an asynchronous operation to receive a message. (Inherited from MessageReceiver.)
Public methodBeginReceive(Int64, AsyncCallback, Object)Begins an asynchronous operation to receive a message. (Inherited from MessageReceiver.)
Public methodBeginReceive(TimeSpan, AsyncCallback, Object)Begins an asynchronous operation to receive a message. (Inherited from MessageReceiver.)
Public methodBeginReceiveBatch(IEnumerable(Int64), AsyncCallback, Object)Begins an asynchronous operation to receive a batch of message. (Inherited from MessageReceiver.)
Public methodBeginReceiveBatch(Int32, AsyncCallback, Object)Begins an asynchronous operation to receive a batch of message. (Inherited from MessageReceiver.)
Public methodBeginReceiveBatch(Int32, TimeSpan, AsyncCallback, Object)Begins an asynchronous operation to receive a batch of message. (Inherited from MessageReceiver.)
Public methodBeginRenewLockStarts the renewal of lock of the message session.
Public methodBeginSetStateBegins an asynchronous operation to set the state of the message session.
Public methodCloseSends a cleanup message to Service Bus to signal the completion of the usage of an entity. (Inherited from ClientEntity.)
Public methodCloseAsyncSends a cleanup message asynchronously to Service Bus to signal the completion of the usage of an entity. (Inherited from ClientEntity.)
Public methodCompleteCompletes the receive operation on a message. (Inherited from MessageReceiver.)
Public methodCompleteAsyncAsynchronously completes the receive operation on a message. (Inherited from MessageReceiver.)
Public methodCompleteBatchCompletes the receive operation on a batch of message. (Inherited from MessageReceiver.)
Public methodCompleteBatchAsyncAsynchronously completes the receive operation on a batch of message. (Inherited from MessageReceiver.)
Public methodDeadLetter(Guid)Moves the undelivered message to the dead letter queue. (Inherited from MessageReceiver.)
Public methodDeadLetter(Guid, IDictionary(String, Object))Moves the undelivered message to the dead letter queue. (Inherited from MessageReceiver.)
Public methodDeadLetter(Guid, String, String)Moves the undelivered message to the dead letter queue. (Inherited from MessageReceiver.)
Public methodDeadLetterAsync(Guid)Asynchronously moves the undelivered message to the dead letter queue. (Inherited from MessageReceiver.)
Public methodDeadLetterAsync(Guid, IDictionary(String, Object))Asynchronously moves the undelivered message to the dead letter queue. (Inherited from MessageReceiver.)
Public methodDeadLetterAsync(Guid, String, String)Asynchronously moves the undelivered message to the dead letter queue. (Inherited from MessageReceiver.)
Public methodDefer(Guid)Indicates that the receiver wants to defer the processing for the message. (Inherited from MessageReceiver.)
Public methodDefer(Guid, IDictionary(String, Object))Indicates that the receiver wants to defer the processing for the message. (Inherited from MessageReceiver.)
Public methodDeferAsync(Guid)Asynchronously defer the processing of the message. (Inherited from MessageReceiver.)
Public methodDeferAsync(Guid, IDictionary(String, Object))Asynchronously defer the processing of the message. (Inherited from MessageReceiver.)
Public methodEndAbandonEnds the asynchronous operation to abandon the message and relinquish its lock. (Inherited from MessageReceiver.)
Public methodEndCloseFinishes an asynchronous operation to close the message client entity. (Inherited from MessageClientEntity.)
Public methodEndCompleteEnds the asynchronous operation to complete receipt of a message. (Inherited from MessageReceiver.)
Public methodEndCompleteBatchEnds the asynchronous operation to complete receipt of a batch message. (Inherited from MessageReceiver.)
Public methodEndDeadLetterEnds an asynchronous operation to move the message to the dead letter queue. (Inherited from MessageReceiver.)
Public methodEndDeferEnds an asynchronous operation to defer receipt of a message. (Inherited from MessageReceiver.)
Public methodEndGetStateEnds an asynchronous operation to get the state of the message session.
Public methodEndPeekEnds an asynchronous operation to peek a message. (Inherited from MessageReceiver.)
Public methodEndPeekBatchEnds an asynchronous operation to peek a batch of message. (Inherited from MessageReceiver.)
Public methodEndReceiveEnds an asynchronous operation to receive a message. (Inherited from MessageReceiver.)
Public methodEndReceiveBatchEnds an asynchronous operation to receive a batch of message. (Inherited from MessageReceiver.)
Public methodEndRenewLockStarts the renewal of lock of the message session.
Public methodEndSetStateEnds an asynchronous operation to set the state of the message session.
Public methodEquals (Inherited from Object.)
Protected methodFaultFor internal use only. Do not inherit from this class. (Inherited from ClientEntity.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetStateGets the state of the message session.
Public methodGetStateAsyncAsynchronously gets the state of the message session.
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodOnAbandonExecutes upon calling the Abandon operation. (Overrides MessageReceiver.OnAbandon(TrackingContext, IEnumerable(Guid), IDictionary(String, Object), TimeSpan).)
Protected methodOnAbortAborts the message session. (Overrides ClientEntity.OnAbort().)
Protected methodOnBeginAbandonExecutes upon calling the OnAbandon or BeginAbandon operation. (Overrides MessageReceiver.OnBeginAbandon(TrackingContext, IEnumerable(Guid), IDictionary(String, Object), Boolean, TimeSpan, AsyncCallback, Object).)
Protected methodOnBeginCloseBegins an asynchronous operation to close the communication object for the message session. (Overrides ClientEntity.OnBeginClose(TimeSpan, AsyncCallback, Object).)
Protected methodOnBeginComplete(TrackingContext, IEnumerable(ArraySegment(Byte)), Boolean, TimeSpan, AsyncCallback, Object)Executes upon calling the OnComplete or BeginComplete operation. (Overrides MessageReceiver.OnBeginComplete(TrackingContext, IEnumerable(ArraySegment(Byte)), Boolean, TimeSpan, AsyncCallback, Object).)
Protected methodOnBeginComplete(TrackingContext, IEnumerable(Guid), Boolean, TimeSpan, AsyncCallback, Object)Executes upon calling the OnComplete or BeginComplete operation. (Overrides MessageReceiver.OnBeginComplete(TrackingContext, IEnumerable(Guid), Boolean, TimeSpan, AsyncCallback, Object).)
Protected methodOnBeginDeadLetterExecutes upon calling the OnDeadLetter or BeginDeadLetter operation. (Overrides MessageReceiver.OnBeginDeadLetter(TrackingContext, IEnumerable(Guid), IDictionary(String, Object), String, String, Boolean, TimeSpan, AsyncCallback, Object).)
Protected methodOnBeginDeferExecutes upon calling the OnDefer or BeginDefer operation. (Overrides MessageReceiver.OnBeginDefer(TrackingContext, IEnumerable(Guid), IDictionary(String, Object), Boolean, TimeSpan, AsyncCallback, Object).)
Protected methodOnBeginGetStateExecutes upon calling the OnGetState or BeginGetState operation.
Protected methodOnBeginOpenExecutes upon calling the OnOpen operation of the message receiver. (Overrides ClientEntity.OnBeginOpen(TimeSpan, AsyncCallback, Object).)
Protected methodOnBeginPeekExecutes upon calling the OnPeek or BeginPeek operation. (Overrides MessageReceiver.OnBeginPeek(TrackingContext, Int64, Int32, TimeSpan, AsyncCallback, Object).)
Protected methodOnBeginRenewLockExecutes upon calling the RenewLock or BeginRenewLock operation.
Protected methodOnBeginRenewMessageLocksExecutes upon calling the OnBegin operation for lock messages. (Overrides MessageReceiver.OnBeginRenewMessageLocks(TrackingContext, IEnumerable(Guid), Boolean, TimeSpan, AsyncCallback, Object).)
Protected methodOnBeginSetStateExecutes upon calling the OnSetState or BeginSetState operation.
Protected methodOnBeginTryReceive(TrackingContext, IEnumerable(Int64), TimeSpan, AsyncCallback, Object)Executes upon calling the OnTryReceive or BeginTryReceive operation of the message receiver. (Overrides MessageReceiver.OnBeginTryReceive(TrackingContext, IEnumerable(Int64), TimeSpan, AsyncCallback, Object).)
Protected methodOnBeginTryReceive(TrackingContext, Int32, TimeSpan, AsyncCallback, Object)Executes upon calling the OnTryReceive or BeginTryReceive operation of the message receiver. (Overrides MessageReceiver.OnBeginTryReceive(TrackingContext, Int32, TimeSpan, AsyncCallback, Object).)
Protected methodOnBeginTryReceive2Executes upon calling the OnTryReceive or BeginTryReceive operation of the message receiver. (Overrides MessageReceiver.OnBeginTryReceive2(TrackingContext, Int32, TimeSpan, AsyncCallback, Object).)
Protected methodOnBeginTryReceiveEventDataExecutes upon calling the OnTryReceive or BeginTryReceive operation for the event data. (Inherited from MessageReceiver.)
Protected methodOnClose (Inherited from ClientEntity.)
Protected methodOnClosed (Inherited from ClientEntity.)
Protected methodOnCompleteCompletes the message receive operation. (Overrides MessageReceiver.OnComplete(TrackingContext, IEnumerable(Guid), TimeSpan).)
Protected methodOnDeadLetterExecutes upon calling the DeadLetter operation. (Overrides MessageReceiver.OnDeadLetter(TrackingContext, IEnumerable(Guid), IDictionary(String, Object), String, String, TimeSpan).)
Protected methodOnDeferExecutes upon calling the Defer operation. (Overrides MessageReceiver.OnDefer(TrackingContext, IEnumerable(Guid), IDictionary(String, Object), TimeSpan).)
Protected methodOnEndAbandonEnds an asynchronous operation to abandon the message and relinquish its lock. (Overrides MessageReceiver.OnEndAbandon(IAsyncResult).)
Protected methodOnEndCloseEnds an asynchronous operation to close the communication object for the message session. (Overrides ClientEntity.OnEndClose(IAsyncResult).)
Protected methodOnEndCompleteExecutes the end complete operation of the message receiver. (Overrides MessageReceiver.OnEndComplete(IAsyncResult).)
Protected methodOnEndDeadLetterExecutes the end deadletter operation of the message receiver. (Overrides MessageReceiver.OnEndDeadLetter(IAsyncResult).)
Protected methodOnEndDeferExecutes the end defer operation of the message receiver. (Overrides MessageReceiver.OnEndDefer(IAsyncResult).)
Protected methodOnEndGetStateExecutes upon calling the OnGetState or EndGetState operation.
Protected methodOnEndOpenEnds the asynchronous operation to open a communication object for the message session. (Overrides ClientEntity.OnEndOpen(IAsyncResult).)
Protected methodOnEndPeekExecutes upon calling the EndPeek operation. (Overrides MessageReceiver.OnEndPeek(IAsyncResult).)
Protected methodOnEndRenewLockExecutes the EndRenewLock operation of the message receiver.
Protected methodOnEndRenewMessageLocksExecutes the EndRenew action for message locks. (Overrides MessageReceiver.OnEndRenewMessageLocks(IAsyncResult).)
Protected methodOnEndSetStateEnds the asynchronous operation to set the state of the message session.
Protected methodOnEndTryReceiveExecutes the end try receive operation of the message receiver. (Overrides MessageReceiver.OnEndTryReceive(IAsyncResult, IEnumerable(BrokeredMessage)).)
Protected methodOnEndTryReceive2Executes the end try receive operation of the message receiver. (Overrides MessageReceiver.OnEndTryReceive2(IAsyncResult, IEnumerable(BrokeredMessage)).)
Protected methodOnEndTryReceiveEventDataExecutes the EndTryReceive action for the event data. (Inherited from MessageReceiver.)
Protected methodOnFaulted (Inherited from ClientEntity.)
Protected methodOnGetStateExecutes upon calling the GetState operation.
Public methodOnMessageProcesses a message in an event-driven message pump. (Inherited from MessageReceiver.)
Public methodOnMessageAsyncAsynchronously processes a message in an event-driven message pump. (Inherited from MessageReceiver.)
Protected methodOnOpen (Inherited from ClientEntity.)
Protected methodOnOpened (Inherited from ClientEntity.)
Protected methodOnPeekExecutes upon calling the Peek operation. (Inherited from MessageReceiver.)
Protected methodOnRenewLockExecutes the RenewLock action for message locks.
Protected methodOnRenewMessageLocksExecutes the Renew action for lock messages. (Inherited from MessageReceiver.)
Protected methodOnSetStateExecutes upon calling the SetState operation.
Protected methodOnTryReceive(TrackingContext, IEnumerable(Int64), TimeSpan, IEnumerable(BrokeredMessage))Attempts a message receive operation. (Overrides MessageReceiver.OnTryReceive(TrackingContext, IEnumerable(Int64), TimeSpan, IEnumerable(BrokeredMessage)).)
Protected methodOnTryReceive(TrackingContext, Int32, TimeSpan, IEnumerable(BrokeredMessage))Attempts a message receive operation. (Overrides MessageReceiver.OnTryReceive(TrackingContext, Int32, TimeSpan, IEnumerable(BrokeredMessage)).)
Public methodPeek()Reads the next message without changing the state of the receiver or the message source. (Inherited from MessageReceiver.)
Public methodPeek(Int64)Reads the next message without changing the state of the receiver or the message source. (Inherited from MessageReceiver.)
Public methodPeekAsync()Asynchronously reads the next message without changing the state of the receiver or the message source. (Inherited from MessageReceiver.)
Public methodPeekAsync(Int64)Asynchronously reads the next message without changing the state of the receiver or the message source. (Inherited from MessageReceiver.)
Public methodPeekBatch(Int32)Reads the next batch of message without changing the state of the receiver or the message source. (Inherited from MessageReceiver.)
Public methodPeekBatch(Int64, Int32)Reads the next batch of message without changing the state of the receiver or the message source. (Inherited from MessageReceiver.)
Public methodPeekBatchAsync(Int32)Asynchronously reads the next batch of message without changing the state of the receiver or the message source. (Inherited from MessageReceiver.)
Public methodPeekBatchAsync(Int64, Int32)Asynchronously reads the next batch of message without changing the state of the receiver or the message source. (Inherited from MessageReceiver.)
Public methodReceive()Receives a BrokeredMessage from the current queue or topic. (Inherited from MessageReceiver.)
Public methodReceive(Int64)Receives a message from the current queue or topic. (Inherited from MessageReceiver.)
Public methodReceive(TimeSpan)Receives a BrokeredMessage from the current queue or topic. (Inherited from MessageReceiver.)
Public methodReceiveAsync()Asynchronously receives a message from the current queue or topic. (Inherited from MessageReceiver.)
Public methodReceiveAsync(Int64)Asynchronously receives a message from the current queue or topic. (Inherited from MessageReceiver.)
Public methodReceiveAsync(TimeSpan)Asynchronously receives a message from the current queue or topic. (Inherited from MessageReceiver.)
Public methodReceiveBatch(IEnumerable(Int64))Receives a batch of messages. (Inherited from MessageReceiver.)
Public methodReceiveBatch(Int32)Receives a batch of messages. (Inherited from MessageReceiver.)
Public methodReceiveBatch(Int32, TimeSpan)Receives a batch of messages. (Inherited from MessageReceiver.)
Public methodReceiveBatchAsync(IEnumerable(Int64))Asynchronously receives a batch of messages. (Inherited from MessageReceiver.)
Public methodReceiveBatchAsync(Int32)Asynchronously receives a batch of messages. (Inherited from MessageReceiver.)
Public methodReceiveBatchAsync(Int32, TimeSpan)Asynchronously receives a batch of messages. (Inherited from MessageReceiver.)
Public methodRenewLockSpecifies the time period within which the host renews its lock on a message.
Public methodRenewLockAsyncSpecifies the time period within which the host renews its lock on a message.
Public methodSetStateSets the state of the message session.
Public methodSetStateAsyncAsynchronously sets the state of the message session.
Protected methodThrowIfClosed (Inherited from ClientEntity.)
Protected methodThrowIfDisposed (Inherited from ClientEntity.)
Protected methodThrowIfDisposedOrImmutable (Inherited from ClientEntity.)
Protected methodThrowIfDisposedOrNotOpen (Inherited from ClientEntity.)
Protected methodThrowIfFaulted (Inherited from ClientEntity.)
Public methodToString (Inherited from Object.)
Top

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

Gruppinnehåll

Lägg till
Visa:
© 2014 Microsoft