redb.Route.IbmMq 2.0.2

Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
dotnet add package redb.Route.IbmMq --version 2.0.2
                    
NuGet\Install-Package redb.Route.IbmMq -Version 2.0.2
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="redb.Route.IbmMq" Version="2.0.2" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="redb.Route.IbmMq" Version="2.0.2" />
                    
Directory.Packages.props
<PackageReference Include="redb.Route.IbmMq" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add redb.Route.IbmMq --version 2.0.2
                    
#r "nuget: redb.Route.IbmMq, 2.0.2"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package redb.Route.IbmMq@2.0.2
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=redb.Route.IbmMq&version=2.0.2
                    
Install as a Cake Addin
#tool nuget:?package=redb.Route.IbmMq&version=2.0.2
                    
Install as a Cake Tool

redb.Route.IbmMq

IBM MQ (WebSphere MQ) transport for redb.Route ESB framework. Native MQI access via IBMMQDotnetClient — queues, topics, transactions, RPC, message groups, SSL/TLS, and W3C telemetry.

NuGet License: MIT

Installation

dotnet add package redb.Route.IbmMq

Quick Start

services.AddRedbRoute(route =>
{
    route.Services.AddRedbRouteIbmMq();
    route.AddRouteBuilder<MyRoutes>();
});
public class MyRoutes : RouteBuilder
{
    public override void Configure()
    {
        From("wmq:DEV.QUEUE.1?host=mq-host&queueManager=QM1&channel=DEV.APP.SVRCONN")
            .Log("Received: ${body}")
            .To("wmq:ORDERS.OUT?host=mq-host&queueManager=QM1&channel=DEV.APP.SVRCONN");
    }
}

URI Format

wmq:{destination}?{options}

{destination} — queue or topic name (e.g. DEV.QUEUE.1, EVENTS/ORDER).

Fluent DSL

// Queue (point-to-point)
From(Wmq.Queue("DEV.QUEUE.1")
    .Host("mq-host")
    .QueueManager("QM1")
    .Channel("DEV.APP.SVRCONN")
    .User("app")
    .Password("passw0rd"))

// Topic (pub/sub)
From(Wmq.Topic("EVENTS/ORDER")
    .Host("mq-host")
    .QueueManager("QM1")
    .ConcurrentConsumers(4))

// Persistent send with JMS interop
To(Wmq.Queue("ORDERS.OUT")
    .Host("mq-host")
    .Persistent()
    .TargetClient(IbmMqTargetClient.Jms))

// Transacted
From(Wmq.Queue("TXN.QUEUE")
    .Host("mq-host")
    .Transacted())

// RPC (request/reply)
To(Wmq.Queue("RPC.SERVICE")
    .Host("mq-host")
    .ReplyTo()
    .Timeout(10))

// SSL/TLS
From(Wmq.Queue("SECURE.QUEUE")
    .Host("mq-host")
    .SslCipherSpec("TLS_RSA_WITH_AES_256_CBC_SHA256")
    .SslKeyRepository("/var/mqm/ssl/key"))

Options Reference

Connection

Option Default Description
host localhost Queue manager host
port 1414 MQ listener port
channel DEV.APP.SVRCONN Server-connection channel
queueManager QM1 Queue manager name
user Auth username
password Auth password
clientId Client identifier
connectionFactory Named factory from DI

Destination

Option Default Description
destinationType Queue Queue or Topic

Consumer

Option Default Description
concurrentConsumers 1 Parallel consumers
waitInterval 5000 MQGET wait (ms)
batchSize 0 Batch size (0 = single)
backoutThreshold 0 Poison message threshold
backoutQueue Backout queue name
selector Message selector
convert true Apply MQGMO_CONVERT

Producer

Option Default Description
persistence AsQDef Persistent, NonPersistent, AsQDef
priority -1 Priority (0–9, -1 = queue default)
expiry -1 Expiry (tenths/sec, -1 = unlimited)
targetClient Jms Jms (with MQRFH2) or Mq (raw MQMD)
messageType Datagram Datagram, Request, Reply, Report

Transactions

Option Default Description
transacted false Local MQ transactions (MQCMIT/MQBACK)

RPC

Option Default Description
replyTo false Enable request/reply
replyToQueue Reply queue (or dynamic temp)
replyToQueueManager Reply QM
timeout 30 RPC timeout (seconds)
correlationPattern MsgId MsgId or CorrelId

Dead Letter

Option Default Description
deadLetterQueue DLQ name
maxRedeliveries 0 Max redeliveries

SSL/TLS

Option Default Description
sslCipherSpec CipherSpec name
sslCertLabel Certificate label
sslPeerName Peer DN pattern
sslKeyRepository Key repo path (.kdb)
sslKeyResetCount 0 Key renegotiation (bytes)

Advanced

Option Default Description
cCSID 1208 Coded Character Set ID
mqmdWriteEnabled false Write MQMD from headers
mqmdReadEnabled true Read MQMD into headers

Headers

All IBM MQ metadata headers are prefixed with redbIbmMq.:

  • redbIbmMq.MsgId — message ID (hex)
  • redbIbmMq.CorrelId — correlation ID (hex)
  • redbIbmMq.Format — MQMD format
  • redbIbmMq.Persistence — persistence flag
  • redbIbmMq.Priority — priority
  • redbIbmMq.Expiry — expiry
  • redbIbmMq.ReplyToQueue — reply-to queue
  • redbIbmMq.MsgType — message type
  • redbIbmMq.BackoutCount — backout count
  • ... and more (see IbmMqHeaders class)

Telemetry

W3C distributed tracing is automatically propagated via MQRFH2 user properties (traceparent, tracestate). OpenTelemetry tags:

  • messaging.system = ibmmq
  • messaging.operation = receive / publish
  • messaging.destination.name = queue/topic name
  • messaging.ibmmq.queue_manager = QM name
  • messaging.message.id = MQMD MsgId

Docker (Dev/Test)

docker compose -f docker-compose.tests.yml up -d ibmmq

Default dev credentials:

  • Host: localhost:1414
  • Queue Manager: QM1
  • Channel: DEV.APP.SVRCONN
  • User: app / passw0rd
  • Web Console: https://localhost:9443/ibmmq/console (admin / passw0rd)

Pre-created queues: DEV.QUEUE.1DEV.QUEUE.5, DEV.DEAD.LETTER.QUEUE.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
3.7.1 0 8/26/2026
3.6.0 85 8/13/2026
3.5.1 86 8/9/2026
3.5.0 92 8/6/2026
3.4.0 106 7/27/2026
3.3.3 103 7/16/2026
3.3.1 111 7/10/2026
3.3.0 103 7/8/2026
3.2.1 109 7/4/2026
3.2.0 107 6/29/2026
3.1.0 119 6/6/2026
3.0.1 122 6/3/2026
3.0.0 119 5/29/2026
2.0.2 121 5/16/2026
2.0.0 105 5/6/2026