IRISLIB database
RabbitMQClient Class Reference
Inheritance diagram for RabbitMQClient:
Collaboration diagram for RabbitMQClient:

Public Member Functions

_.Library.Status BindQueue (_.Library.String queueName, _.Library.String exchangeName, _.Library.String bindingKeys)
 Binds a queue to an exchange with the given bindingKeys, formatted as a comma-separated list. More...
 
_.Library.Status CreateExchange (_.Library.String exchangeName, _.Library.String exchangeType, _.Library.Boolean durable, _.Library.Boolean autoDelete)
 Creates an exchange with a name, type, and its attributes.
 
_.Library.Status CreateQueue (_.Library.String queueName, _.Library.Boolean durable, _.Library.Boolean exclusive, _.Library.Boolean autoDetect)
 Create a queue.
 
_.Library.Status DeleteExchange (_.Library.String exchangeName)
 Delete an exchange with the name.
 
_.Library.Status DeleteQueue (_.Library.String queueName)
 Delete a queue.
 
- Public Member Functions inherited from Client
_.Library.Status Close ()
 Close connections and release resources.
 
_.Library.Status Connect (_.Library.String jclientClass, _.Library.String settings, _.Library.String additionalClasspaths)
 Connect to gateway and instantiate Java messaging client.
 
_.Library.Status CreateQueueOrTopic (_.Library.String queueOrTopicName, _.Library.String settings)
 Applicable to all except JMS. More...
 
_.Library.Status DeleteQueueOrTopic (_.Library.String queueOrTopicName)
 Applicable to all except JMS.
 
_.Library.Status ReceiveMessage (_.Library.String queueOrTopicName, _.Library.ListOfObjects messages, _.Library.String settings)
 Applicable to all except SNS. More...
 
_.Library.Status SendMessage (_.External.Messaging.Message message)
 Applicable to all. More...
 
- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Client
_.External.Messaging.Client CreateClient (_.External.Messaging.Settings settings, _.Library.Status sc, _.Library.String additionalClasspaths)
 Factory method to create an instance of messaging client. More...
 
_.External.Messaging.JMSClient CreateJMSClient (_.Library.String settings, _.Library.Status sc, _.Library.String additionalClasspaths)
 Connects to JMS using the passed in settings JSON string. More...
 
_.External.Messaging.KafkaClient CreateKafkaClient (_.Library.String settings, _.Library.Status sc, _.Library.String additionalClasspaths)
 Connects to Kafka using the passed in settings JSON string. More...
 
_.External.Messaging.RabbitMQClient CreateRabbitMQClient (_.Library.String settings, _.Library.Status sc, _.Library.String additionalClasspaths)
 Connects to RabbitMQ using the passed in settings JSON string. More...
 
_.External.Messaging.SNSClient CreateSNSClient (_.Library.String settings, _.Library.Status sc, _.Library.String additionalClasspaths)
 Connects to SNS using the passed in settings JSON string. More...
 
_.External.Messaging.SQSClient CreateSQSClient (_.Library.String settings, _.Library.Status sc, _.Library.String additionalClasspaths)
 Connects to SQS using the passed in settings JSON string. More...
 
- Public Attributes inherited from Client
 gateway
 Connection to a Java Gateway. More...
 
 jclient
 Remote Java messaging client object. More...
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Member Function Documentation

◆ BindQueue()

_.Library.Status BindQueue ( _.Library.String  queueName,
_.Library.String  exchangeName,
_.Library.String  bindingKeys 
)

Binds a queue to an exchange with the given bindingKeys, formatted as a comma-separated list.


If there is a comma in a binding key, escape it using the backslash character: '\,'. Backslash characters can be escaped using another backslash character: '\'. Do not include a space after the comma, or the space will be included in the binding key.

For example, if you wanted to bind the queue to the exchange with keys:

  • keynumber1
  • key,number,2
  • key\number\3

Then the contents of the bindingKeys argument would be:

keynumber1,key\,number\,2,key\number\3