Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/nanomsg/mangos-v1

The pure golang implementation of nanomsg (version 1, frozen)
https://github.com/nanomsg/mangos-v1

distributed golang nanomsg protocol transport

Last synced: 2 months ago
JSON representation

The pure golang implementation of nanomsg (version 1, frozen)

Awesome Lists containing this project

README 

        
## mangos 



[![Linux Status](https://img.shields.io/circleci/project/github/nanomsg/mangos.svg?label=linux)](https://circleci.com/gh/nanomsg/mangos)

[![Apache License](https://img.shields.io/badge/license-APACHE2-blue.svg)](https://github.com/nanomsg/mangos/blob/master/LICENSE)

[![Discord](https://img.shields.io/discord/639573728212156478?label=discord)](https://discord.gg/wewTkby)

[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](https://godoc.org/nanomsg.org/go-mangos)

[![Go Report Card](https://goreportcard.com/badge/nanomsg.org/go-mangos)](https://goreportcard.com/report/nanomsg.org/go-mangos)



> NOTE: This is the legacy version of mangos (v1).

> Users are encouraged to use [mangos v2](http://github.com/nanomsg/mangos)

> instead if possible.

> No further development is taking place on v1.



Package mangos is an implementation in pure Go of the SP

("Scalability Protocols")

messaging system.

This makes heavy use of go channels, internally, but it can operate

on systems that lack support for cgo.



The reference implementation of the SP protocols is available as

[nanomsg™](http://www.nanomsg.org); there is also an effort to implement

an improved and more capable version of nanomsg called

[NNG™](https://github.com/nanomsg/nng).



The design is intended to make it easy to add new transports with almost trivial

effort, as well as new topologies ("protocols" in SP terminology.)



At present, all of the Req/Rep, Pub/Sub, Pair, Bus, Push/Pull, and

Surveyor/Respondent patterns are supported.



Additionally, there is an experimental new pattern called STAR available.  This

pattern is like Bus, except that the messages are delivered not just to

immediate peers, but to all members of the topology.  Developers must be careful

not to create cycles in their network when using this pattern, otherwise

infinite loops can occur.



Supported transports include TCP, inproc, IPC, WebSocket, WebSocket over TLS and

TLS over TCP.

Use addresses of the form "tls+tcp://:" to access TLS.

Note that ipc:// is not supported on Windows (by either this or the reference

implementation.)  Forcing the local TCP port in Dial is not supported yet (this

is rarely useful).



Basic interoperability with nanomsg and NNG has been verified (you can do

so yourself with nanocat and macat) for all protocols and transports

that NNG and nanomsg support.

Additionally there are a number of projects that use the two products together.



There is a third party experimental QUIC transport available at

[quic-mangos](https://github.com/lthibault/quic-mangos).  (An RFE to make this

transport official exists.)



If you find this useful, I would appreciate knowing about it.  I can be reached

via my email address, garrett -at- damore -dot- org



## Installing



### Using *go get*



    $ go get -u nanomsg.org/go-mangos



After this command *mangos* is ready to use. Its source will be in:



    $GOPATH/src/pkg/nanomsg.org/go-mangos



You can use `go get -u -a` to update all installed packages.



## Documentation



For docs, see http://godoc.org/nanomsg.org/go-mangos or run:



    $ godoc nanomsg.org/go-mangos



## Testing



This package supports internal self tests, which can be run in

the idiomatic Go way.  (Note that most of the tests are in a test

subdirectory.)



    $ go test nanomsg.org/go-mangos/...



There are also internal benchmarks available:



    $ go test -bench=. nanomsg.org/go-mangos/test



## Commercial Support



[Staysail Systems, Inc.](mailto:[email protected]) offers

[commercial support](http://staysail.tech/support/mangos) for mangos.



## Examples



Some examples are posted in the directories under examples/

in this project.



These examples are rewrites (in Go) of Tim Dysinger's

[Getting Started with Nanomsg](http://nanomsg.org/gettingstarted/index.html).



godoc in the example directories will yield information about how to run

each example program.



Enjoy!



Copyright 2018 The Mangos Authors



mangos™, Nanomsg™ and NNG™ are [trademarks](http://nanomsg.org/trademarks.html) of Garrett D'Amore.