SessionReceiver Class

  • Article

Represents a session receiver.

Inheritance Hierarchy

System.Object
  System.ServiceModel.Channels.CommunicationObject
    Microsoft.ServiceBus.Messaging.MessageReceiver
      Microsoft.ServiceBus.Messaging.SessionReceiver

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

Syntax

'Declaration
Public Class SessionReceiver _
    Inherits MessageReceiver
'Usage
Dim instance As SessionReceiver

public class SessionReceiver : MessageReceiver

public ref class SessionReceiver : public MessageReceiver

type SessionReceiver =  
    class
        inherit MessageReceiver
    end

public class SessionReceiver extends MessageReceiver

The SessionReceiver type exposes the following members.

Properties

  Name Description
Public property BatchFlushInterval Gets the batch flush interval. (Inherited from MessageReceiver.)
Protected property BatchingEnabled Gets a value indicating whether batching is enabled. (Inherited from MessageReceiver.)
Protected property DefaultCloseTimeout When overridden in a derived class, gets the default interval of time provided for a close operation to complete. (Inherited from MessageReceiver.)
Protected property DefaultOpenTimeout When overridden in a derived class, gets the default interval of time provided for an open operation to complete. (Inherited from MessageReceiver.)
Protected property IsDisposed (Inherited from CommunicationObject.)
Public property Mode Gets the message receive mode. (Inherited from MessageReceiver.)
Public property Path Gets the full path name of the file. (Overrides MessageReceiver.Path.)
Public property Session Gets or sets the session.
Public property SessionId Gets or sets the identifier of the session.
Public property State (Inherited from CommunicationObject.)
Protected property ThisLock (Inherited from CommunicationObject.)

Top

Methods

  Name Description
