service

package

v0.2.0 Latest Latest Go to latest Published: Oct 20, 2021 License: MIT Imports: 15 Imported by: 0

Documentation ¶

Index ¶

type EventConsumer
type ExternalServiceList
- func NewServiceList(initialiser Initialiser) *ExternalServiceList
type HTTPServer
type HealthChecker
type Init
type Initialiser
type Service
- func Run(ctx context.Context, serviceList *ExternalServiceList, ...) (*Service, error)
- func (svc *Service) Close(ctx context.Context) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type EventConsumer ¶

type EventConsumer interface {
	Close(ctx context.Context) (err error)
}

EventConsumer defines the required methods from event Consumer

type ExternalServiceList ¶

type ExternalServiceList struct {
	HealthCheck   bool
	KafkaConsumer bool
	KafkaProducer bool
	Init          Initialiser
	ZebedeeClient bool
}

ExternalServiceList holds the initialiser and initialisation state of external services.

func NewServiceList ¶

func NewServiceList(initialiser Initialiser) *ExternalServiceList

NewServiceList creates a new service list with the provided initialiser

func (*ExternalServiceList) GetHTTPServer ¶

func (e *ExternalServiceList) GetHTTPServer(bindAddr string, router http.Handler) HTTPServer

GetHTTPServer creates an http server and sets the Server flag to true

func (*ExternalServiceList) GetHealthCheck ¶

func (e *ExternalServiceList) GetHealthCheck(cfg *config.Config, buildTime, gitCommit, version string) (HealthChecker, error)

GetHealthCheck creates a healthcheck with versionInfo and sets teh HealthCheck flag to true

func (*ExternalServiceList) GetKafkaConsumer ¶

func (e *ExternalServiceList) GetKafkaConsumer(ctx context.Context, cfg *config.Config) (dpkafka.IConsumerGroup, error)

GetKafkaConsumer creates a Kafka consumer and sets the consumer flag to true

func (*ExternalServiceList) GetKafkaProducer ¶ added in v0.2.0

func (e *ExternalServiceList) GetKafkaProducer(ctx context.Context, cfg *config.Config) (dpkafka.IProducer, error)

GetKafkaProducer creates a Kafka producer and sets the producder flag to true

func (*ExternalServiceList) GetZebedee ¶ added in v0.2.0

func (e *ExternalServiceList) GetZebedee(ctx context.Context, cfg *config.Config) clients.ZebedeeClient

GetZebedee return zebedee client

type HTTPServer ¶

type HTTPServer interface {
	ListenAndServe() error
	Shutdown(ctx context.Context) error
}

HTTPServer defines the required methods from the HTTP server

type HealthChecker ¶

type HealthChecker interface {
	Handler(w http.ResponseWriter, req *http.Request)
	Start(ctx context.Context)
	Stop()
	AddCheck(name string, checker healthcheck.Checker) (err error)
}

HealthChecker defines the required methods from Healthcheck

type Init ¶

type Init struct{}

Init implements the Initialiser interface to initialise dependencies

func (*Init) DoGetHTTPServer ¶

func (e *Init) DoGetHTTPServer(bindAddr string, router http.Handler) HTTPServer

DoGetHTTPServer creates an HTTP Server with the provided bind address and router

func (*Init) DoGetHealthCheck ¶

func (e *Init) DoGetHealthCheck(cfg *config.Config, buildTime, gitCommit, version string) (HealthChecker, error)

DoGetHealthCheck creates a healthcheck with versionInfo

func (*Init) DoGetKafkaConsumer ¶

func (e *Init) DoGetKafkaConsumer(ctx context.Context, cfg *config.Config) (dpkafka.IConsumerGroup, error)

DoGetKafkaConsumer returns a Kafka Consumer group

func (*Init) DoGetKafkaProducer ¶ added in v0.2.0

func (e *Init) DoGetKafkaProducer(ctx context.Context, cfg *config.Config) (dpkafka.IProducer, error)

func (*Init) DoGetZebedeeClient ¶ added in v0.2.0

func (e *Init) DoGetZebedeeClient(ctx context.Context, cfg *config.Config) clients.ZebedeeClient

DoGetZebedeeClient gets and initialises the Zebedee Client

type Initialiser ¶

type Initialiser interface {
	DoGetHTTPServer(bindAddr string, router http.Handler) HTTPServer
	DoGetHealthCheck(cfg *config.Config, buildTime, gitCommit, version string) (HealthChecker, error)
	DoGetKafkaConsumer(ctx context.Context, cfg *config.Config) (dpkafka.IConsumerGroup, error)
	DoGetKafkaProducer(ctx context.Context, cfg *config.Config) (dpkafka.IProducer, error)
	DoGetZebedeeClient(ctx context.Context, cfg *config.Config) clients.ZebedeeClient
}

Initialiser defines the methods to initialise external services

type Service ¶

type Service struct {
	// contains filtered or unexported fields
}

Service contains all the configs, server and clients to run the event handler service

func Run ¶

func Run(ctx context.Context, serviceList *ExternalServiceList, buildTime, gitCommit, version string, svcErrors chan error) (*Service, error)

Run the service

func (*Service) Close ¶

func (svc *Service) Close(ctx context.Context) error

Close gracefully shuts the service down in the required order, with timeout

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
mock

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL