generators

Documentation

Overview

Package generators provides custom hostname generation for use with Splice.

Index

• Variables
• func ConfigureAll() error
• func List() []string
• func Register(name string, g generator)
• func Run(name string, input []byte) (string, error)

Variables

var (
	// RootKey is the root registry key for generator configuration
	RootKey = `SOFTWARE\Splice\Generators`

	// ErrInvalidGenerator indicates that an invalid generator name was requested
	ErrInvalidGenerator = errors.New("invalid generator name")
	// ErrLongName is returned in cases where a name may exceed Active Directory limits
	ErrLongName = errors.New("names greater than 15 characters may fail to join")
	// ErrNotConfigured indicates that a generator has not yet been configured.
	// Try calling ConfigureAll() first.
	ErrNotConfigured = errors.New("generator is not configured")
)

Functions

func ConfigureAll

func ConfigureAll() error

ConfigureAll configures all generators for use. This should be called once at setup, but can be called subsequently to reconfigure.

func List

func List() []string

List returns a list of the available generators by name.

func Register

func Register(name string, g generator)

Register registers a new generator.

func Run

func Run(name string, input []byte) (string, error)

Run performs a hostname generation using the given generator and input.