Public method Abandon(Guid) Abandons a message and unlocks it. (Inherited from MessageReceiver.)
Public method Abandon(BrokeredMessage) Abandons a brokered message and unlocks the message. (Inherited from MessageReceiver.)
Public method Abort (Inherited from CommunicationObject.)
Public method BeginAbandon(Guid, AsyncCallback, Object) Begins an abandon operation. (Inherited from MessageReceiver.)
Public method BeginAbandon(BrokeredMessage, AsyncCallback, Object) Begins an abandon operation. (Inherited from MessageReceiver.)
Public method BeginClose(AsyncCallback, Object) (Inherited from CommunicationObject.)
Public method BeginClose(TimeSpan, AsyncCallback, Object) (Inherited from CommunicationObject.)
Public method BeginComplete(Guid, AsyncCallback, Object) Asynchronous version of the Complete() method. Begins a complete operation. (Inherited from MessageReceiver.)
Public method BeginComplete(BrokeredMessage, AsyncCallback, Object) Asynchronous version of the Complete() method. (Inherited from MessageReceiver.)
Public method BeginDeadLetter(Guid, AsyncCallback, Object) Asynchronous version of the DeadLetter(BrokeredMessage) method. Begins a dead letter operation. (Inherited from MessageReceiver.)
Public method BeginDeadLetter(BrokeredMessage, AsyncCallback, Object) Asynchronous version of the DeadLetter(BrokeredMessage) method. Begins a dead letter operation. (Inherited from MessageReceiver.)
Public method BeginDefer(Guid, AsyncCallback, Object) Asynchronous version of the Defer() method. Begins a defer operation. (Inherited from MessageReceiver.)
Public method BeginDefer(BrokeredMessage, AsyncCallback, Object) Asynchronous version of the Defer() method. Begins a defer operation. (Inherited from MessageReceiver.)
Public method BeginOpen(AsyncCallback, Object) (Inherited from CommunicationObject.)
Public method BeginOpen(TimeSpan, AsyncCallback, Object) (Inherited from CommunicationObject.)
Public method BeginReceive(AsyncCallback, Object) Asynchronous version of the Receive() method. Begins a receive operation. (Inherited from MessageReceiver.)
Public method BeginReceive(TimeSpan, AsyncCallback, Object) Asynchronous version of the Receive() method. Begins a receive operation. (Inherited from MessageReceiver.)
Public method BeginReceive(MessageReceipt, AsyncCallback, Object) Asynchronous version of the Receive() method. Begins a receive operation. (Inherited from MessageReceiver.)
Public method BeginReceive(MessageReceipt, TimeSpan, AsyncCallback, Object) Asynchronous version of the Receive() method. Begins a receive operation. (Inherited from MessageReceiver.)
Public method BeginTryReceive(AsyncCallback, Object) Asynchronous version of the TryReceive() method. Begins a try receive operation. (Inherited from MessageReceiver.)
Public method BeginTryReceive(TimeSpan, AsyncCallback, Object) Asynchronous version of the TryReceive() method. Begins a try receive operation. (Inherited from MessageReceiver.)
Public method BeginTryReceive(MessageReceipt, AsyncCallback, Object) Asynchronous version of the TryReceive() method. Begins a try receive operation. (Inherited from MessageReceiver.)
Public method BeginTryReceive(MessageReceipt, TimeSpan, AsyncCallback, Object) Asynchronous version of the TryReceive() method. Begins a try receive operation. (Inherited from MessageReceiver.)
Public method Close() (Inherited from CommunicationObject.)
Public method Close(TimeSpan) (Inherited from CommunicationObject.)
Public method Complete(Guid) Completes the receive operation on a message. (Inherited from MessageReceiver.)
Public method Complete(BrokeredMessage) Completes the receive operation on a message. (Inherited from MessageReceiver.)
Public method DeadLetter Moves the message to the dead letter queue. (Inherited from MessageReceiver.)
Public method Defer(Guid) Indicates that the receiver wants to defer the processing for the message. (Inherited from MessageReceiver.)
Public method Defer(BrokeredMessage) Indicates that the receiver wants to defer the processing for this message. (Inherited from MessageReceiver.)
Public method Dispose() Disposes of the object and cleans up any resources it uses. (Inherited from MessageReceiver.)
Protected method Dispose(Boolean) Disposes of the object and cleans up any resources it uses. (Inherited from MessageReceiver.)
Public method EndAbandon Ends a message abandon operation. (Inherited from MessageReceiver.)
Public method EndClose (Inherited from CommunicationObject.)
Public method EndComplete Ends a complete operation on a message. (Inherited from MessageReceiver.)
Public method EndDeadLetter Ends a move to the dead letter queue. (Inherited from MessageReceiver.)
Public method EndDefer Ends the message defer operation. (Inherited from MessageReceiver.)
Public method EndOpen (Inherited from CommunicationObject.)
Public method EndReceive Ends a message receive operation. (Inherited from MessageReceiver.)
Public method EndTryReceive Ends a try receive operation. (Inherited from MessageReceiver.)
Public method Equals (Inherited from Object.)
Protected method Fault (Inherited from CommunicationObject.)
Protected method Finalize (Inherited from Object.)
Protected method GetCommunicationObjectType (Inherited from CommunicationObject.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnAbandon Executes the abandon action. (Inherited from MessageReceiver.)
Protected method OnAbort Executes the abort action. (Overrides CommunicationObject.OnAbort().)
Protected method OnBeginAbandon Executes the begin abandon action. (Overrides MessageReceiver.OnBeginAbandon(IEnumerable<Guid>, TimeSpan, AsyncCallback, Object).)
Protected method OnBeginClose Executes the begin close action. (Overrides CommunicationObject.OnBeginClose(TimeSpan, AsyncCallback, Object).)
Protected method OnBeginComplete Executes the begin complete action. (Overrides MessageReceiver.OnBeginComplete(IEnumerable<Guid>, TimeSpan, AsyncCallback, Object).)
Protected method OnBeginDeadLetter Executes the begin move to dead letter queue action. (Overrides MessageReceiver.OnBeginDeadLetter(IEnumerable<Guid>, TimeSpan, AsyncCallback, Object).)
Protected method OnBeginDefer Executes the begin defer action. (Overrides MessageReceiver.OnBeginDefer(IEnumerable<Guid>, TimeSpan, AsyncCallback, Object).)
Protected method OnBeginOpen Executes the begin open action. (Overrides CommunicationObject.OnBeginOpen(TimeSpan, AsyncCallback, Object).)
Protected method OnBeginTryReceive(Int32, TimeSpan, AsyncCallback, Object) Executes the begin try receive action. (Overrides MessageReceiver.OnBeginTryReceive(Int32, TimeSpan, AsyncCallback, Object).)
Protected method OnBeginTryReceive(IEnumerable<MessageReceipt>, TimeSpan, AsyncCallback, Object) Executes the begin try receive action. (Overrides MessageReceiver.OnBeginTryReceive(IEnumerable<MessageReceipt>, TimeSpan, AsyncCallback, Object).)
Protected method OnClose Executes the close action. (Inherited from MessageReceiver.)
Protected method OnClosed (Inherited from CommunicationObject.)
Protected method OnClosing (Inherited from CommunicationObject.)
Protected method OnComplete Executes the complete action. (Inherited from MessageReceiver.)
Protected method OnDeadLetter Executes the move to dead letter queue action. (Inherited from MessageReceiver.)
Protected method OnDefer Executes the defer action. (Inherited from MessageReceiver.)
Protected method OnEndAbandon Executes the end abandon action. (Overrides MessageReceiver.OnEndAbandon(IAsyncResult).)
Protected method OnEndClose Executes the end close action. (Overrides CommunicationObject.OnEndClose(IAsyncResult).)
Protected method OnEndComplete Executes the end complete action. (Overrides MessageReceiver.OnEndComplete(IAsyncResult).)
Protected method OnEndDeadLetter Executes the end move to dead letter queue action. (Overrides MessageReceiver.OnEndDeadLetter(IAsyncResult).)
Protected method OnEndDefer Executes the end defer action. (Overrides MessageReceiver.OnEndDefer(IAsyncResult).)
Protected method OnEndOpen Executes the end open action. (Overrides CommunicationObject.OnEndOpen(IAsyncResult).)
Protected method OnEndTryReceive Executes the end try receive action. (Overrides MessageReceiver.OnEndTryReceive(IAsyncResult, IEnumerable<BrokeredMessage>).)
Protected method OnFaulted (Inherited from CommunicationObject.)
Protected method OnOpen Executes the open action. (Inherited from MessageReceiver.)
Protected method OnOpened (Inherited from CommunicationObject.)
Protected method OnOpening (Inherited from CommunicationObject.)
Protected method OnTryReceive(Int32, TimeSpan, IEnumerable<BrokeredMessage>) Executes the try receive action. (Inherited from MessageReceiver.)
Protected method OnTryReceive(IEnumerable<MessageReceipt>, TimeSpan, IEnumerable<BrokeredMessage>) Executes the try receive action. (Inherited from MessageReceiver.)
Public method Open() (Inherited from CommunicationObject.)
Public method Open(TimeSpan) (Inherited from CommunicationObject.)
Public method Receive() Receives a BrokeredMessage from the current queue or topic. (Inherited from MessageReceiver.)
Public method Receive(TimeSpan) Receives a BrokeredMessagethe current queue or topic. (Inherited from MessageReceiver.)
Public method Receive(MessageReceipt) Receives a BrokeredMessage from the current queue or topic. (Inherited from MessageReceiver.)
Public method Receive(MessageReceipt, TimeSpan) Receives a BrokeredMessage from the current queue or topic. (Inherited from MessageReceiver.)
Protected method ThrowIfDisposed (Inherited from CommunicationObject.)
Protected method ThrowIfDisposedOrImmutable (Inherited from CommunicationObject.)
Protected method ThrowIfDisposedOrNotOpen (Inherited from CommunicationObject.)
Public method ToString (Inherited from Object.)
Public method TryReceive(BrokeredMessage) Tries to receive a brokered message. (Inherited from MessageReceiver.)
Public method TryReceive(TimeSpan, BrokeredMessage) Tries to receive a brokered message. (Inherited from MessageReceiver.)
Public method TryReceive(MessageReceipt, BrokeredMessage) Tries to receive a brokered message. (Inherited from MessageReceiver.)
Public method TryReceive(MessageReceipt, TimeSpan, BrokeredMessage) Tries to receive a brokered message. (Inherited from MessageReceiver.)

Top

Events

  Name Description
Public event Closed (Inherited from CommunicationObject.)
Public event Closing (Inherited from CommunicationObject.)
Public event Faulted (Inherited from CommunicationObject.)
Public event Opened (Inherited from CommunicationObject.)
Public event Opening (Inherited from CommunicationObject.)

Top

Thread Safety

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

See Also

Reference

Microsoft.ServiceBus.Messaging Namespace