Compartir a través de

Clase MessageQueueTask

  • Artículo

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

Jerarquía de herencia

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

Espacio de nombres:  Microsoft.SqlServer.Dts.Tasks.MessageQueueTask
Ensamblado:  Microsoft.SqlServer.MSMQTask (en Microsoft.SqlServer.MSMQTask.dll)

Sintaxis

'Declaración
Public NotInheritable Class MessageQueueTask _
    Inherits Task _
    Implements IDTSComponentPersist, IMessageQueueTask, IDTSBreakpointSite, IDTSSuspend
'Uso
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

El tipo MessageQueueTask expone los siguientes miembros.

Constructores

  Nombre Descripción
Método público MessageQueueTask Initializes a new instance of the MessageQueueTask class.

Arriba

Propiedades

  Nombre Descripción
Propiedad pública CurrentExecutingPackageID Gets or sets the ID of the current executing package.
Propiedad pública DataFileOverWritable Gets or sets a Boolean that indicates whether the data file message can overwrite an existing data file.
Propiedad pública 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.
Propiedad pública DTSMessageLineageID Gets or sets the message lineage identifier.
Propiedad pública DTSMessagePackageID Gets or sets the identifier of the package that is the source of the message.
Propiedad pública DTSMessageVersionID Gets or sets the version of the message.
Propiedad pública EncryptionAlgo Gets or sets the name of the encryption algorithm used to encrypt the message body of a private message.
Propiedad pública ErrorIfMessageTimeOut Gets or sets a Boolean specifying whether the task fails when the message times out.
Propiedad pública ExecutionValue Returns a user-defined object. This field is read-only. (Se hereda de Task.)
Propiedad pública MessageDataFile Gets or sets the data file name used when the MessageType is set to DTSMQMessageType_DataFile.
Propiedad pública MessageString Gets or sets the message to use when the MessageType is set to DTSMQMessageType_String.
Propiedad pública MessageType Gets or sets a value that indicates the type of message being sent when the TaskType is DTSMQType_Sender.
Propiedad pública MessageVariables Gets or sets the variables list when the MQMessageType enumeration is set to DTSMQMessageType_Variables.
Propiedad pública MsmqConnection Gets or sets the name of the connection for the MSMQ task.
Propiedad pública OperationDescription Gets or sets the description of the operation.
Propiedad pública ReceiveMessageTimeOut Gets or sets a value that specifies the number of seconds before a received message times out.
Propiedad pública ReceiveMessageType Gets or sets an MQMessageType value that indicates the message type to receive.
Propiedad pública ReceiveVariableMessage Gets or sets the name of the variable in which to store the message.
Propiedad pública RemoveFromQueue Gets or sets a Boolean that specifies whether the message should be removed from the queue.
Propiedad pública SaveDataFileName Gets or sets the name of the file to which an incoming Data File message is saved.
Propiedad pública StringCompareType A value that specifies the string comparison method for a String message type when the TaskType is DTSMQType_Receiver.
Propiedad pública StringCompareValue Gets or sets the String to which a string message is compared to when the TaskType is DTSMQType_Receiver.
Propiedad pública StringMessageToVariableName Gets or sets the name of the variable to which the message contents are saved.
Propiedad pública 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.
Propiedad pública TaskType Gets or sets a value that indicates whether the message task is sending or receiving.
Propiedad pública Use2000Format Gets or sets a Boolean indicating that the message uses SQL Server 2000 format.
Propiedad pública UseEncryption Gets or sets a Boolean indicating whether the message uses encryption.
Propiedad pública Version *** Member deprecated; see Remarks. ***    Returns the version of the task. This property is read-only. (Se hereda de Task.)

Arriba

Métodos

  Nombre Descripción
Método público AcceptBreakpointManager Passes a BreakpointManager to a task. This method is called by the runtime and is not used in code.
Método público CanUpdate *** Member deprecated; see Remarks. ***    A Boolean that indicates whether the new package XML can update the old package XML. (Se hereda de Task.)
Método público Equals Determines whether two object instances are equal. (Se hereda de DtsObject.)
Método público Execute Runs the task. (Invalida Task.Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).)
Método público GetConnectionID Gets a String containing the ID of the connection. (Se hereda de Task.)
Método público GetConnectionName Gets a String containing the name of the connection. (Se hereda de Task.)
Método público GetHashCode Returns the hash code for this instance. (Se hereda de DtsObject.)
Método público GetType (Se hereda de Object.)
Método público InitializeTask Initializes the properties associated with the task. This method is called by the runtime and is not used in code. (Invalida Task.InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker).)
Método público 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.
Método público ResumeExecution Resumes execution of the task after pausing. Execution of the task or container is resumed by the runtime engine.
Método público SaveToXML This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
Método público SuspendExecution Indicates that the executable needs to suspend. This method is called by the runtime engine.
Método público ToString (Se hereda de Object.)
Método público Update *** Member deprecated; see Remarks. ***    This method updates the old package XML with the new package XML if CanUpdate is set to true. (Se hereda de Task.)
Método público Validate Verifies that the task is properly configured. (Invalida Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

Arriba

Comentarios

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 Tarea Cola de mensajes.

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 SQL Server Data Tools (SSDT) is installed.

Nota importanteImportante

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.

Seguridad para subprocesos

Cualquier miembro público static (Shared en Visual Basic) de este tipo es seguro para subprocesos. No se garantiza que los miembros de instancia sean seguros para subprocesos.

Vea también

Referencia

Espacio de nombres Microsoft.SqlServer.Dts.Tasks.MessageQueueTask