NMS Documentation

API Overview

The NMS API (.Net Message Service API) provides a standard .NET interface to Messaging Systems. There are multiple implementations for different providers. The NMS API allows you to build .NET applications in C#, VB, or any other .NET language, using a single API to connect to multiple different providers using a JMS style API.

NMS API currently supports all of the features of JMS in a simple pure C# API and implementation apart from XA. Current features include:

  • creating & disposing of connections, sessions, producers, consumers
  • sending of messages to topics, queues with durable or non durable along with temporary destination support
  • synchronous consuming (blocking receive, receive with no wait or receive with a timeout)
  • asynchronous consuming (adding a MessageListener to be dispatched in the thread pool)
  • message header support along with custom properties
  • Text, Bytes, Stream and Map message support
  • support for transactions (sending and acknowledging multiple messages in an atomic transaction)
  • redelivery of messages in rollbacks up to some configured maximum redelivery count
  • Optional Queue browser interface for providers that can support it.
  • Optional .NET Distributed Transaction Support for providers that can support that.

  • API
  • API Downloads
  • Providers
  • Examples
  • URI Configuration

Providers

An NMS Provider is a .NET Assembly that provides an implementation of the NMS API that provides connectivity with a particular Messaging Service or an implementation of a standard Messaging Protocol. Currently, the following providers are available:

  • AMQP provides support for AMQP 1.0 protocol. Compatible with ActiveMQ 5.x, ActiveMQ Artemis and any other AMQP 1.0 compliant broker.
  • ActiveMQ (OpenWire) client which communicates with ActiveMQ 5.x using its own native wire protocol and provides many advanced features beyond the standard NMS API.
  • Other providers Older providers.

Examples

This is where you will find examples of how to use the NMS API. These examples demonstrate using the NMS API generically and are limited to features exposed directly through the API model. For examples covering more advanced features of a specific NMS Provider, refer to the documentation for that NMS Provider.

Apache, ActiveMQ, Apache ActiveMQ, the Apache feather logo, and the Apache ActiveMQ project logo are trademarks of The Apache Software Foundation. Copyright © 2024, The Apache Software Foundation. Licensed under Apache License 2.0.