Поделиться через


Класс MessageQueueTask

Contains the methods and properties used by the Message Queue task. This class cannot be inherited.

Иерархия наследования

System. . :: . .Object
  Microsoft.SqlServer.Dts.Runtime. . :: . .DtsObject
    Microsoft.SqlServer.Dts.Runtime. . :: . .Task
      Microsoft.SqlServer.Dts.Tasks.MessageQueueTask..::..MessageQueueTask

Пространство имен:  Microsoft.SqlServer.Dts.Tasks.MessageQueueTask
Сборка:  Microsoft.SqlServer.MSMQTask (в Microsoft.SqlServer.MSMQTask.dll)

Синтаксис

'Декларация
Public NotInheritable Class MessageQueueTask _
    Inherits Task _
    Implements IDTSComponentPersist, IMessageQueueTask, IDTSBreakpointSite, IDTSSuspend
'Применение
Dim instance As MessageQueueTask
public sealed class MessageQueueTask : Task, 
    IDTSComponentPersist, IMessageQueueTask, IDTSBreakpointSite, IDTSSuspend
public ref class MessageQueueTask sealed : public Task, 
    IDTSComponentPersist, IMessageQueueTask, IDTSBreakpointSite, IDTSSuspend
[<SealedAttribute>]
type MessageQueueTask =  
    class
        inherit Task
        interface IDTSComponentPersist
        interface IMessageQueueTask
        interface IDTSBreakpointSite
        interface IDTSSuspend
    end
public final class MessageQueueTask extends Task implements IDTSComponentPersist, IMessageQueueTask, IDTSBreakpointSite, IDTSSuspend

Тип MessageQueueTask обеспечивает доступ к следующим элементам.

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

  Имя Описание
Открытый метод MessageQueueTask Initializes a new instance of the MessageQueueTask class.

В начало

Свойства

  Имя Описание
Открытое свойство CurrentExecutingPackageID Gets or sets the ID of the current executing package.
Открытое свойство DataFileOverWritable Gets or sets a Boolean that indicates whether the data file message can overwrite an existing data file.
Открытое свойство DebugMode Gets or sets a Boolean that indicates whether the object is in debug mode, and whether it should raise the OnBreakpointHit event while running.
Открытое свойство DTSMessageLineageID Gets or sets the message lineage identifier.
Открытое свойство DTSMessagePackageID Gets or sets the identifier of the package that is the source of the message.
Открытое свойство DTSMessageVersionID Gets or sets the version of the message.
Открытое свойство EncryptionAlgo Gets or sets the name of the encryption algorithm used to encrypt the message body of a private message.
Открытое свойство ErrorIfMessageTimeOut Gets or sets a Boolean specifying whether the task fails when the message times out.
Открытое свойство ExecutionValue Returns a user-defined object. This field is read-only. (Производный от Task.)
Открытое свойство MessageDataFile Gets or sets the data file name used when the MessageType is set to DTSMQMessageType_DataFile.
Открытое свойство MessageString Gets or sets the message to use when the MessageType is set to DTSMQMessageType_String.
Открытое свойство MessageType Gets or sets a value that indicates the type of message being sent when the TaskType is DTSMQType_Sender.
Открытое свойство MessageVariables Gets or sets the variables list when the MQMessageType enumeration is set to DTSMQMessageType_Variables.
Открытое свойство MsmqConnection Gets or sets the name of the connection for the MSMQ task.
Открытое свойство OperationDescription Gets or sets the description of the operation.
Открытое свойство ReceiveMessageTimeOut Gets or sets a value that specifies the number of seconds before a received message times out.
Открытое свойство ReceiveMessageType Gets or sets an MQMessageType value that indicates the message type to receive.
Открытое свойство ReceiveVariableMessage Gets or sets the name of the variable in which to store the message.
Открытое свойство RemoveFromQueue Gets or sets a Boolean that specifies whether the message should be removed from the queue.
Открытое свойство SaveDataFileName Gets or sets the name of the file to which an incoming Data File message is saved.
Открытое свойство StringCompareType A value that specifies the string comparison method for a String message type when the TaskType is DTSMQType_Receiver.
Открытое свойство StringCompareValue Gets or sets the String to which a string message is compared to when the TaskType is DTSMQType_Receiver.
Открытое свойство StringMessageToVariableName Gets or sets the name of the variable to which the message contents are saved.
Открытое свойство SuspendRequired Gets or sets a Boolean that indicates if the task should suspend when it encounters a breakpoint. This value is set by the runtime engine for tasks and containers when a breakpoint is encountered.
Открытое свойство TaskType Gets or sets a value that indicates whether the message task is sending or receiving.
Открытое свойство Use2000Format Gets or sets a Boolean indicating that the message uses SQL Server 2000 format.
Открытое свойство UseEncryption Gets or sets a Boolean indicating whether the message uses encryption.
Открытое свойство Version *** Member deprecated; see Remarks. ***    Returns the version of the task. This property is read-only. (Производный от Task.)

