Export (0) Print
Expand All

InterfaceQueuingAttribute Class

Enables queuing support for the marked interface. This class cannot be inherited.

System.Object
  System.Attribute
    System.EnterpriseServices.InterfaceQueuingAttribute

Namespace:  System.EnterpriseServices
Assembly:  System.EnterpriseServices (in System.EnterpriseServices.dll)

[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Interface, Inherited = true, 
	AllowMultiple = true)]
[ComVisibleAttribute(false)]
public sealed class InterfaceQueuingAttribute : Attribute

The InterfaceQueuingAttribute type exposes the following members.

  NameDescription
Public methodInterfaceQueuingAttribute()Initializes a new instance of the InterfaceQueuingAttribute class setting the Enabled and Interface properties to their default values.
Public methodInterfaceQueuingAttribute(Boolean)Initializes a new instance of the InterfaceQueuingAttribute class, optionally disabling queuing support.
Top

  NameDescription
Public propertyEnabledGets or sets a value indicating whether queuing support is enabled.
Public propertyInterfaceGets or sets the name of the interface on which queuing is enabled.
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top

  NameDescription
Public methodEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate method_Attribute.GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.InvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top

Calls on this interface will be queued using Message Queuing.

To mark an interface as queued, apply this attribute to the interface using the following syntax: [InterfaceQueuing].

The member methods of a queued interface must fulfill the requirements for queued method calls, such as having no out or ref parameters.

For more information about using attributes, see Extending Metadata Using Attributes.

The following code example shows how to use the InterfaceQueuingAttribute attribute.

public interface IQueuedComponent
{
    void QueuedTask();
}
// Mark IQueuedComponent interface as queued
[InterfaceQueuing(true, Interface="IQueuedComponent")]
// Create the queued component class by inheriting the  
// System.EnterpriseServices.ServicedComponent class and an 
// interface that is marked as queued with the InterfaceQueuing attribute 
public class QueuedComponent : ServicedComponent, IQueuedComponent
{
    public void QueuedTask()
    {
        // Perform queued task here
    }
}

The following code example shows how to mark a COM+ application as queued at compile time by using the ApplicationQueuing attribute, and enable the COM+ listener by setting the QueueListenerEnabled to true

// Mark the COM+ application as queued at compile time by using the  
// ApplicationQueuing attribute. Enable the COM+ listener by  
// setting the QueueListenerEnabled to true
[assembly: ApplicationQueuing(Enabled=true, QueueListenerEnabled=true)]

The following code example shows how to use BindToMoniker to run the queued moniker, to get an instance of the recorder, call the method that will be recorded, and force the release of the recorder object, to send the message to the queue.

// Use BindToMoniker to run the queued moniker, to get an instance of the recorder
IQueuedComponent qc = 
    (IQueuedComponent)System.Runtime.InteropServices.Marshal.BindToMoniker("queue:/new:QueuedComponent");
// Call the method that will be recorded
qc.QueuedTask();

// Force the release of the recorder object, to send the message to the queue
System.Runtime.InteropServices.Marshal.ReleaseComObject(qc);

.NET Framework

Supported in: 4.5.3, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft