Class ActiveMQDestination
  
  Summary description for ActiveMQDestination.
    Inheritance
    System.Object
    
    ActiveMQDestination
      
      
      
   
  
    Implements
    
    System.ICloneable
    Apache.NMS.IDestination
    System.IDisposable
   
  
    Inherited Members
    
    
    
    
    
    
    
    
    
    
      System.Object.Equals(System.Object, System.Object)
    
    
      System.Object.GetType()
    
    
      System.Object.MemberwiseClone()
    
    
      System.Object.ReferenceEquals(System.Object, System.Object)
    
   
  
  Assembly: Apache.NMS.ActiveMQ.dll
  Syntax
  
    public abstract class ActiveMQDestination : BaseDataStructure, DataStructure, ICloneable, IDestination, IDisposable
   
  Constructors
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  ActiveMQDestination()
  
  
  Declaration
  
    protected ActiveMQDestination()
   
  
    |
    Improve this Doc
  
  
    View Source
  
  
  ActiveMQDestination(String)
  Construct the Destination with a defined physical name;
Declaration
  
    protected ActiveMQDestination(string name)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | System.String | name |  | 
    
  
  Fields
  
  
    |
    Improve this Doc
  
  
    View Source
  
  ACTIVEMQ_QUEUE
  
  
  Declaration
  
    public const int ACTIVEMQ_QUEUE = 3
   
  Field Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Int32 |  | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  ACTIVEMQ_TEMPORARY_QUEUE
  Temporary Queue Destination object
Declaration
  
    public const int ACTIVEMQ_TEMPORARY_QUEUE = 4
   
  Field Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Int32 |  | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  ACTIVEMQ_TEMPORARY_TOPIC
  Temporary Topic Destination object
Declaration
  
    public const int ACTIVEMQ_TEMPORARY_TOPIC = 2
   
  Field Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Int32 |  | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  ACTIVEMQ_TOPIC
  
  
  Declaration
  
    public const int ACTIVEMQ_TOPIC = 1
   
  Field Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Int32 |  | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  ADVISORY_PREFIX
  prefix for Advisory message destinations
Declaration
  
    public const string ADVISORY_PREFIX = "ActiveMQ.Advisory."
   
  Field Value
  
    
      
        | Type | Description | 
    
    
      
        | System.String |  | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  CONNECTION_ADVISORY_PREFIX
  prefix for connection advisory destinations
Declaration
  
    public const string CONNECTION_ADVISORY_PREFIX = "ActiveMQ.Advisory.Connections."
   
  Field Value
  
    
      
        | Type | Description | 
    
    
      
        | System.String |  | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  CONSUMER_ADVISORY_PREFIX
  prefix for consumer advisory destinations
Declaration
  
    public const string CONSUMER_ADVISORY_PREFIX = "ActiveMQ.Advisory.Consumers."
   
  Field Value
  
    
      
        | Type | Description | 
    
    
      
        | System.String |  | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  DEFAULT_ORDERED_TARGET
  The default target for ordered destinations
Declaration
  
    public const string DEFAULT_ORDERED_TARGET = "coordinator"
   
  Field Value
  
    
      
        | Type | Description | 
    
    
      
        | System.String |  | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  PRODUCER_ADVISORY_PREFIX
  prefix for producer advisory destinations
