suburl

Documentation

Overview

Package suburl provides a generic URL based interface for obtaining substrate source and sink objects.

Usage

An example of obtaining a nats streaming source is shown below.

source, err := suburl.NewSource("nats-streaming://localhost:4222/my-subject?cluster-id=foo&consumer-id=bar")
if err != nil {
        // error handling
}
defer source.Close()

// use source here

Here is an example of obtaining a kafka sink.

sink, err := suburl.NewSink("kafka://localhost:9092/my-topic/?broker=localhost%3A9092&broker=localhost%3A9092")
if err != nil {
        // error handling
}
defer sink.Close()

// use sink here

To use a particular url scheme, the driver has to be registered, for example:

import _ "github.com/charlie/substrate/kafka"

More complete documentation of options

For a full description of the url options available for each scheme, see the documentation for the particular driver, for example https://godoc.org/github.com/charlie/substrate/kafka or https://godoc.org/github.com/charlie/substrate/natsstreaming.

Index

• func NewSink(u string) (substrate.AsyncMessageSink, error)
• func NewSource(u string) (substrate.AsyncMessageSource, error)
• func RegisterSink(scheme string, sinkFunc func(url *url.URL) (substrate.AsyncMessageSink, error))
• func RegisterSource(scheme string, ...)

Functions

func NewSink

func NewSink(u string) (substrate.AsyncMessageSink, error)

NewSink will return a message sink based on the supplied URL. Examples:

kafka://localhost:123/my-topic/?metadata-refresh=2s&broker=localhost:234&broker=localhost:345
nats-streaming://localhost:123/my-subject?cluster-id=foo&client-id=bar

func NewSource

func NewSource(u string) (substrate.AsyncMessageSource, error)

NewSource returns a message source based on the supplied URL.

func RegisterSink

func RegisterSink(scheme string, sinkFunc func(url *url.URL) (substrate.AsyncMessageSink, error))

func RegisterSource

func RegisterSource(scheme string, sinkFunc func(url *url.URL) (substrate.AsyncMessageSource, error))