MessageQueueTask Класс

Определение

Пространство имен:

Microsoft.SqlServer.Dts.Tasks.MessageQueueTask

Сборка:

Microsoft.SqlServer.MSMQTask.dll

Содержит методы и свойства, используемые задачей очереди сообщений. Этот класс не наследуется.

public ref class MessageQueueTask sealed : Microsoft::SqlServer::Dts::Runtime::Task, Microsoft::SqlServer::Dts::Runtime::IDTSBreakpointSite, Microsoft::SqlServer::Dts::Runtime::IDTSComponentPersist, Microsoft::SqlServer::Dts::Tasks::MessageQueueTask::IMessageQueueTask

[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.messagequeuetask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MSMQTaskMessages), SamplesTag="SsisMessageQueueTask", TaskContact="Message Queue Task; Microsoft Corporation; SQL Server 2019; © 2019 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTaskUI, Microsoft.SqlServer.MSMQTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
public sealed class MessageQueueTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.IMessageQueueTask

[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.messagequeuetask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MSMQTaskMessages), SamplesTag="SsisMessageQueueTask", TaskContact="Message Queue Task; Microsoft Corporation; SQL Server 2019; © 2019 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.MessageQueueTask.MessageQueueTaskUI, Microsoft.SqlServer.MSMQTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
type MessageQueueTask = class
    inherit Task
    interface IDTSComponentPersist
    interface IMessageQueueTask
    interface IDTSBreakpointSite
    interface IDTSSuspend

Public NotInheritable Class MessageQueueTask
Inherits Task
Implements IDTSBreakpointSite, IDTSComponentPersist, IMessageQueueTask

Наследование

Object

DtsObject

Task

MessageQueueTask

Атрибуты

DtsTaskAttribute

Реализации

IDTSBreakpointSite IDTSComponentPersist IDTSSuspend IMessageQueueTask

Комментарии

Класс задачи Message Queue позволяет объекту отправлять и получать сообщения в или из очереди Message Queue (также известной как MSMQ). Участие в распределённых транзакциях разрешено при работе координатор распределенных транзакций (Майкрософт) (MSDTC). Один экземпляр задачи очереди сообщений либо отправляет одно сообщение в заданную очередь, либо получает одно сообщение из определённой очереди, а при необходимости ждёт его прибытия. Могут быть отправлены следующие типы сообщений:

• Строковое сообщение, которое придаётся как значение свойства.

• Сообщение файла данных, которое генерируется из содержимого определённого файла данных.

• Сообщение переменных, генерируемое из имён и значений одной или нескольких переменных SQL Server Integration Services.

Перечисление MQMessageType определяет, какой формат сообщения используется для конкретной задачи очереди сообщений.

Для получения дополнительной информации см. задачу очереди сообщений.

Чтобы они MessageQueueTask работали либо в API, либо в SSIS Designer, необходимо установить SQL Server Integration Services. Эта функция не будет работать, если установлен только SQL Server Data Tools (SSDT).

Important

При настройке задачи Message Queue для отправки сообщений можно использовать один из алгоритмов шифрования, которые сейчас поддерживаются в очереди сообщений — RC2 и RC4 — для шифрования сообщения. Оба этих алгоритма шифрования считаются сегодня криптографически слабыми по сравнению с новыми алгоритмами, которые служба очередей сообщений еще не поддерживает. Поэтому при отправке сообщений с помощью задачи «Очередь сообщений» необходимо тщательно учитывать требования криптографии.

Конструкторы

Имя	Описание
MessageQueueTask()	Инициализирует новый экземпляр класса MessageQueueTask.

Свойства

