Tago.Queues.Connectors.Ibm.Mq 2.2.3-preview-20230922-001

Tago.Extensions.Mq Documentation

Table of Contents

1. Introduction
2. Getting Started
   • Installation
   • Quick Start
   • Configuration
3. Usage
4. Author Information

Introduction

"Tago.Extensions.Mq" is a wrapper for IBM MQ, designed to simplify and streamline the interaction with IBM MQ messaging systems within your .NET applications.

Target Audience

The primary audience for this documentation and the utility includes .NET developers and system administrators.

Getting Started

Installation

To use "Tago.Extensions.Mq" in your .NET project, you can install it via NuGet Package Manager or the .NET CLI.

dotnet add package Tago.Queues.Connectors.Ibm.Mq

Quick Start

To quickly get started with "Tago.Extensions.Mq," follow these steps:

• Import the necessary namespaces.
• Create an instance of the MqConnector class.
• Configure the connection to your IBM MQ server.
• Send and receive messages.

Configuration

You can customize the behavior of the IBM MQ Connector Wrapper by configuring the following options...

appsetting.json

{
	"Queues": {
	  "Readers": {
		"Queue1": {
		  "CodePage": 65001,
		  "Enabled": true,
		  "ExtendedProperties": {
			"ReplyToQueueKey": "Queue1"
		  },
		  "Description": "Test",
		  "CharacterSetLookup": {
			"1208": 65001
		  }
		  "ConnectionStrings": [
			"server=127.0.0.1.158:1414,channel=DEV.APP.SVRCONN,manager=QM1,queue=DEV.QUEUE.1"
		  ],
		  "Security": {
			"UserId": "app",
			"Pwd": "passw0rd"        
		  }
		},
		"Queue2": {
		  "CodePage": 65001,
		  "Enabled": true,      
		  "Description": "Test",
		  "CharacterSetLookup": {
			"1208": 65001
		  },
		  "ConnectionStrings": [
			"server=127.0.0.1.158:1414,channel=DEV.APP.SVRCONN,manager=QM1,queue=DEV.QUEUE.2"
		  ],
		  "Security": {
			"UserId": "app",
			"Pwd": "passw0rd"
		  }
		}
	  },
	  "Writers": {
		"MyWriter": {
		  "CodePage": 65001,
		  "Enabled": true,        
		  "Description": "Test",
		  "ExtendedProperties": {
			"TestProp": "Queue1"
		  }
		  "ConnectionStrings": [
			"server=127.0.0.1:1414,channel=DEV.APP.SVRCONN,manager=QM1,queue=DEV.QUEUE.1"
		  ],
		  "Security": {
			"UserId": "app",
			"Pwd": "passw0rd"       
		  }
		},
		"3rdParty": {
		  "CodePage": 65001,
		  "Enabled": true,
		  "Description": "Test",
		  "ExtendedProperties": {
			"TestProp": "Queue1"
		  },
		  "ConnectionStrings": [
			"server=127.0.0.1.158:1414,channel=DEV.APP.SVRCONN,manager=QM1,queue=DEV.QUEUE.2"
		  ],
		  "Security": {
			"UserId": "app",
			"Pwd": "passw0rd"
		  }
		}
	  }
	}
}

Usage

Dependency injection

MqQueuesSettings queuesSettings = new MqQueuesSettings();
configuration.GetSection("Queues").Bind(queuesSettings);

services.AddMqServices();

services.AddMqReaders(queuesSettings?.Readers);
services.AddMqWriters(queuesSettings?.Writers);

Sending a Message

var factory = serviceProvider.GetService<IMessageQueueFactory>();
var writer = factory.GetWriter("3rdParty");
MQMessage msg = new MQMessage();
.....
var res = await writer.SendAsync(msg);

Receiving a Message

var factory = serviceProvider.GetService<IMessageQueueFactory>();
var reader = factory.GetReader("Queue1");
var res = await reader.ReceiveAsync();

Conclusion

Thank you for exploring the documentation for Tago.Extensions.Mq. We hope this guide has provided you with the information and resources needed to effectively integrate and utilize our IBM MQ Connector Wrapper in your .NET projects.

As you embark on your journey with Tago.Extensions.Mq, please remember that our commitment to enhancing and supporting this utility remains steadfast. Your feedback, contributions, and insights are invaluable to us as we strive to make this tool even more powerful and user-friendly.

Should you encounter any challenges, have questions, or wish to contribute to the project's development, we encourage you to reach out to us. Your engagement is key to the continued success of Tago.Extensions.Mq.

We look forward to seeing the remarkable applications and solutions you create with the help of our IBM MQ Connector Wrapper. Happy coding!

Author Information

• Author: Golan Sheetrit
• Email: support@tago-solutions.com