configuration

Documentation

Overview

Package configuration implements configuration service required by the api-gateway service

Package configuration implements configuration service required by the api-gateway service

Package configuration implements configuration service required by the project service

Index

• func IsUnknownError(err error) bool
• func NewUnknownError(message string) error
• func NewUnknownErrorWithError(message string, err error) error
• type ConfigurationContract
  • func NewEnvConfigurationService() (ConfigurationContract, error)
• type UnknownError
  • func (e UnknownError) Error() string
  • func (e UnknownError) Unwrap() error

Functions

func IsUnknownError

func IsUnknownError(err error) bool

IsUnknownError indicates whether the error is of type UnknownError

func NewUnknownError

func NewUnknownError(message string) error

NewUnknownError creates a new UnknownError error

func NewUnknownErrorWithError

func NewUnknownErrorWithError(message string, err error) error

NewUnknownErrorWithError creates a new UnknownError error

Types

type ConfigurationContract

type ConfigurationContract interface {
	// GetHttpHost retrieves HTTP host name
	// Returns the HTTP host name or error if something goes wrong
	GetHttpHost() (string, error)

	// GetHttpPort retrieves HTTP port number
	// Returns the HTTP port number or error if something goes wrong
	GetHttpPort() (int, error)

	// GetProjectServiceAddress retrieves project service full gRPC address and returns it.
	// The address will be used to dial the gRPC client to connect to the project service.
	// Returns the project service address or error if something goes wrong
	GetProjectServiceAddress() (string, error)

	// GetEdgeClusterServiceAddress retrieves edge cluster service full gRPC address and returns it.
	// The address will be used to dial the gRPC client to connect to the edge cluster service.
	// Returns the edge cluster service address or error if something goes wrong
	GetEdgeClusterServiceAddress() (string, error)
}

ConfigurationContract declares the service that provides configuration required by different Tenat modules

func NewEnvConfigurationService

func NewEnvConfigurationService() (ConfigurationContract, error)

NewEnvConfigurationService creates new instance of the EnvConfigurationService, setting up all dependencies and returns the instance Returns the new service or error if something goes wrong

type UnknownError

type UnknownError struct {
	Message string
	Err     error
}

UnknownError indicates that an unknown error has happened

func (UnknownError) Error

func (e UnknownError) Error() string

Error returns message for the UnknownError error type Returns the error nessage

func (UnknownError) Unwrap

func (e UnknownError) Unwrap() error

Unwrap returns the err if provided through NewUnknownErrorWithError function, otherwise returns nil