pubsub

package
v0.9.113 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 26, 2020 License: MIT Imports: 2 Imported by: 101

README

Pub Sub

Pub Subs provide a common way to interact with different message bus implementations to achieve reliable, high-scale scenarios based on event-driven async communications, while allowing users to opt-in to advanced capabilities using defined metadata.

Currently supported pub-subs are:

  • Hazelcast
  • Redis Streams
  • NATS
  • Kafka
  • Azure Service Bus
  • RabbitMQ
  • Azure Event Hubs
  • GCP Pub/Sub
  • MQTT

Implementing a new Pub Sub

A compliant pub sub needs to implement the following interface:

type PubSub interface {
	Init(metadata Metadata) error
	Publish(req *PublishRequest) error
	Subscribe(req SubscribeRequest, handler func(msg *NewMessage) error) error
}

Documentation

Index

Constants

View Source 
const (
	// DefaultCloudEventType is the default event type for an Dapr published event
	DefaultCloudEventType = "com.dapr.event.sent"
	// CloudEventsSpecVersion is the specversion used by Dapr for the cloud events implementation
	CloudEventsSpecVersion = "0.3"
	//ContentType is the Cloud Events HTTP content type
	ContentType = "application/cloudevents+json"
	// DefaultCloudEventSource is the default event source
	DefaultCloudEventSource = "Dapr"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type CloudEventsEnvelope 

type CloudEventsEnvelope struct {
	ID              string      `json:"id"`
	Source          string      `json:"source"`
	Type            string      `json:"type"`
	SpecVersion     string      `json:"specversion"`
	DataContentType string      `json:"datacontenttype"`
	Data            interface{} `json:"data"`
	Subject         string      `json:"subject"`
	Topic           string      `json:"topic"`
}

CloudEventsEnvelope describes the Dapr implementation of the Cloud Events spec Spec details: https://github.com/cloudevents/spec/blob/master/spec.md

func NewCloudEventsEnvelope 

func NewCloudEventsEnvelope(id, source, eventType, subject string, topic string, data []byte) *CloudEventsEnvelope

NewCloudEventsEnvelope returns CloudEventsEnvelope from data or a new one when data content was not

type Metadata 

type Metadata struct {
	Properties map[string]string `json:"properties"`
}

Metadata represents a set of message-bus specific properties

type NewMessage 

type NewMessage struct {
	Data  []byte `json:"data"`
	Topic string `json:"topic"`
}

NewMessage is an event arriving from a message bus instance

type PubSub 

type PubSub interface {
	Init(metadata Metadata) error
	Publish(req *PublishRequest) error
	Subscribe(req SubscribeRequest, handler func(msg *NewMessage) error) error
}

PubSub is the interface for message buses

type PublishRequest 

type PublishRequest struct {
	Data  []byte `json:"data"`
	Topic string `json:"topic"`
}

PublishRequest is the request to publish a message

type SubscribeRequest 

type SubscribeRequest struct {
	Topic string `json:"topic"`
}

SubscribeRequest is the request to subscribe to a topic

Source Files

View all Source files

Directories

Path Synopsis
aws
snssqs
azure
eventhubs
servicebus
gcp
pubsub
Package natsstreaming implements NATS Streaming pubsub component
 Package natsstreaming implements NATS Streaming pubsub component

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.