你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

MessageSession 类

定义

命名空间:

Microsoft.ServiceBus.Messaging

程序集:

Microsoft.ServiceBus.dll

包:

WindowsAzure.ServiceBus v6.2.2

表示一个消息会话，该会话允许对相关消息进行分组，以便在单个事务中进行处理。

public abstract class MessageSession : Microsoft.ServiceBus.Messaging.MessageReceiver

type MessageSession = class
    inherit MessageReceiver

Public MustInherit Class MessageSession
Inherits MessageReceiver

继承

Object

ClientEntity

MessagingEntityClient

MessageReceiver

MessageSession

属性

BatchFlushInterval	获取批量刷新间隔。 (继承自 MessageReceiver)
BatchingEnabled	获取一个值，该值指示是否启用批处理。 (继承自 MessageReceiver)
IsClosed	表示一个消息会话，该会话允许对相关消息进行分组，以便在单个事务中进行处理。 (继承自 ClientEntity)
IsExclusiveMode	表示一个消息会话，该会话允许对相关消息进行分组，以便在单个事务中进行处理。
LastPeekedSequenceNumber	获取或设置会话中最后一个速览的序列号。
LockedUntilUtc	获取或设置消息会话解锁的日期和时间。
LockToken	表示一个消息会话，该会话允许对相关消息进行分组，以便在单个事务中进行处理。
Mode	获取消息接收模式。 (继承自 MessageReceiver)
Path	获取队列、主题或订阅相对于 MessagingFactory 基址的路径。 (继承自 MessagingEntityClient)
PrefetchCount	获取或设置消息接收方可以同时请求的消息数。
RefreshEntityRuntimeDescription	表示一个消息会话，该会话允许对相关消息进行分组，以便在单个事务中进行处理。 (继承自 MessageReceiver)
RetryPolicy	表示一个消息会话，该会话允许对相关消息进行分组，以便在单个事务中进行处理。 (继承自 ClientEntity)
SessionId	获取或设置消息会话标识符。
SupportsGetRuntimeEntityDescription	表示一个消息会话，该会话允许对相关消息进行分组，以便在单个事务中进行处理。
ThisLock	表示一个消息会话，该会话允许对相关消息进行分组，以便在单个事务中进行处理。 (继承自 ClientEntity)

方法