Имя	Описание
CurrentExecutingPackageID	Получает или устанавливает идентификатор текущего исполняемого пакета.
DataFileOverWritable	Получает или устанавливает булевое значение, которое показывает, может ли сообщение файла данных перезаписать существующий файл данных.
DebugMode	Получает или устанавливает булевое значение, которое указывает, находится ли объект в режиме отладки и следует ли вызвать OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) событие во время запуска.
DTSMessageLineageID	Получает или устанавливает идентификатор родословной сообщения.
DTSMessagePackageID	Получает или устанавливает идентификатор пакета, который является источником сообщения.
DTSMessageVersionID	Получает или устанавливает версию сообщения.
EncryptionAlgo	Получает или устанавливает имя алгоритма шифрования, используемого для шифрования тела сообщения приватного сообщения.
ErrorIfMessageTimeOut	Получает или устанавливает булевое значение, указывающее, не проходит ли задача при истечении времени сообщения.
ExecutionValue	Возвращает пользовательский объект. Это поле доступно только для чтения. (Унаследовано от Task)
MessageDataFile	Получает или задаёт имя файла данных, используемое при MessageType установке .DTSMQMessageType_DataFile
MessageString	Получает или устанавливает сообщение для использования, когда установлено MessageType на DTSMQMessageType_String.
MessageType	Получает или устанавливает значение, указывающее тип отправленного сообщения, когда TaskType .DTSMQType_Sender
MessageVariables	Получает или задаёт список переменных, когда MQMessageType перечисление установлено в DTSMQMessageType_Variables.
MsmqConnection	Получает или устанавливает имя соединения для задачи MSMQ.
OperationDescription	Получает или задаёт описание операции.
ReceiveMessageTimeOut	Получает или устанавливает значение, указывающее количество секунд до истечения времени на полученное сообщение.
ReceiveMessageType	Получает или устанавливает MQMessageType значение, указывающее тип сообщения для получения.
ReceiveVariableMessage	Получает или устанавливает имя переменной, в которой хранится сообщение.
RemoveFromQueue	Получает или устанавливает булевое изображение, которое указывает, следует ли удалить сообщение из очереди.
SaveDataFileName	Получает или устанавливает имя файла, в который сохраняется входящее сообщение Data File.
StringCompareType	Значение, задающее метод сравнения строк для типа сообщения String, когда TaskType .DTSMQType_Receiver
StringCompareValue	Получает или задаёт строку, с которой сравнивается сообщение строки, когда равна TaskTypeDTSMQType_Receiver.
StringMessageToVariableName	Получает или устанавливает имя переменной, в которую сохраняется содержимое сообщения.
SuspendRequired	Получает или устанавливает булевое значение, которое указывает, следует ли задаче приостановить при встрече с точкой остановки. Это значение задаётся движком выполнения для задач и контейнеров при обнаружении точки остановки.
TargetServerVersion	Содержит методы и свойства, используемые задачей очереди сообщений. Этот класс не наследуется. (Унаследовано от Task)
TaskType	Получает или устанавливает значение, указывающее, отправляется ли задача сообщения или принимает.
Use2000Format	Получает или устанавливает булевое значение, указывающее, что сообщение использует формат SQL Server 2000.
UseEncryption	Получает или устанавливает булевое значение, указывающее, использует ли сообщение шифрование.
Version	Член уходил из употребления; см. Примечания. Возвращает версию задачи. Это свойство доступно только для чтения. (Унаследовано от Task)

Методы

Имя	Описание
AcceptBreakpointManager(BreakpointManager)	Передаёт BreakpointManager задачу. Этот метод вызывается в среде выполнения и не используется в коде.
CanUpdate(String)	Член уходил из употребления; см. Примечания. Булевое значение, указывающее, может ли новый XML пакета обновлять старый XML пакета. (Унаследовано от Task)
Equals(Object)	Определяет, равны ли два экземпляра объекта. (Унаследовано от DtsObject)
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)	Выполняет задачу.
GetConnectionID(Connections, String)	Получает строку с идентификатором соединения. (Унаследовано от Task)
GetConnectionName(Connections, String)	Получает строку с названием соединения. (Унаследовано от Task)
GetHashCode()	Возвращает хэш-код для этого экземпляра. (Унаследовано от DtsObject)
InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)	Инициализирует свойства, связанные с задачей. Этот метод вызывается в среде выполнения и не используется в коде.
LoadFromXML(XmlElement, IDTSInfoEvents)	Этот метод не может быть вызван вашим кодом приложения. Чтобы загрузить пакет, сохранённый в формате XML (с расширением имени файлthe.xml а), используйте метод LoadPackage(String, IDTSEvents) .
ResumeExecution()	Выполнение задачи возобновляется после паузы. Выполнение задачи или контейнера возобновляется движком времени.
SaveToXML(XmlDocument, IDTSInfoEvents)	Этот метод не может быть вызван вашим кодом приложения. Чтобы сохранить посылку как .xml, используйте метод.SaveToXml(String, Package, IDTSEvents)
SuspendExecution()	Указывает, что исполняемый файл должен быть приостановлен. Этот метод вызывается движком времени выполнения.
Update(String)	Член уходил из употребления; см. Примечания. Этот метод обновляет XML старого пакета с новым XML пакета, если CanUpdate(String) установлен true. (Унаследовано от Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)	Проверяет, правильно ли настроена задача.