Declaration
  
    public const string PRODUCER_ADVISORY_PREFIX = "ActiveMQ.Advisory.Producers."
   
  Field Value
  
    
      
        | Type | Description | 
    
    
      
        | System.String |  | 
    
  
  Properties
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  DestinationType
  
  
  Declaration
  
    public abstract DestinationType DestinationType { get; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | Apache.NMS.DestinationType |  | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  IsComposite
  Returns true if this destination represents a collection of
destinations; allowing a set of destinations to be published to or subscribed
from in one NMS operation.
If this destination is a composite then you can call {@link #getChildDestinations()}
to return the list of child destinations.
Declaration
  
    public bool IsComposite { get; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Boolean |  | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  IsQueue
  
  
  Declaration
  
    public bool IsQueue { get; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Boolean |  | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  IsTemporary
  
  
  Declaration
  
    public bool IsTemporary { get; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Boolean |  | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  IsTopic
  
  
  Declaration
  
    public bool IsTopic { get; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.Boolean |  | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  PhysicalName
  
  
  Declaration
  
    public string PhysicalName { get; set; }
   
  Property Value
  
    
      
        | Type | Description | 
    
    
      
        | System.String |  | 
    
  
  Methods
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  Clone()
  
  
  Declaration
  
    public override object Clone()
   
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Object |  | 
    
  
  Overrides
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  CompareTo(ActiveMQDestination)
  Lets sort by name first then lets sort topics greater than queues
Declaration
  
    public int CompareTo(ActiveMQDestination that)
   
  Parameters
  
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Int32 | 1 if this is less than o else 0 if they are equal or -1 if this is less than o | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  CompareTo(Object)
  
  
  Declaration
  
    public int CompareTo(object o)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | System.Object | o | object to compare | 
    
  
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Int32 | 1 if this is less than o else 0 if they are equal or -1 if this is less than o | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  CreateDestination(Int32, String)
  
  
  Declaration
  
    public static ActiveMQDestination CreateDestination(int type, string pyhsicalName)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | System.Int32 | type |  | 
      
        | System.String | pyhsicalName |  | 
    
  
  Returns
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  CreateDestination(String)
  Factory method to create a child destination if this destination is a composite
Declaration
  
    public abstract ActiveMQDestination CreateDestination(string name)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | System.String | name |  | 
    
  
  Returns
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  CreateTemporaryName(String)
  Create a temporary name from the clientId
Declaration
  
    public static string CreateTemporaryName(string clientId)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | System.String | clientId |  | 
    
  
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.String |  | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  Dispose()
  
  
  Declaration
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  Equals(Object)
  if the object passed in is equivalent, return true
Declaration
  
    public override bool Equals(object obj)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | System.Object | obj | the object to compare | 
    
  
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Boolean | true if this instance and obj are equivalent | 
    
  
  Overrides
  System.Object.Equals(System.Object)
  
    |
    Improve this Doc
  
  
    View Source
  
  
  GetClientId(ActiveMQDestination)
  From a temporary destination find the clientId of the Connection that created it
Declaration
  
    public static string GetClientId(ActiveMQDestination destination)
   
  Parameters
  
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.String | the clientId or null if not a temporary destination | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  GetCompositeDestinations()
  
  
  Declaration
  
    public ActiveMQDestination[] GetCompositeDestinations()
   
  Returns
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  GetDestinationType()
  
  
  Declaration
  
    public abstract int GetDestinationType()
   
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Int32 | Returns the Destination type | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  GetDestinationTypeAsString()
  Gets the Destination Type of this Destination as a String value which is one
of {Queue,Topic,TempQueue,TempTopic}.
Declaration
  
    public string GetDestinationTypeAsString()
   
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.String | The Destination Type as a String. | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  GetHashCode()
  
  
  Declaration
  
    public override int GetHashCode()
   
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Int32 | hashCode for this instance | 
    
  
  Overrides
  System.Object.GetHashCode()
  
    |
    Improve this Doc
  
  
    View Source
  
  
  GetOrderedTarget()
  
  
  Declaration
  
    public string GetOrderedTarget()
   
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.String | Returns the orderedTarget. | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  Inspect(ActiveMQDestination)
  A helper method to return a descriptive string for the topic or queue
Declaration
  
    public static string Inspect(ActiveMQDestination destination)
   
  Parameters
  
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.String | a descriptive string for this queue or topic | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  IsAdvisory()
  
  
  Declaration
  
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Boolean | Returns the advisory. | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  IsConnectionAdvisory()
  
  
  Declaration
  
    public bool IsConnectionAdvisory()
   
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Boolean | true if this is a destination for Connection advisories | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  IsConsumerAdvisory()
  
  
  Declaration
  
    public bool IsConsumerAdvisory()
   
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Boolean | true if this is a destination for Consumer advisories | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  IsExclusive()
  
  
  Declaration
  
    public bool IsExclusive()
   
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Boolean | Returns the exclusive. | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  IsOrdered()
  
  
  Declaration
  
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Boolean | Returns the ordered. | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  IsProducerAdvisory()
  
  
  Declaration
  
    public bool IsProducerAdvisory()
   
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Boolean | true if this is a destination for Producer advisories | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  IsWildcard()
  
  
  Declaration
  
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.Boolean | true if the destination matches multiple possible destinations | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  SetAdvisory(Boolean)
  
  
  Declaration
  
    public void SetAdvisory(bool advisory)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | System.Boolean | advisory | The advisory to set. | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  SetExclusive(Boolean)
  
  
  Declaration
  
    public void SetExclusive(bool exclusive)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | System.Boolean | exclusive | The exclusive to set. | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  SetOrdered(Boolean)
  
  
  Declaration
  
    public void SetOrdered(bool ordered)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | System.Boolean | ordered | The ordered to set. | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  SetOrderedTarget(String)
  
  
  Declaration
  
    public void SetOrderedTarget(string orderedTarget)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | System.String | orderedTarget | The orderedTarget to set. | 
    
  
  
    |
    Improve this Doc
  
  
    View Source
  
  
  ToString()
  
  
  Declaration
  
    public override string ToString()
   
  Returns
  
    
      
        | Type | Description | 
    
    
      
        | System.String | string representation of this instance | 
    
  
  Overrides
  System.Object.ToString()
  
    |
    Improve this Doc
  
  
    View Source
  
  
  
  
  
  Declaration
  
    public static ActiveMQDestination Transform(IDestination destination)
   
  Parameters
  
    
      
        | Type | Name | Description | 
    
    
      
        | Apache.NMS.IDestination | destination |  | 
    
  
  Returns
  
  Implements
  
  
      System.ICloneable
  
  
      Apache.NMS.IDestination
  
  
      System.IDisposable