Home Library Learn Downloads Support Community
Sign in | United States - English | |
1 out of 1 rated this helpful - Rate this topic

MessageSession Class

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

System.Object
  Microsoft.ServiceBus.Messaging.MessageClientEntity
    Microsoft.ServiceBus.Messaging.MessageReceiver
      Microsoft.ServiceBus.Messaging.MessageSession

Namespace:  Microsoft.ServiceBus.Messaging
Assembly:  Microsoft.ServiceBus (in Microsoft.ServiceBus.dll)
C#
C++
F#
JScript
VB
Copy 
public abstract class MessageSession : MessageReceiver

The MessageSession type exposes the following members.

  Name Description
Public property BatchFlushInterval Gets the batch flush interval. (Inherited from MessageReceiver.)
Protected property BatchingEnabled Gets a value indicating whether the batching is enabled. (Inherited from MessageReceiver.)
Public property IsClosed Gets or sets a value that indicates whether the message client entity is closed. (Inherited from MessageClientEntity.)
Public property Mode Gets the message receive mode. (Inherited from MessageReceiver.)
Public property Path Gets the path of the queue or topic, relative to the MessagingFactory base address. (Overrides MessageReceiver.Path.)
Public property PrefetchCount Gets or sets the number of messages that the message receiver can simultaneously request. (Overrides MessageReceiver.PrefetchCount.)
Public property SessionId Gets or sets the message session identifier.
Top
  Name Description
Public method Abandon Discards the message and relinquishes the message lock ownership. (Inherited from MessageReceiver.)
Public method Abort Aborts the message client entity and puts its status into a closing state. (Inherited from MessageClientEntity.)
Public method BeginAbandon Begins an asynchronous operation to abandon the message and relinquish its lock. (Inherited from MessageReceiver.)
Public method BeginClose Begins an asynchronous operation to close the message client entity. (Inherited from MessageClientEntity.)
Public method BeginComplete Begins an asynchronous operation to complete receipt of a message. (Inherited from MessageReceiver.)
Public method BeginDeadLetter(Guid, AsyncCallback, Object) Begins an asynchronous operation to move a message to the dead letter queue. (Inherited from MessageReceiver.)
Public method BeginDeadLetter(Guid, String, String, AsyncCallback, Object) Begins an asynchronous operation to move a message to the dead letter queue. (Inherited from MessageReceiver.)
Public method BeginDefer Begins an asynchronous operation to suspend receipt of a message. (Inherited from MessageReceiver.)
Public method BeginGetState Begins an asynchronous operation to set the state of the message session.
Public method BeginReceive(AsyncCallback, Object) Begins an asynchronous operation to receive a message. (Inherited from MessageReceiver.)
Public method BeginReceive(Int64, AsyncCallback, Object) Begins an asynchronous operation to receive a message. (Inherited from MessageReceiver.)
Public method BeginReceive(TimeSpan, AsyncCallback, Object) Begins an asynchronous operation to receive a message. (Inherited from MessageReceiver.)
Public method BeginSetState Begins an asynchronous operation to set the state of the message session.
Public method Close Closes the message client entity and puts its status into a closed state. (Inherited from MessageClientEntity.)
Public method Complete Completes the receive operation on a message. (Inherited from MessageReceiver.)
Public method DeadLetter(Guid) Moves the undelivered message to the dead letter queue. (Inherited from MessageReceiver.)
Public method DeadLetter(Guid, String, String) Moves the undelivered message to the dead letter queue. (Inherited from MessageReceiver.)
Public method Defer Indicates that the receiver wants to defer the processing for the message. (Inherited from MessageReceiver.)
Public method EndAbandon Ends the asynchronous operation to abandon the message and relinquish its lock. (Inherited from MessageReceiver.)
Public method EndClose Finishes an asynchronous operation to close the message client entity. (Inherited from MessageClientEntity.)
Public method EndComplete Ends the asynchronous operation to complete receipt of a message. (Inherited from MessageReceiver.)
Public method EndDeadLetter Ends an asynchronous operation to move the message to the dead letter queue. (Inherited from MessageReceiver.)
Public method EndDefer Ends an asynchronous operation to defer receipt of a message. (Inherited from MessageReceiver.)
Public method EndGetState Ends an asynchronous operation to get the state of the message session.
Public method EndReceive Ends an asynchronous operation to receive a message. (Inherited from MessageReceiver.)
Public method EndSetState Ends an asynchronous operation to set the state of the message session.
Public method Equals (Inherited from Object.)
Protected method Fault Puts the message client entity into a faulted state. (Inherited from MessageClientEntity.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetState Gets the state of the message session.
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnAbandon Abandons the message. (Overrides MessageReceiver.OnAbandon(TrackingContext, IEnumerable<Guid>, TimeSpan).)
Protected method OnAbort Aborts the message session. (Overrides MessageClientEntity.OnAbort().)
Protected method OnBeginAbandon Begins an asynchronous operation to abandon the message and relinquish its lock. (Overrides MessageReceiver.OnBeginAbandon(TrackingContext, IEnumerable<Guid>, TimeSpan, AsyncCallback, Object).)
Protected method OnBeginClose Begins an asynchronous operation to close the communication object for the message session. (Overrides MessageClientEntity.OnBeginClose(TimeSpan, AsyncCallback, Object).)
Protected method OnBeginComplete Executes upon calling the OnComplete or BeginComplete operation. (Overrides MessageReceiver.OnBeginComplete(TrackingContext, IEnumerable<Guid>, TimeSpan, AsyncCallback, Object).)
Protected method OnBeginDeadLetter Executes upon calling the OnDeadLetter or BeginDeadLetter operation. (Overrides MessageReceiver.OnBeginDeadLetter(TrackingContext, IEnumerable<Guid>, String, String, TimeSpan, AsyncCallback, Object).)
Protected method OnBeginDefer Executes upon calling the OnDefer or BeginDefer operation. (Overrides MessageReceiver.OnBeginDefer(TrackingContext, IEnumerable<Guid>, TimeSpan, AsyncCallback, Object).)
Protected method OnBeginGetState Executes upon calling the OnGetState or BeginGetState operation.
Protected method OnBeginOpen Executes upon calling the OnOpen operation of the message receiver. (Overrides MessageClientEntity.OnBeginOpen(TimeSpan, AsyncCallback, Object).)
Protected method OnBeginSetState Executes upon calling the OnSetState or BeginSetState operation.
Protected method OnBeginTryReceive(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 method OnBeginTryReceive(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 method OnClose Executes upon calling the Close operation. (Inherited from MessageClientEntity.)
Protected method OnClosed Occurs when the message client entity is transitioned into a closing state. (Inherited from MessageClientEntity.)
Protected method OnComplete Completes the message receive operation. (Overrides MessageReceiver.OnComplete(TrackingContext, IEnumerable<Guid>, TimeSpan).)
Protected method OnDeadLetter Deadletters a message. (Overrides MessageReceiver.OnDeadLetter(TrackingContext, IEnumerable<Guid>, String, String, TimeSpan).)
Protected method OnDefer Defers the delivery of a message. (Overrides MessageReceiver.OnDefer(TrackingContext, IEnumerable<Guid>, TimeSpan).)
Protected method OnEndAbandon Ends an asynchronous operation to abandon the message and relinquish its lock. (Overrides MessageReceiver.OnEndAbandon(IAsyncResult).)
Protected method OnEndClose Ends an asynchronous operation to close the communication object for the message session. (Overrides MessageClientEntity.OnEndClose(IAsyncResult).)
Protected method OnEndComplete Executes the end complete operation of the message receiver. (Overrides MessageReceiver.OnEndComplete(IAsyncResult).)
Protected method OnEndDeadLetter Executes the end deadletter operation of the message receiver. (Overrides MessageReceiver.OnEndDeadLetter(IAsyncResult).)
Protected method OnEndDefer Executes the end defer operation of the message receiver. (Overrides MessageReceiver.OnEndDefer(IAsyncResult).)
Protected method OnEndGetState Executes upon calling the OnGetState or EndGetState operation.
Protected method OnEndOpen Ends the asynchronous operation to open a communication object for the message session. (Overrides MessageClientEntity.OnEndOpen(IAsyncResult).)
Protected method OnEndSetState Ends the asynchronous operation to set the state of the message session.
Protected method OnEndTryReceive Executes the end try receive operation of the message receiver. (Overrides MessageReceiver.OnEndTryReceive(IAsyncResult, IEnumerable<BrokeredMessage>).)
Protected method OnFaulted Executes upon calling the Fault operation. (Inherited from MessageClientEntity.)
Protected method OnGetState Executes upon calling the GetState operation.
Protected method OnOpen Executes upon calling the operation to open the message client entity. (Inherited from MessageClientEntity.)
Protected method OnOpened Executes when the message client entity is opened. (Inherited from MessageClientEntity.)
Protected method OnSetState Executes upon calling the SetState operation.
Protected method OnTryReceive(TrackingContext, IEnumerable<Int64>, TimeSpan, IEnumerable<BrokeredMessage>) Attempts a message receive operation. (Overrides MessageReceiver.OnTryReceive(TrackingContext, IEnumerable<Int64>, TimeSpan, IEnumerable<BrokeredMessage>).)
Protected method OnTryReceive(TrackingContext, Int32, TimeSpan, IEnumerable<BrokeredMessage>) Attempts a message receive operation. (Overrides MessageReceiver.OnTryReceive(TrackingContext, Int32, TimeSpan, IEnumerable<BrokeredMessage>).)
Public method Receive() Receives a BrokeredMessage from the current queue or topic. (Inherited from MessageReceiver.)
Public method Receive(Int64) Receives a message from the current queue or topic. (Inherited from MessageReceiver.)
Public method Receive(TimeSpan) Receives a BrokeredMessage from the current queue or topic. (Inherited from MessageReceiver.)
Public method SetState Sets the state of the message session.
Protected method ThrowIfClosed Throws an exception if the message client entity is closed. (Inherited from MessageClientEntity.)
Protected method ThrowIfDisposed Throws an exception if the message client entity is disposed. (Inherited from MessageClientEntity.)
Protected method ThrowIfDisposedOrImmutable Throws an exception if the client is disposed or immutable. (Inherited from MessageClientEntity.)
Protected method ThrowIfDisposedOrNotOpen Throws an exception if the client is disposed or not open. (Inherited from MessageClientEntity.)
Protected method ThrowIfFaulted Throws an exception if the client is faulted. (Inherited from MessageClientEntity.)
Public method ToString (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.
Did you find this helpful?
(1500 characters remaining)