shared

Documentation

Overview

Package shared contains docs fields that need to be shared across old and new component implementations, it needs to be separate from the parent package in order to avoid circular dependencies (for now).

Index

• func SASLFieldSpec() docs.FieldSpec
• type ErrSASLMechanismNotSupported
  • func (e ErrSASLMechanismNotSupported) Error() string
• type SASLConfig
  • func NewSASLConfig() SASLConfig
  • func (s SASLConfig) ToOptFns() ([]amqp.ConnOption, error)

Functions

func SASLFieldSpec

func SASLFieldSpec() docs.FieldSpec

SASLFieldSpec returns specs for SASL fields.

Types

type ErrSASLMechanismNotSupported

type ErrSASLMechanismNotSupported string

ErrSASLMechanismNotSupported is returned if a SASL mechanism was not recognized.

func (ErrSASLMechanismNotSupported) Error

func (e ErrSASLMechanismNotSupported) Error() string

Error implements the standard error interface.

type SASLConfig

type SASLConfig struct {
	Mechanism string `json:"mechanism" yaml:"mechanism"`
	User      string `json:"user" yaml:"user"`
	Password  string `json:"password" yaml:"password"`
}

SASLConfig contains configuration for SASL based authentication.

func NewSASLConfig

func NewSASLConfig() SASLConfig

NewSASLConfig returns a new SASL config for AMQP with default values.

func (SASLConfig) ToOptFns

func (s SASLConfig) ToOptFns() ([]amqp.ConnOption, error)

ToOptFns renders the sasl.Config options into amqp.ConnOption fns.