SessionReceiver Class
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 | |
---|---|---|
![]() |
BatchFlushInterval | Gets the batch flush interval. (Inherited from MessageReceiver.) |
![]() |
BatchingEnabled | Gets a value indicating whether batching is enabled. (Inherited from MessageReceiver.) |
![]() |
DefaultCloseTimeout | When overridden in a derived class, gets the default interval of time provided for a close operation to complete. (Inherited from MessageReceiver.) |
![]() |
DefaultOpenTimeout | When overridden in a derived class, gets the default interval of time provided for an open operation to complete. (Inherited from MessageReceiver.) |
![]() |
IsDisposed | (Inherited from CommunicationObject.) |
![]() |
Mode | Gets the message receive mode. (Inherited from MessageReceiver.) |
![]() |
Path | Gets the full path name of the file. (Overrides MessageReceiver.Path.) |
![]() |
Session | Gets or sets the session. |
![]() |
SessionId | Gets or sets the identifier of the session. |
![]() |
State | (Inherited from CommunicationObject.) |
![]() |
ThisLock | (Inherited from CommunicationObject.) |
Top
Methods
Name | Description | |
---|---|---|
![]() |
Abandon(Guid) | Abandons a message and unlocks it. (Inherited from MessageReceiver.) |
![]() |
Abandon(BrokeredMessage) | Abandons a brokered message and unlocks the message. (Inherited from MessageReceiver.) |
![]() |
Abort | (Inherited from CommunicationObject.) |
![]() |
BeginAbandon(Guid, AsyncCallback, Object) | Begins an abandon operation. (Inherited from MessageReceiver.) |
![]() |
BeginAbandon(BrokeredMessage, AsyncCallback, Object) | Begins an abandon operation. (Inherited from MessageReceiver.) |
![]() |
BeginClose(AsyncCallback, Object) | (Inherited from CommunicationObject.) |
![]() |
BeginClose(TimeSpan, AsyncCallback, Object) | (Inherited from CommunicationObject.) |
![]() |
BeginComplete(Guid, AsyncCallback, Object) | Asynchronous version of the Complete() method. Begins a complete operation. (Inherited from MessageReceiver.) |
![]() |
BeginComplete(BrokeredMessage, AsyncCallback, Object) | Asynchronous version of the Complete() method. (Inherited from MessageReceiver.) |
![]() |
BeginDeadLetter(Guid, AsyncCallback, Object) | Asynchronous version of the DeadLetter(BrokeredMessage) method. Begins a dead letter operation. (Inherited from MessageReceiver.) |
![]() |
BeginDeadLetter(BrokeredMessage, AsyncCallback, Object) | Asynchronous version of the DeadLetter(BrokeredMessage) method. Begins a dead letter operation. (Inherited from MessageReceiver.) |
![]() |
BeginDefer(Guid, AsyncCallback, Object) | Asynchronous version of the Defer() method. Begins a defer operation. (Inherited from MessageReceiver.) |
![]() |
BeginDefer(BrokeredMessage, AsyncCallback, Object) | Asynchronous version of the Defer() method. Begins a defer operation. (Inherited from MessageReceiver.) |
![]() |
BeginOpen(AsyncCallback, Object) | (Inherited from CommunicationObject.) |
![]() |
BeginOpen(TimeSpan, AsyncCallback, Object) | (Inherited from CommunicationObject.) |
![]() |
BeginReceive(AsyncCallback, Object) | Asynchronous version of the Receive() method. Begins a receive operation. (Inherited from MessageReceiver.) |
![]() |
BeginReceive(TimeSpan, AsyncCallback, Object) | Asynchronous version of the Receive() method. Begins a receive operation. (Inherited from MessageReceiver.) |
![]() |
BeginReceive(MessageReceipt, AsyncCallback, Object) | Asynchronous version of the Receive() method. Begins a receive operation. (Inherited from MessageReceiver.) |
![]() |
BeginReceive(MessageReceipt, TimeSpan, AsyncCallback, Object) | Asynchronous version of the Receive() method. Begins a receive operation. (Inherited from MessageReceiver.) |
![]() |
BeginTryReceive(AsyncCallback, Object) | Asynchronous version of the TryReceive() method. Begins a try receive operation. (Inherited from MessageReceiver.) |
![]() |
BeginTryReceive(TimeSpan, AsyncCallback, Object) | Asynchronous version of the TryReceive() method. Begins a try receive operation. (Inherited from MessageReceiver.) |
![]() |
BeginTryReceive(MessageReceipt, AsyncCallback, Object) | Asynchronous version of the TryReceive() method. Begins a try receive operation. (Inherited from MessageReceiver.) |
![]() |
BeginTryReceive(MessageReceipt, TimeSpan, AsyncCallback, Object) | Asynchronous version of the TryReceive() method. Begins a try receive operation. (Inherited from MessageReceiver.) |
![]() |
Close() | (Inherited from CommunicationObject.) |
![]() |
Close(TimeSpan) | (Inherited from CommunicationObject.) |
![]() |
Complete(Guid) | Completes the receive operation on a message. (Inherited from MessageReceiver.) |
![]() |
Complete(BrokeredMessage) | Completes the receive operation on a message. (Inherited from MessageReceiver.) |
![]() |
DeadLetter | Moves the message to the dead letter queue. (Inherited from MessageReceiver.) |
![]() |
Defer(Guid) | Indicates that the receiver wants to defer the processing for the message. (Inherited from MessageReceiver.) |
![]() |
Defer(BrokeredMessage) | Indicates that the receiver wants to defer the processing for this message. (Inherited from MessageReceiver.) |
![]() |
Dispose() | Disposes of the object and cleans up any resources it uses. (Inherited from MessageReceiver.) |
![]() |
Dispose(Boolean) | Disposes of the object and cleans up any resources it uses. (Inherited from MessageReceiver.) |
![]() |
EndAbandon | Ends a message abandon operation. (Inherited from MessageReceiver.) |
![]() |
EndClose | (Inherited from CommunicationObject.) |
![]() |
EndComplete | Ends a complete operation on a message. (Inherited from MessageReceiver.) |
![]() |
EndDeadLetter | Ends a move to the dead letter queue. (Inherited from MessageReceiver.) |
![]() |
EndDefer | Ends the message defer operation. (Inherited from MessageReceiver.) |
![]() |
EndOpen | (Inherited from CommunicationObject.) |
![]() |
EndReceive | Ends a message receive operation. (Inherited from MessageReceiver.) |
![]() |
EndTryReceive | Ends a try receive operation. (Inherited from MessageReceiver.) |
![]() |
Equals | (Inherited from Object.) |
![]() |
Fault | (Inherited from CommunicationObject.) |
![]() |
Finalize | (Inherited from Object.) |
![]() |
GetCommunicationObjectType | (Inherited from CommunicationObject.) |
![]() |
GetHashCode | (Inherited from Object.) |
![]() |
GetType | (Inherited from Object.) |
![]() |
MemberwiseClone | (Inherited from Object.) |
![]() |
OnAbandon | Executes the abandon action. (Inherited from MessageReceiver.) |
![]() |
OnAbort | Executes the abort action. (Overrides CommunicationObject.OnAbort().) |
![]() |
OnBeginAbandon | Executes the begin abandon action. (Overrides MessageReceiver.OnBeginAbandon(IEnumerable<Guid>, TimeSpan, AsyncCallback, Object).) |
![]() |
OnBeginClose | Executes the begin close action. (Overrides CommunicationObject.OnBeginClose(TimeSpan, AsyncCallback, Object).) |
![]() |
OnBeginComplete | Executes the begin complete action. (Overrides MessageReceiver.OnBeginComplete(IEnumerable<Guid>, TimeSpan, AsyncCallback, Object).) |
![]() |
OnBeginDeadLetter | Executes the begin move to dead letter queue action. (Overrides MessageReceiver.OnBeginDeadLetter(IEnumerable<Guid>, TimeSpan, AsyncCallback, Object).) |
![]() |
OnBeginDefer | Executes the begin defer action. (Overrides MessageReceiver.OnBeginDefer(IEnumerable<Guid>, TimeSpan, AsyncCallback, Object).) |
![]() |
OnBeginOpen | Executes the begin open action. (Overrides CommunicationObject.OnBeginOpen(TimeSpan, AsyncCallback, Object).) |
![]() |
OnBeginTryReceive(Int32, TimeSpan, AsyncCallback, Object) | Executes the begin try receive action. (Overrides MessageReceiver.OnBeginTryReceive(Int32, TimeSpan, AsyncCallback, Object).) |
![]() |
OnBeginTryReceive(IEnumerable<MessageReceipt>, TimeSpan, AsyncCallback, Object) | Executes the begin try receive action. (Overrides MessageReceiver.OnBeginTryReceive(IEnumerable<MessageReceipt>, TimeSpan, AsyncCallback, Object).) |
![]() |
OnClose | Executes the close action. (Inherited from MessageReceiver.) |
![]() |
OnClosed | (Inherited from CommunicationObject.) |
![]() |
OnClosing | (Inherited from CommunicationObject.) |
![]() |
OnComplete | Executes the complete action. (Inherited from MessageReceiver.) |
![]() |
OnDeadLetter | Executes the move to dead letter queue action. (Inherited from MessageReceiver.) |
![]() |
OnDefer | Executes the defer action. (Inherited from MessageReceiver.) |
![]() |
OnEndAbandon | Executes the end abandon action. (Overrides MessageReceiver.OnEndAbandon(IAsyncResult).) |
![]() |
OnEndClose | Executes the end close action. (Overrides CommunicationObject.OnEndClose(IAsyncResult).) |
![]() |
OnEndComplete | Executes the end complete action. (Overrides MessageReceiver.OnEndComplete(IAsyncResult).) |
![]() |
OnEndDeadLetter | Executes the end move to dead letter queue action. (Overrides MessageReceiver.OnEndDeadLetter(IAsyncResult).) |
![]() |
OnEndDefer | Executes the end defer action. (Overrides MessageReceiver.OnEndDefer(IAsyncResult).) |
![]() |
OnEndOpen | Executes the end open action. (Overrides CommunicationObject.OnEndOpen(IAsyncResult).) |
![]() |
OnEndTryReceive | Executes the end try receive action. (Overrides MessageReceiver.OnEndTryReceive(IAsyncResult, IEnumerable<BrokeredMessage>).) |
![]() |
OnFaulted | (Inherited from CommunicationObject.) |
![]() |
OnOpen | Executes the open action. (Inherited from MessageReceiver.) |
![]() |
OnOpened | (Inherited from CommunicationObject.) |
![]() |
OnOpening | (Inherited from CommunicationObject.) |
![]() |
OnTryReceive(Int32, TimeSpan, IEnumerable<BrokeredMessage>) | Executes the try receive action. (Inherited from MessageReceiver.) |
![]() |
OnTryReceive(IEnumerable<MessageReceipt>, TimeSpan, IEnumerable<BrokeredMessage>) | Executes the try receive action. (Inherited from MessageReceiver.) |
![]() |
Open() | (Inherited from CommunicationObject.) |
![]() |
Open(TimeSpan) | (Inherited from CommunicationObject.) |
![]() |
Receive() | Receives a BrokeredMessage from the current queue or topic. (Inherited from MessageReceiver.) |
![]() |
Receive(TimeSpan) | Receives a BrokeredMessagethe current queue or topic. (Inherited from MessageReceiver.) |
![]() |
Receive(MessageReceipt) | Receives a BrokeredMessage from the current queue or topic. (Inherited from MessageReceiver.) |
![]() |
Receive(MessageReceipt, TimeSpan) | Receives a BrokeredMessage from the current queue or topic. (Inherited from MessageReceiver.) |
![]() |
ThrowIfDisposed | (Inherited from CommunicationObject.) |
![]() |
ThrowIfDisposedOrImmutable | (Inherited from CommunicationObject.) |
![]() |
ThrowIfDisposedOrNotOpen | (Inherited from CommunicationObject.) |
![]() |
ToString | (Inherited from Object.) |
![]() |
TryReceive(BrokeredMessage) | Tries to receive a brokered message. (Inherited from MessageReceiver.) |
![]() |
TryReceive(TimeSpan, BrokeredMessage) | Tries to receive a brokered message. (Inherited from MessageReceiver.) |
![]() |
TryReceive(MessageReceipt, BrokeredMessage) | Tries to receive a brokered message. (Inherited from MessageReceiver.) |
![]() |
TryReceive(MessageReceipt, TimeSpan, BrokeredMessage) | Tries to receive a brokered message. (Inherited from MessageReceiver.) |
Top
Events
Name | Description | |
---|---|---|
![]() |
Closed | (Inherited from CommunicationObject.) |
![]() |
Closing | (Inherited from CommunicationObject.) |
![]() |
Faulted | (Inherited from CommunicationObject.) |
![]() |
Opened | (Inherited from CommunicationObject.) |
![]() |
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.