Export (0) Print
Expand All

SessionReceiver Class

Represents a session receiver.

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

public class SessionReceiver : MessageReceiver

The SessionReceiver type exposes the following members.

  NameDescription
Public propertyBatchFlushIntervalGets the batch flush interval. (Inherited from MessageReceiver.)
Protected propertyBatchingEnabledGets a value indicating whether batching is enabled. (Inherited from MessageReceiver.)
Protected propertyDefaultCloseTimeoutWhen overridden in a derived class, gets the default interval of time provided for a close operation to complete. (Inherited from MessageReceiver.)
Protected propertyDefaultOpenTimeoutWhen overridden in a derived class, gets the default interval of time provided for an open operation to complete. (Inherited from MessageReceiver.)
Protected propertyIsDisposed (Inherited from CommunicationObject.)
Public propertyModeGets the message receive mode. (Inherited from MessageReceiver.)
Public propertyPathGets the full path name of the file. (Overrides MessageReceiver.Path.)
Public propertySessionGets or sets the session.
Public propertySessionIdGets or sets the identifier of the session.
Public propertyState (Inherited from CommunicationObject.)
Protected propertyThisLock (Inherited from CommunicationObject.)
Top

  NameDescription
Public methodAbandon(Guid)Abandons a message and unlocks it. (Inherited from MessageReceiver.)
Public methodAbandon(BrokeredMessage)Abandons a brokered message and unlocks the message. (Inherited from MessageReceiver.)
Public methodAbort (Inherited from CommunicationObject.)
Public methodBeginAbandon(Guid, AsyncCallback, Object)Begins an abandon operation. (Inherited from MessageReceiver.)
Public methodBeginAbandon(BrokeredMessage, AsyncCallback, Object)Begins an abandon operation. (Inherited from MessageReceiver.)
Public methodBeginClose(AsyncCallback, Object) (Inherited from CommunicationObject.)
Public methodBeginClose(TimeSpan, AsyncCallback, Object) (Inherited from CommunicationObject.)
Public methodBeginComplete(Guid, AsyncCallback, Object)Asynchronous version of the Complete() method. Begins a complete operation. (Inherited from MessageReceiver.)
Public methodBeginComplete(BrokeredMessage, AsyncCallback, Object)Asynchronous version of the Complete() method. (Inherited from MessageReceiver.)
Public methodBeginDeadLetter(Guid, AsyncCallback, Object)Asynchronous version of the DeadLetter(BrokeredMessage) method. Begins a dead letter operation. (Inherited from MessageReceiver.)
Public methodBeginDeadLetter(BrokeredMessage, AsyncCallback, Object)Asynchronous version of the DeadLetter(BrokeredMessage) method. Begins a dead letter operation. (Inherited from MessageReceiver.)
Public methodBeginDefer(Guid, AsyncCallback, Object)Asynchronous version of the Defer() method. Begins a defer operation. (Inherited from MessageReceiver.)
Public methodBeginDefer(BrokeredMessage, AsyncCallback, Object)Asynchronous version of the Defer() method. Begins a defer operation. (Inherited from MessageReceiver.)
Public methodBeginOpen(AsyncCallback, Object) (Inherited from CommunicationObject.)
Public methodBeginOpen(TimeSpan, AsyncCallback, Object) (Inherited from CommunicationObject.)
Public methodBeginReceive(AsyncCallback, Object)Asynchronous version of the Receive() method. Begins a receive operation. (Inherited from MessageReceiver.)
Public methodBeginReceive(TimeSpan, AsyncCallback, Object)Asynchronous version of the Receive() method. Begins a receive operation. (Inherited from MessageReceiver.)
Public methodBeginReceive(MessageReceipt, AsyncCallback, Object)Asynchronous version of the Receive() method. Begins a receive operation. (Inherited from MessageReceiver.)
Public methodBeginReceive(MessageReceipt, TimeSpan, AsyncCallback, Object)Asynchronous version of the Receive() method. Begins a receive operation. (Inherited from MessageReceiver.)
Public methodBeginTryReceive(AsyncCallback, Object)Asynchronous version of the TryReceive() method. Begins a try receive operation. (Inherited from MessageReceiver.)
Public methodBeginTryReceive(TimeSpan, AsyncCallback, Object)Asynchronous version of the TryReceive() method. Begins a try receive operation. (Inherited from MessageReceiver.)
Public methodBeginTryReceive(MessageReceipt, AsyncCallback, Object)Asynchronous version of the TryReceive() method. Begins a try receive operation. (Inherited from MessageReceiver.)
Public methodBeginTryReceive(MessageReceipt, TimeSpan, AsyncCallback, Object)Asynchronous version of the TryReceive() method. Begins a try receive operation. (Inherited from MessageReceiver.)
Public methodClose() (Inherited from CommunicationObject.)
Public methodClose(TimeSpan) (Inherited from CommunicationObject.)
Public methodComplete(Guid)Completes the receive operation on a message. (Inherited from MessageReceiver.)
Public methodComplete(BrokeredMessage)Completes the receive operation on a message. (Inherited from MessageReceiver.)
Public methodDeadLetterMoves the 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(BrokeredMessage)Indicates that the receiver wants to defer the processing for this message. (Inherited from MessageReceiver.)
Public methodDispose()Disposes of the object and cleans up any resources it uses. (Inherited from MessageReceiver.)
Protected methodDispose(Boolean)Disposes of the object and cleans up any resources it uses. (Inherited from MessageReceiver.)
Public methodEndAbandonEnds a message abandon operation. (Inherited from MessageReceiver.)
Public methodEndClose (Inherited from CommunicationObject.)
Public methodEndCompleteEnds a complete operation on a message. (Inherited from MessageReceiver.)
Public methodEndDeadLetterEnds a move to the dead letter queue. (Inherited from MessageReceiver.)
Public methodEndDeferEnds the message defer operation. (Inherited from MessageReceiver.)
Public methodEndOpen (Inherited from CommunicationObject.)
Public methodEndReceiveEnds a message receive operation. (Inherited from MessageReceiver.)
Public methodEndTryReceiveEnds a try receive operation. (Inherited from MessageReceiver.)
Public methodEquals (Inherited from Object.)
Protected methodFault (Inherited from CommunicationObject.)
Protected methodFinalize (Inherited from Object.)
Protected methodGetCommunicationObjectType (Inherited from CommunicationObject.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodOnAbandonExecutes the abandon action. (Inherited from MessageReceiver.)
Protected methodOnAbortExecutes the abort action. (Overrides CommunicationObject.OnAbort().)
Protected methodOnBeginAbandonExecutes the begin abandon action. (Overrides MessageReceiver.OnBeginAbandon(IEnumerable<Guid>, TimeSpan, AsyncCallback, Object).)
Protected methodOnBeginCloseExecutes the begin close action. (Overrides CommunicationObject.OnBeginClose(TimeSpan, AsyncCallback, Object).)
Protected methodOnBeginCompleteExecutes the begin complete action. (Overrides MessageReceiver.OnBeginComplete(IEnumerable<Guid>, TimeSpan, AsyncCallback, Object).)
Protected methodOnBeginDeadLetterExecutes the begin move to dead letter queue action. (Overrides MessageReceiver.OnBeginDeadLetter(IEnumerable<Guid>, TimeSpan, AsyncCallback, Object).)
Protected methodOnBeginDeferExecutes the begin defer action. (Overrides MessageReceiver.OnBeginDefer(IEnumerable<Guid>, TimeSpan, AsyncCallback, Object).)
Protected methodOnBeginOpenExecutes the begin open action. (Overrides CommunicationObject.OnBeginOpen(TimeSpan, AsyncCallback, Object).)
Protected methodOnBeginTryReceive(Int32, TimeSpan, AsyncCallback, Object)Executes the begin try receive action. (Overrides MessageReceiver.OnBeginTryReceive(Int32, TimeSpan, AsyncCallback, Object).)
Protected methodOnBeginTryReceive(IEnumerable<MessageReceipt>, TimeSpan, AsyncCallback, Object)Executes the begin try receive action. (Overrides MessageReceiver.OnBeginTryReceive(IEnumerable<MessageReceipt>, TimeSpan, AsyncCallback, Object).)
Protected methodOnCloseExecutes the close action. (Inherited from MessageReceiver.)
Protected methodOnClosed (Inherited from CommunicationObject.)
Protected methodOnClosing (Inherited from CommunicationObject.)
Protected methodOnCompleteExecutes the complete action. (Inherited from MessageReceiver.)
Protected methodOnDeadLetterExecutes the move to dead letter queue action. (Inherited from MessageReceiver.)
Protected methodOnDeferExecutes the defer action. (Inherited from MessageReceiver.)
Protected methodOnEndAbandonExecutes the end abandon action. (Overrides MessageReceiver.OnEndAbandon(IAsyncResult).)
Protected methodOnEndCloseExecutes the end close action. (Overrides CommunicationObject.OnEndClose(IAsyncResult).)
Protected methodOnEndCompleteExecutes the end complete action. (Overrides MessageReceiver.OnEndComplete(IAsyncResult).)
Protected methodOnEndDeadLetterExecutes the end move to dead letter queue action. (Overrides MessageReceiver.OnEndDeadLetter(IAsyncResult).)
Protected methodOnEndDeferExecutes the end defer action. (Overrides MessageReceiver.OnEndDefer(IAsyncResult).)
Protected methodOnEndOpenExecutes the end open action. (Overrides CommunicationObject.OnEndOpen(IAsyncResult).)
Protected methodOnEndTryReceiveExecutes the end try receive action. (Overrides MessageReceiver.OnEndTryReceive(IAsyncResult, IEnumerable<BrokeredMessage>).)
Protected methodOnFaulted (Inherited from CommunicationObject.)
Protected methodOnOpenExecutes the open action. (Inherited from MessageReceiver.)
Protected methodOnOpened (Inherited from CommunicationObject.)
Protected methodOnOpening (Inherited from CommunicationObject.)
Protected methodOnTryReceive(Int32, TimeSpan, IEnumerable<BrokeredMessage>)Executes the try receive action. (Inherited from MessageReceiver.)
Protected methodOnTryReceive(IEnumerable<MessageReceipt>, TimeSpan, IEnumerable<BrokeredMessage>)Executes the try receive action. (Inherited from MessageReceiver.)
Public methodOpen() (Inherited from CommunicationObject.)
Public methodOpen(TimeSpan) (Inherited from CommunicationObject.)
Public methodReceive()Receives a BrokeredMessage from the current queue or topic. (Inherited from MessageReceiver.)
Public methodReceive(TimeSpan)Receives a BrokeredMessagethe current queue or topic. (Inherited from MessageReceiver.)
Public methodReceive(MessageReceipt)Receives a BrokeredMessage from the current queue or topic. (Inherited from MessageReceiver.)
Public methodReceive(MessageReceipt, TimeSpan)Receives a BrokeredMessage from the current queue or topic. (Inherited from MessageReceiver.)
Protected methodThrowIfDisposed (Inherited from CommunicationObject.)
Protected methodThrowIfDisposedOrImmutable (Inherited from CommunicationObject.)
Protected methodThrowIfDisposedOrNotOpen (Inherited from CommunicationObject.)
Public methodToString (Inherited from Object.)
Public methodTryReceive(BrokeredMessage)Tries to receive a brokered message. (Inherited from MessageReceiver.)
Public methodTryReceive(TimeSpan, BrokeredMessage)Tries to receive a brokered message. (Inherited from MessageReceiver.)
Public methodTryReceive(MessageReceipt, BrokeredMessage)Tries to receive a brokered message. (Inherited from MessageReceiver.)
Public methodTryReceive(MessageReceipt, TimeSpan, BrokeredMessage)Tries to receive a brokered message. (Inherited from MessageReceiver.)
Top

  NameDescription
Public eventClosed (Inherited from CommunicationObject.)
Public eventClosing (Inherited from CommunicationObject.)
Public eventFaulted (Inherited from CommunicationObject.)
Public eventOpened (Inherited from CommunicationObject.)
Public eventOpening (Inherited from CommunicationObject.)
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.
Show:
© 2014 Microsoft