intermediate

Documentation

Overview

Package intermediate serves as the foundation of the messaging.example microservice.

The Messaging microservice demonstrates service-to-service communication patterns.

Index

• type Intermediate
  • func NewService(impl ToDo, version int) *Intermediate
• type Mock
  • func NewMock() *Mock
  • func (svc *Mock) CacheLoad(w http.ResponseWriter, r *http.Request) (err error)
  • func (svc *Mock) CacheStore(w http.ResponseWriter, r *http.Request) (err error)
  • func (svc *Mock) DefaultQueue(w http.ResponseWriter, r *http.Request) (err error)
  • func (svc *Mock) Home(w http.ResponseWriter, r *http.Request) (err error)
  • func (svc *Mock) MockCacheLoad(handler func(w http.ResponseWriter, r *http.Request) (err error)) *Mock
  • func (svc *Mock) MockCacheStore(handler func(w http.ResponseWriter, r *http.Request) (err error)) *Mock
  • func (svc *Mock) MockDefaultQueue(handler func(w http.ResponseWriter, r *http.Request) (err error)) *Mock
  • func (svc *Mock) MockHome(handler func(w http.ResponseWriter, r *http.Request) (err error)) *Mock
  • func (svc *Mock) MockNoQueue(handler func(w http.ResponseWriter, r *http.Request) (err error)) *Mock
  • func (svc *Mock) NoQueue(w http.ResponseWriter, r *http.Request) (err error)
  • func (svc *Mock) OnShutdown(ctx context.Context) (err error)
  • func (svc *Mock) OnStartup(ctx context.Context) (err error)
• type ToDo

Types

type Intermediate

type Intermediate struct {
	*connector.Connector
	// contains filtered or unexported fields
}

Intermediate extends and customizes the generic base connector. Code generated microservices then extend the intermediate.

func NewService

func NewService(impl ToDo, version int) *Intermediate

NewService creates a new intermediate service.

type Mock

type Mock struct {
	*Intermediate
	// contains filtered or unexported fields
}

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

func NewMock

func NewMock() *Mock

NewMock creates a new mockable version of the microservice.

func (*Mock) CacheLoad

func (svc *Mock) CacheLoad(w http.ResponseWriter, r *http.Request) (err error)

CacheLoad runs the mock handler set by MockCacheLoad.

func (*Mock) CacheStore

func (svc *Mock) CacheStore(w http.ResponseWriter, r *http.Request) (err error)

CacheStore runs the mock handler set by MockCacheStore.

func (*Mock) DefaultQueue

func (svc *Mock) DefaultQueue(w http.ResponseWriter, r *http.Request) (err error)

DefaultQueue runs the mock handler set by MockDefaultQueue.

func (*Mock) Home

func (svc *Mock) Home(w http.ResponseWriter, r *http.Request) (err error)

Home runs the mock handler set by MockHome.

func (*Mock) MockCacheLoad

func (svc *Mock) MockCacheLoad(handler func(w http.ResponseWriter, r *http.Request) (err error)) *Mock

MockCacheLoad sets up a mock handler for the CacheLoad endpoint.

func (*Mock) MockCacheStore

func (svc *Mock) MockCacheStore(handler func(w http.ResponseWriter, r *http.Request) (err error)) *Mock

MockCacheStore sets up a mock handler for the CacheStore endpoint.

func (*Mock) MockDefaultQueue

func (svc *Mock) MockDefaultQueue(handler func(w http.ResponseWriter, r *http.Request) (err error)) *Mock

MockDefaultQueue sets up a mock handler for the DefaultQueue endpoint.

func (*Mock) MockHome

func (svc *Mock) MockHome(handler func(w http.ResponseWriter, r *http.Request) (err error)) *Mock

MockHome sets up a mock handler for the Home endpoint.

func (*Mock) MockNoQueue

func (svc *Mock) MockNoQueue(handler func(w http.ResponseWriter, r *http.Request) (err error)) *Mock

MockNoQueue sets up a mock handler for the NoQueue endpoint.

func (*Mock) NoQueue

func (svc *Mock) NoQueue(w http.ResponseWriter, r *http.Request) (err error)

NoQueue runs the mock handler set by MockNoQueue.

func (*Mock) OnShutdown

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

OnShutdown is a no op.

func (*Mock) OnStartup

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

OnStartup makes sure that the mock is not executed in a non-dev environment.

type ToDo

type ToDo interface {
	OnStartup(ctx context.Context) (err error)
	OnShutdown(ctx context.Context) (err error)
	Home(w http.ResponseWriter, r *http.Request) (err error)
	NoQueue(w http.ResponseWriter, r *http.Request) (err error)
	DefaultQueue(w http.ResponseWriter, r *http.Request) (err error)
	CacheLoad(w http.ResponseWriter, r *http.Request) (err error)
	CacheStore(w http.ResponseWriter, r *http.Request) (err error)
}

ToDo defines the interface that the microservice must implement. The intermediate delegates handling to this interface.