eventsink

Documentation

Overview

Package eventsink implements the eventsink.example microservice.

The event sink microservice handles events that are fired by the event source microservice.

Index

• Constants
• type Mock
  • func NewMock() *Mock
• type Service
  • func NewService() *Service
  • func (svc *Service) Init(initializer func(svc *Service)) *Service
  • func (svc *Service) OnAllowRegister(ctx context.Context, email string) (allow bool, err error)
  • func (svc *Service) OnRegistered(ctx context.Context, email string) (err error)
  • func (svc *Service) OnShutdown(ctx context.Context) (err error)
  • func (svc *Service) OnStartup(ctx context.Context) (err error)
  • func (svc *Service) Registered(ctx context.Context) (emails []string, err error)

Constants

const Hostname = "eventsink.example"

Hostname is the default hostname of the microservice: eventsink.example.

const SourceCodeSHA256 = "f385494cf7891bd7b2894a8bec1e3894f881cada4bfd076827012c5fa63791cf"

const Timestamp = "2024-07-14T02:54:34.456093Z"

const Version = 196

Types

type Mock

type Mock = intermediate.Mock

Mock is a mockable version of the eventsink.example microservice, allowing functions, event sinks and web handlers to be mocked.

func NewMock

func NewMock() *Mock

New creates a new mockable version of the microservice.

type Service

type Service struct {
	*intermediate.Intermediate // DO NOT REMOVE
}

Service implements the eventsink.example microservice.

The event sink microservice handles events that are fired by the event source microservice.

func NewService

func NewService() *Service

NewService creates a new eventsink.example microservice.

func (*Service) Init

func (svc *Service) Init(initializer func(svc *Service)) *Service

Init enables a single-statement pattern for initializing the microservice.

svc.Init(func(svc Service) {
	svc.SetGreeting("Hello")
})

func (*Service) OnAllowRegister

func (svc *Service) OnAllowRegister(ctx context.Context, email string) (allow bool, err error)

OnAllowRegister blocks registrations from certain email providers as well as duplicate registrations.

func (*Service) OnRegistered

func (svc *Service) OnRegistered(ctx context.Context, email string) (err error)

OnRegistered keeps track of registrations.

func (*Service) OnShutdown

func (svc *Service) OnShutdown(ctx context.Context) (err error)

OnShutdown is called when the microservice is shut down.

func (*Service) OnStartup

func (svc *Service) OnStartup(ctx context.Context) (err error)

OnStartup is called when the microservice is started up.

func (*Service) Registered

func (svc *Service) Registered(ctx context.Context) (emails []string, err error)

Registered returns the list of registered users.