ginamite

README

ginamite

Documentation

Index

• type ApplicationConfiguration
  • func (a ApplicationConfiguration) AddSupportedNotification(notification string, isDefault bool)
  • func (a ApplicationConfiguration) DisableNotification(notification string) bool
  • func (a ApplicationConfiguration) EnableNotification(notification string) bool
  • func (a ApplicationConfiguration) SetNotificationDefault(notification string, isDefault bool) bool
• type Plugin
• type Server
  • func NewServer() *Server
  • func (s *Server) AddPlugin(p Plugin)
  • func (s *Server) Start()
• type SpecializedServer

Types

type ApplicationConfiguration

type ApplicationConfiguration struct {
	FileRequired   bool
	InitializeFunc func(filePath string)
}

ApplicationConfiguration : additional and optional configuration of te application.

func (ApplicationConfiguration) AddSupportedNotification

func (a ApplicationConfiguration) AddSupportedNotification(notification string, isDefault bool)

AddSupportedNotification : adds some supported notification types.

func (ApplicationConfiguration) DisableNotification

func (a ApplicationConfiguration) DisableNotification(notification string) bool

DisableNotification : disables a supported notification.

func (ApplicationConfiguration) EnableNotification

func (a ApplicationConfiguration) EnableNotification(notification string) bool

EnableNotification : disables a supported notification.

func (ApplicationConfiguration) SetNotificationDefault

func (a ApplicationConfiguration) SetNotificationDefault(notification string, isDefault bool) bool

SetNotificationDefault : sets a supported notification as default or not.

type Plugin

type Plugin interface {
	Configure(s *Server)
}

Plugin : interface that loads some configuration ot a server.

type Server

type Server struct {
	ApplicationConfiguration ApplicationConfiguration
	Worker                   *worker.Server
	API                      *api.Server
	Web                      *web.Server
	// contains filtered or unexported fields
}

Server : represents the main struct of the application containing all the settings.

func NewServer

func NewServer() *Server

NewServer : returns a newly created 'Server' struct.

func (*Server) AddPlugin

func (s *Server) AddPlugin(p Plugin)

AddPlugin : adds a plugin to the list.

func (*Server) Start

func (s *Server) Start()

Start : starts the server.

type SpecializedServer

type SpecializedServer interface {
	CreateKafkaConsumers() []kafka.MessageConsumer
	Start()
}

SpecializedServer : abstract defintion of a API/Worker/Web specialized server.