Categorygithub.com/niallgorithm/gomb
modulepackage
0.1.0
Repository: https://github.com/niallgorithm/gomb.git
Documentation: pkg.go.dev

# README

GOMB - Go Message Broker

A general purpose package for working with message brokers, such as Kafka, Pulsar and Redis Streams, loosely inspired by Golang's database/sql.

:warning: This repo is under construction.

# Functions

NewBroker creates a new MessageBroker.
NewBrokerOptions returns a new BrokerOptions.
NewConsumerOptions returns a new ConsumerOptions.
NewMessage creates a new message.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

ErrConnection is returned when there is a connection error.
ErrInvalidBroker is returned when the broker is invalid.
ErrInvalidBrokerOption is returned when the broker option is invalid.
ErrInvalidBrokerOptions is returned when the broker options are invalid.
ErrInvalidBrokerOptionValue is returned when the broker option value is invalid.
ErrMissingBroker is returned when the broker is missing.
ErrTooManyAuths is returned when there are too many auths.

# Structs

AuthOptions represents the options for authentication.
BasicAuth represents the basic authentication options.
BrokerOptions represents the options for a message broker.
ConsumerOptions represents the options for a message consumer.
ErrAuth is an auth setting related error.
Message is the struct that all brokers handle.
OAuth2 represents the OAuth2 options.
SASL represents the SASL authentication options.
TLS represents the TLS options.

# Interfaces

Broker is the interface that all message brokers must implement.
BrokerMessage is the interface that all messages must implement.
Consumer is the interface that all message consumers must implement.

# Type aliases

No description provided by the author
No description provided by the author