В начало

Методы

  Имя Описание
Открытый метод AcceptBreakpointManager Passes a BreakpointManager to a task. This method is called by the runtime and is not used in code.
Открытый метод CanUpdate *** Member deprecated; see Remarks. ***    A Boolean that indicates whether the new package XML can update the old package XML. (Производный от Task.)
Открытый метод Equals Determines whether two object instances are equal. (Производный от DtsObject.)
Открытый метод Execute Runs the task. (Переопределяет Task. . :: . .Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).)
Защищенный метод Finalize (Производный от Object.)
Открытый метод GetConnectionID Gets a String containing the ID of the connection. (Производный от Task.)
Открытый метод GetConnectionName Gets a String containing the name of the connection. (Производный от Task.)
Открытый метод GetHashCode Returns the hash code for this instance. (Производный от DtsObject.)
Открытый метод GetType (Производный от Object.)
Открытый метод InitializeTask Initializes the properties associated with the task. This method is called by the runtime and is not used in code. (Переопределяет Task. . :: . .InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker).)
Открытый метод LoadFromXML This method is not callable by your application code. To load a package saved in XML format (with the.xml file name extension), use the Application..::..LoadPackage method.
Защищенный метод MemberwiseClone (Производный от Object.)
Открытый метод ResumeExecution Resumes execution of the task after pausing. Execution of the task or container is resumed by the runtime engine.
Открытый метод SaveToXML This method is not callable by your application code. To save a package as .xml, use the Application..::..SaveToXml method.
Открытый метод SuspendExecution Indicates that the executable needs to suspend. This method is called by the runtime engine.
Открытый метод ToString (Производный от Object.)
Открытый метод Update *** Member deprecated; see Remarks. ***    This method updates the old package XML with the new package XML if CanUpdate is set to true. (Производный от Task.)
Открытый метод Validate Verifies that the task is properly configured. (Переопределяет Task. . :: . .Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

В начало

Замечания

The Message Queue task class allows an object to send and receive messages to or from a queue of Message Queuing (also known as MSMQ). Participation in distributed transactions is allowed when running the Microsoft Distributed Transaction Coordinator (MSDTC). A single instance of a Message Queue task either sends one message to a specified queue or receives a single message from a specified queue, and also waits, if necessary, for the message to arrive. The following types of messages can be sent:

  • A string message, which is supplied as the value of a property.

  • A data file message, which is generated from the contents of a specified data file.

  • A variables message, which is generated from the names and values of one or more SQL Server Integration Services variables.

The enumeration MQMessageType determines which message format is used by a specific Message Queue task.

For more information, see Задача «Очередь сообщений».

For the MessageQueueTask to work in either the API or in SSIS Designer, you must install SQL Server Integration Services. This feature will not work if only Business Intelligence Development Studio is installed.

Важное примечаниеВажно!

When configuring the Message Queue task to send messages, you can use one of the encryption algorithms that are currently supported by the Message Queuing, RC2 and RC4, to encrypt the message. Both of these encryption algorithms are now considered cryptographically weak compared to newer algorithms, which Message Queuing does not yet support. Therefore, you should consider your cryptography needs carefully when sending messages using the Message Queue task.

Безопасность многопоточности

Любые открытые статический (Shared в Visual Basic) элементы этого типа потокобезопасны. Потокобезопасность с элементами экземпляров не гарантируется.