Abandon(Guid)	放弃消息并放弃消息锁的所有权。 (继承自 MessageReceiver)
Abandon(Guid, IDictionary<String,Object>)	放弃消息并放弃消息锁的所有权。 (继承自 MessageReceiver)
AbandonAsync(Guid)	异步放弃消息并放弃消息锁所有权。 (继承自 MessageReceiver)
AbandonAsync(Guid, IDictionary<String,Object>)	异步放弃消息并放弃消息锁所有权。 (继承自 MessageReceiver)
Abort()	对消息传送实体执行中止功能。 (继承自 ClientEntity)
Close()	向服务总线发送清理消息，以指示实体的使用完成。 (继承自 ClientEntity)
CloseAsync()	以异步方式将清理消息发送到服务总线，以指示实体的使用完成。 (继承自 ClientEntity)
Complete(Guid)	完成对消息的接收操作。 如果使用 AMQP，则只能对此接收方收到的消息执行此操作。 (继承自 MessageReceiver)
CompleteAsync(Guid)	异步完成对消息的接收操作。 如果使用 AMQP，则只能对此接收方收到的消息执行此操作。 (继承自 MessageReceiver)
CompleteBatch(IEnumerable<Guid>)	完成对一批消息的接收操作。 如果使用 AMQP，则只能对此接收方收到的消息执行此操作。 (继承自 MessageReceiver)
CompleteBatchAsync(IEnumerable<Guid>)	异步完成对一批消息的接收操作。 如果使用 AMQP，则只能对此接收方收到的消息执行此操作。 (继承自 MessageReceiver)
DeadLetter(Guid)	将未传递的消息移动到死信队列。 (继承自 MessageReceiver)
DeadLetter(Guid, IDictionary<String,Object>)	将未传递的消息移动到死信队列。 (继承自 MessageReceiver)
DeadLetter(Guid, String, String)	将未传递的消息移动到死信队列。 (继承自 MessageReceiver)
DeadLetterAsync(Guid)	异步将未传递的消息移动到死信队列。 (继承自 MessageReceiver)
DeadLetterAsync(Guid, IDictionary<String,Object>)	异步将未传递的消息移动到死信队列。 (继承自 MessageReceiver)
DeadLetterAsync(Guid, String, String)	异步将未传递的消息移动到死信队列。 (继承自 MessageReceiver)
Defer(Guid)	指示接收方希望延迟消息的处理。 (继承自 MessageReceiver)
Defer(Guid, IDictionary<String,Object>)	指示接收方希望延迟消息的处理。 (继承自 MessageReceiver)
DeferAsync(Guid)	异步延迟消息的处理。 (继承自 MessageReceiver)
DeferAsync(Guid, IDictionary<String,Object>)	异步延迟消息的处理。 (继承自 MessageReceiver)
Fault()	仅限内部使用。 请勿从此类继承。 (继承自 ClientEntity)
GetProperty<T>()	表示一个消息会话，该会话允许对相关消息进行分组，以便在单个事务中进行处理。 (继承自 MessageReceiver)
GetState()	获取消息会话的状态。
GetStateAsync()	异步获取消息会话的状态。
OnAbandon(TrackingContext, IEnumerable<Guid>, IDictionary<String,Object>, TimeSpan)	放弃速览锁定邮件。
OnAbort()	中止消息会话。
OnBeginAbandon(TrackingContext, IEnumerable<Guid>, IDictionary<String,Object>, Boolean, TimeSpan, AsyncCallback, Object)	执行开始放弃操作。
OnBeginClose(TimeSpan, AsyncCallback, Object)	开始异步操作以关闭消息会话的通信对象。
OnBeginComplete(TrackingContext, IEnumerable<ArraySegment<Byte>>, Boolean, TimeSpan, AsyncCallback, Object)	调用 OnComplete 或 BeginComplete 操作时执行。
OnBeginComplete(TrackingContext, IEnumerable<Guid>, Boolean, TimeSpan, AsyncCallback, Object)	调用 OnComplete 或 BeginComplete 操作时执行。
OnBeginDeadLetter(TrackingContext, IEnumerable<Guid>, IDictionary<String,Object>, String, String, Boolean, TimeSpan, AsyncCallback, Object)	执行开始移动到死信队列操作。
OnBeginDefer(TrackingContext, IEnumerable<Guid>, IDictionary<String,Object>, Boolean, TimeSpan, AsyncCallback, Object)	执行开始延迟操作。
OnBeginGetState(TrackingContext, TimeSpan, AsyncCallback, Object)	执行开始获取状态操作。
OnBeginOpen(TimeSpan, AsyncCallback, Object)	在调用消息接收器的 OnOpen 操作时执行。
OnBeginPeek(TrackingContext, Int64, Int32, TimeSpan, AsyncCallback, Object)	调用 OnPeek 或 BeginPeek 操作时执行。
OnBeginRenewLock(TrackingContext, TimeSpan, AsyncCallback, Object)	调用 RenewLock 或 BeginRenewLock 操作时执行。
OnBeginRenewMessageLocks(TrackingContext, IEnumerable<Guid>, Boolean, TimeSpan, AsyncCallback, Object)	调用锁定消息的 OnBegin 操作时执行。
OnBeginSetState(TrackingContext, Stream, TimeSpan, AsyncCallback, Object)	执行开始设置状态操作。
OnBeginTryReceive(TrackingContext, IEnumerable<Int64>, TimeSpan, AsyncCallback, Object)	执行开始尝试接收操作。
OnBeginTryReceive(TrackingContext, Int32, TimeSpan, AsyncCallback, Object)	执行开始尝试接收操作。
OnBeginTryReceive2(TrackingContext, Int32, TimeSpan, AsyncCallback, Object)	执行开始尝试接收操作。
OnBeginTryReceiveEventData(TrackingContext, Int32, TimeSpan, AsyncCallback, Object)	对事件数据调用 OnTryReceive 或 BeginTryReceive 操作时执行。 (继承自 MessageReceiver)
OnClose(TimeSpan)	表示一个消息会话，该会话允许对相关消息进行分组，以便在单个事务中进行处理。 (继承自 ClientEntity)
OnClosed()	表示一个消息会话，该会话允许对相关消息进行分组，以便在单个事务中进行处理。 (继承自 ClientEntity)
OnComplete(TrackingContext, IEnumerable<Guid>, TimeSpan)	完成速览锁定消息。
OnDeadLetter(TrackingContext, IEnumerable<Guid>, IDictionary<String,Object>, String, String, TimeSpan)	将消息移动到死信队列。
OnDefer(TrackingContext, IEnumerable<Guid>, IDictionary<String,Object>, TimeSpan)	延迟消息。
OnEndAbandon(IAsyncResult)	结束异步操作以放弃消息并放弃其锁定。
OnEndClose(IAsyncResult)	结束异步操作以关闭消息会话的通信对象。
OnEndComplete(IAsyncResult)	执行消息接收器的结束完成操作。
OnEndDeadLetter(IAsyncResult)	执行消息接收器的结束死信操作。
OnEndDefer(IAsyncResult)	执行消息接收器的结束延迟操作。
OnEndGetState(IAsyncResult)	在调用 OnGetState 或 EndGetState 操作时执行。
OnEndOpen(IAsyncResult)	结束异步操作以打开消息会话的通信对象。
OnEndPeek(IAsyncResult)	调用 EndPeek 操作时执行。
OnEndRenewLock(IAsyncResult)	执行消息接收器的 EndRenewLock 操作。
OnEndRenewMessageLocks(IAsyncResult)	对消息锁执行 EndRenew 操作。
OnEndSetState(IAsyncResult)	结束异步操作以设置消息会话的状态。
OnEndTryReceive(IAsyncResult, IEnumerable<BrokeredMessage>)	执行消息接收器的 end try 接收操作。
OnEndTryReceive2(IAsyncResult, IEnumerable<BrokeredMessage>)	执行消息接收器的 end try 接收操作。
OnEndTryReceiveEventData(IAsyncResult, IEnumerable<EventData>)	对事件数据执行 EndTryReceive 操作。 (继承自 MessageReceiver)
OnFaulted()	表示一个消息会话，该会话允许对相关消息进行分组，以便在单个事务中进行处理。 (继承自 ClientEntity)
OnGetState(TrackingContext, TimeSpan)	执行获取状态操作。
OnMessage(Action<BrokeredMessage>, OnMessageOptions)	在事件驱动的消息泵中处理消息。 (继承自 MessageReceiver)
OnMessageAsync(Func<BrokeredMessage,Task>, OnMessageOptions)	异步处理事件驱动的消息泵中的消息。 (继承自 MessageReceiver)
OnOpen(TimeSpan)	表示一个消息会话，该会话允许对相关消息进行分组，以便在单个事务中进行处理。 (继承自 ClientEntity)
OnOpened()	表示一个消息会话，该会话允许对相关消息进行分组，以便在单个事务中进行处理。 (继承自 ClientEntity)
OnPeek(TrackingContext, Int64, Int32, TimeSpan)	调用“速览”操作时执行。 (继承自 MessageReceiver)
OnRenewLock(TrackingContext, TimeSpan)	对消息锁执行 RenewLock 操作。
OnRenewMessageLocks(TrackingContext, IEnumerable<Guid>, TimeSpan)	对锁定消息执行“续订”操作。 (继承自 MessageReceiver)
OnSetState(TrackingContext, Stream, TimeSpan)	执行设置状态操作。
OnTryReceive(TrackingContext, IEnumerable<Int64>, TimeSpan, IEnumerable<BrokeredMessage>)	执行 try receive 操作。
OnTryReceive(TrackingContext, Int32, TimeSpan, IEnumerable<BrokeredMessage>)	执行 try receive 操作。
Peek()	在不更改接收方或消息源的状态的情况下读取下一条消息。 (继承自 MessageReceiver)
Peek(Int64)	在不更改接收方或消息源的状态的情况下读取下一条消息。 (继承自 MessageReceiver)
PeekAsync()	在不更改接收方或消息源的状态的情况下异步读取下一条消息。 (继承自 MessageReceiver)
PeekAsync(Int64)	在不更改接收方或消息源的状态的情况下异步读取下一条消息。 (继承自 MessageReceiver)
PeekBatch(Int32)	在不更改接收方或消息源的状态的情况下读取下一批消息。 (继承自 MessageReceiver)
PeekBatch(Int64, Int32)	在不更改接收方或消息源的状态的情况下读取下一批消息。 (继承自 MessageReceiver)
PeekBatchAsync(Int32)	在不更改接收方或消息源的状态的情况下异步读取下一批消息。 (继承自 MessageReceiver)
PeekBatchAsync(Int64, Int32)	在不更改接收方或消息源的状态的情况下异步读取下一批消息。 (继承自 MessageReceiver)
ProcessException(Exception)	表示一个消息会话，该会话允许对相关消息进行分组，以便在单个事务中进行处理。
Receive()	BrokeredMessage从当前队列或主题接收 。 (继承自 MessageReceiver)
Receive(Int64)	接收来自当前队列或主题的延迟消息。 此方法仅适用于延迟消息，不适用于常规消息。 (继承自 MessageReceiver)
Receive(TimeSpan)	BrokeredMessage从当前队列或主题接收 。 (继承自 MessageReceiver)
ReceiveAsync()	异步接收来自当前队列或主题的消息。 (继承自 MessageReceiver)
ReceiveAsync(Int64)	异步接收来自当前队列或主题的延迟消息。 此方法仅适用于延迟消息，不适用于常规消息。 (继承自 MessageReceiver)
ReceiveAsync(TimeSpan)	异步接收来自当前队列或主题的消息。 (继承自 MessageReceiver)
ReceiveBatch(IEnumerable<Int64>)	接收一批消息。 (继承自 MessageReceiver)
ReceiveBatch(Int32)	接收一批消息。 (继承自 MessageReceiver)
ReceiveBatch(Int32, TimeSpan)	接收一批消息。 (继承自 MessageReceiver)
ReceiveBatchAsync(IEnumerable<Int64>)	异步接收一批消息。 (继承自 MessageReceiver)
ReceiveBatchAsync(Int32)	异步接收一批消息。 (继承自 MessageReceiver)
ReceiveBatchAsync(Int32, TimeSpan)	异步接收一批消息。 (继承自 MessageReceiver)
RenewLock()	指定主机在消息上续订锁定的时间段。
RenewLockAsync()	指定主机在消息上续订锁定的时间段。
SetState(Stream)	设置消息会话的状态。
SetStateAsync(Stream)	异步设置消息会话的状态。
ThrowIfClosed()	表示一个消息会话，该会话允许对相关消息进行分组，以便在单个事务中进行处理。 (继承自 ClientEntity)
ThrowIfDisposed()	表示一个消息会话，该会话允许对相关消息进行分组，以便在单个事务中进行处理。 (继承自 ClientEntity)
ThrowIfDisposedOrImmutable()	表示一个消息会话，该会话允许对相关消息进行分组，以便在单个事务中进行处理。 (继承自 ClientEntity)
ThrowIfDisposedOrNotOpen()	表示一个消息会话，该会话允许对相关消息进行分组，以便在单个事务中进行处理。 (继承自 ClientEntity)
ThrowIfFaulted()	表示一个消息会话，该会话允许对相关消息进行分组，以便在单个事务中进行处理。 (继承自 ClientEntity)