memq

README

memq

A simple thread-safe in-memory message broker fo Go.

Quick Start

1. Get it:

   go get github.com/sergeykonkin/memq
   

2. Use it:

   // Import:
   import (
       "github.com/sergeykonkin/memq"
   )
   
   // Create new Broker:
   b := memq.NewBroker()
   
   // Subscribe to topic:
   b.Subscribe("my-topic", func(msg interface{}) {
       fmt.Printf("New message: %v", msg)
   })
   
   // Publish to topic:
   b.Publish("my-topic", "Hello World!")
   
   // You can also save a subscription to unsubscribe later:
   sub := b.Subscribe("my-topic", anotherHandler)
   defer sub.Unsubscribe()
   

Note that for now Broker supports only fan-out mode, so if there are 2 or more subscribers for a topic - they all will be receiving new messages.

License

MIT

Documentation

Index

• type Broker
  • func NewBroker() Broker
• type Subscription

Types

type Broker

type Broker interface {
	// Publish publishes a message to a topic.
	// The message is delivered to all subscribers of the topic.
	Publish(topic string, msg interface{})
	// Subscribe subscribes to a topic.
	// The handler is called for each message published to the topic.
	// The returned Subscription can be used to unsubscribe from the topic.
	Subscribe(topic string, handler func(interface{})) Subscription
}

Broker handles topics, subscriptions and message delivery.

func NewBroker

func NewBroker() Broker

NewBroker creates a new Broker. The returned Broker is safe for concurrent use by multiple goroutines.

type Subscription

type Subscription interface {
	// Unsubscribe unsubscribes from a topic.
	Unsubscribe()
}

Subscription handles unsubscribing from a topic.