vice - GitLite

KO | EN

gitlite — search

#hacktoberfest #llm #deep-learning #linux #macos #windows #awesome #cli #kubernetes #awesome-list #vue #pytorch #ios #mcp

vice

(★ 1,539)

Go channels at horizontal scale (powered by message queues)

File Explorer

Download Latest Version (.zip)

- - ci.yaml
- backoff.go
- backoff_test.go
- design-patterns.md
- vicelogo-small.png
- vicelogo.jpg
- writing-transports.md
- - README.md
- - nats.go
  - nats_test.go
  - options.go
- - nsq.go
  - nsq_test.go
- - benchmark_rabbitmq_test.go
  - options.go
  - rabbitmq.go
  - rabbitmq_test.go
  - testing.md
- - options.go
  - redis.go
  - redis_test.go
  - test.sh
- - fakes.go
  - multi_writer.go
  - multi_writer_test.go
  - sqs.go
  - sqs_test.go
- README.md
- tools.go
- test.go
.gitignore
go.mod
go.sum
LICENSE
README.md
transport.go

# Installation Guide

1. Get the code

git clone https://github.com/matryer/vice

Downloads the entire project code from GitHub to your computer.

cd vice

Moves into the project folder you just downloaded.

2. Go

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Go The Go compiler and toolchain.

go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

✅ If the build finishes without errors, it worked. If you used go run ., check the terminal output.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![](https://raw.githubusercontent.com/matryer/vice/master/docs/vicelogo-small.png)

# Go channels at horizontal scale [![Build Status](https://travis-ci.org/matryer/vice.svg?branch=master)](https://travis-ci.org/matryer/vice)

* Use Go channels transparently over a [messaging queue technology of your choice](https://github.com/matryer/vice/tree/master/queues) (Currently [NATS](http://nats.io), [Redis](http://redis.io) or [NSQ](http://nsq.io), [Amazon SQS](https://aws.amazon.com/sqs/))
* Swap `vice.Transport` to change underlying queueing technologies transparently
* Write idiomatic Go code instead of learning queue specific APIs
* Develop against in-memory implementation before putting it into the wild
* Independent unit tests (no need for running queue technology)

PROJECT STATUS: [v1 released](https://github.com/matryer/vice/releases/tag/v1.0.0)

## Usage

This code receives names on the `|names|` queue, and sends greetings on the `|greetings|`
queue:

```go
// get a Go channel that will receive messages on the
// |names| queue
names := transport.Receive("names")

// get a Go channel that will send messages on the
// |greetings| queue
greetings := transport.Send("greetings")

// respond to |names| messages with |greetings|
for name := range names {
	greetings <- []byte("Hello " + string(name))
}
```

* The code above is illustrative, be sure to read the [design patterns](https://github.com/matryer/vice/blob/master/docs/design-patterns.md)
* Always stop the Transport, some technologies register and deregister their interest in the queues (this means trapping signals and gracefully shutting down services before exiting)
* Use `Send` and `Receive` methods to get channels, which you can then use as normal
* Be sure to always handle the `ErrChan()` error channel to make sure the underlying queue technology is healthy

## Quick start guide

* Write your services with unit tests using normal Go channels (see our [design patterns](https://github.com/matryer/vice/blob/master/docs/design-patterns.md))
* Install Vice with `go get github.com/matryer/vice/...`
* Select a [messaging queue technology](https://github.com/matryer/vice/tree/master/queues)
* Build a command to run your service

Read the blog post: [Introducing vice: Go channels across many machines](https://medium.com/@matryer/introducing-vice-go-channels-across-many-machines-bcac1147d7e2)

## Acknowledgements

Special thanks go to [David Hernandez](https://github.com/dahernan), [Jason Hancock](https://github.com/jasonhancock) and [Piotr Rojek](https://github.com/piotrrojek) for their support on this project.