Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zeromq/netmq

A 100% native C# implementation of ZeroMQ for .NET
https://github.com/zeromq/netmq

dotnet dotnet-core messaging netmq zeromq

Last synced: 2 days ago
JSON representation

A 100% native C# implementation of ZeroMQ for .NET

Awesome Lists containing this project

README 

        



[![GitHub Actions CI](https://github.com/zeromq/netmq/actions/workflows/CI.yml/badge.svg)](https://github.com/zeromq/netmq/actions/workflows/CI.yml)

[![NetMQ NuGet version](https://img.shields.io/nuget/v/NetMQ.svg)](https://www.nuget.org/packages/NetMQ/)



NetMQ is a 100% native C# port of the lightweight messaging library ZeroMQ.



NetMQ extends the

standard socket interfaces with features traditionally provided by

specialised messaging middleware products. NetMQ sockets provide an

abstraction of asynchronous message queues, multiple messaging patterns,

message filtering (subscriptions), seamless access to multiple transport

protocols, and more.



## Installation



You can download NetMQ via [NuGet](https://nuget.org/packages/NetMQ/).



## Versions



Currently two versions are maintained 

Version 3 which is the stable version of NetMQ and version 4, version 4 is same as version 3 without obsolete code.

You can find both version on Nuget, for more information read the [Migrating-to-v4](https://github.com/zeromq/netmq/wiki/Migrating-to-v4).



This repository is for version 4, for version 3 go to: https://github.com/NetMQ/NetMQ3-x.



## Using / Documentation



Before using NetMQ, make sure to read the [ZeroMQ Guide](http://zguide.zeromq.org/).



The NetMQ documentation can be found at [netmq.readthedocs.org](http://netmq.readthedocs.org/en/latest/). Thanks to [Sacha Barber](http://www.codeproject.com/Members/Sacha-Barber) who agreed to do the documentation.



You can find NetMQ samples contributed by various users here: https://github.com/NetMQ/Samples



There are also a few blog posts available, which you can read about here:



+ [Somdoron's blog](http://somdoron.com/category/netmq/)

+ [Hello World](http://sachabarbs.wordpress.com/2014/08/19/zeromq-1-introduction/)

+ [The Socket Types](http://sachabarbs.wordpress.com/2014/08/21/zeromq-2-the-socket-types-2/)

+ [Socket Options/Identity and SendMore](http://sachabarbs.wordpress.com/2014/08/26/zeromq-3-socket-optionsidentity-and-sendmore/)

+ [Multiple Socket Polling](http://sachabarbs.wordpress.com/2014/08/27/zeromq-4-multiple-sockets-polling/)

+ [Sending From Multiple Sockets](https://sachabarbs.wordpress.com/2014/08/30/zeromq-sending-from-multiple-sockets/)

+ [Divide And Conquer](http://sachabarbs.wordpress.com/2014/09/01/zeromq-6-divide-and-conquer/)



Here is a simple example:



```csharp

using (var server = new ResponseSocket("@tcp://localhost:5556")) // bind

using (var client = new RequestSocket(">tcp://localhost:5556"))  // connect

{

    // Send a message from the client socket

    client.SendFrame("Hello");



    // Receive the message from the server socket

    string m1 = server.ReceiveFrameString();

    Console.WriteLine("From Client: {0}", m1);



    // Send a response back from the server

    server.SendFrame("Hi Back");



    // Receive the response from the client socket

    string m2 = client.ReceiveFrameString();

    Console.WriteLine("From Server: {0}", m2);

}

```



## Contributing



We need help, so if you have good knowledge of C# and ZeroMQ just grab one of the issues and add a pull request.

We are using [C4.1 process](http://rfc.zeromq.org/spec:22), so make sure you read this before.



Regarding coding standards, we are using C# coding styles, to be a little more specific: we are using `camelCase` for variables and fields (with `m_` prefix for instance members and `s_` for static fields) and `PascalCase` for methods, classes and constants. Make sure you are using 'Insert Spaces' and 4 for tab and indent size.



You can also help us by:



* Joining our [mailing list](https://groups.google.com/d/forum/netmq-dev?hl=en) and be an active member

* Writing tutorials in the github wiki

* Writing about the project in your blog (and add a pull request with a link to your blog at the bottom of this page)



## Consulting and Support

Name | Email | Website | Info

-----|-------|---------|-----

Doron Somech | [email protected] | http://somdoron.com | Founder and maintainer of NetMQ, expertise in Fintech and high performance scalable systems.



If you are providing support and consulting for NetMQ please make a pull request and add yourself to the list.



## Important note on backward compatibility 



Since version 3.3.07 NetMQ changed the number serialization from Little Endian to Big Endian to be compatible with ZeroMQ.

Any NetMQ version prior to 3.3.0.7 is not compatible with the new version. To support older versions you can set Endian option on a NetMQ socket to Little Endian,

however doing so will make it incompatible with ZeroMQ.



We recommend to update to the latest version and use Big Endian which is now the default behavior.



## Mailing list



You can join our mailing list [here](https://groups.google.com/d/forum/netmq-dev?hl=en). 



## Who owns NetMQ?



NetMQ is owned by all its authors and contributors. 

This is an open source project licensed under the LGPLv3. 

To contribute to NetMQ please read the [C4.1 process](http://rfc.zeromq.org/spec:22), it's what we use.

There are open issues in the issues tab that still need to be taken care of, feel free to pick one up and submit a patch to the project.



## Build Server



![Code Better](http://www.jetbrains.com/img/banners/Codebetter300x250.png)



[YouTrack by JetBrains - keyboard-centric bug tracker](http://www.jetbrains.com/youtrack)