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

Комментарии

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

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

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

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

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

Дополнительные сведения см. в разделе "Задача очереди сообщений".

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

Важно!

При настройке задачи "Очередь сообщений" для отправки сообщений можно использовать один из алгоритмов шифрования, которые в настоящее время поддерживаются очередью сообщений, 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	Возвращает или задает имя файла, в котором сохраняется входящее сообщение файла данных.
StringCompareType	Значение, указывающее метод сравнения строк для типа сообщения String при значении TaskTypeDTSMQType_Receiver.
StringCompareValue	Возвращает или задает строку, с которой сравнивается строковое сообщение, если TaskType значение равно DTSMQType_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 (в файле с расширением 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)	Проверяет, правильно ли настроена задача.