journey

Documentation

Overview

Package journey defines a context type, which carries information about a specific inbound request. It is created when it hits the first service and it is propagated across all services.

It has been named journey instead of request, because a journey can result of multiple sub-requests. And also because it sounds nice, isn't it?

Index

• func MarshalGob(c Ctx) ([]byte, error)
• type Ctx
  • func New(ctx app.Ctx) Ctx
  • func UnmarshalGob(ctx app.Ctx, data []byte) (Ctx, error)
• type KV
• type Stepper
  • func NewStepper() *Stepper
  • func (s *Stepper) BranchOff() *Stepper
  • func (s *Stepper) Inc() uint
  • func (s *Stepper) String() string
• type Type

Functions

func MarshalGob

func MarshalGob(c Ctx) ([]byte, error)

MarshalGob marshals a context in gob

Types

type Ctx

type Ctx interface {
	ctx.Ctx

	UUID() string
	ShortID() string
	AppConfig() *config.Config
	BG(f func(c Ctx)) error
	BranchOff(t Type) Ctx
	Cancel()
	End()

	Store(key interface{}, v interface{})
	Load(key interface{}) interface{}
	Delete(key interface{})
	RangeValues(f func(key, value interface{}) bool)
}

Ctx is the journey context interface

func New

func New(ctx app.Ctx) Ctx

New creates a new context and returns it

func UnmarshalGob

func UnmarshalGob(ctx app.Ctx, data []byte) (Ctx, error)

UnmarshalGob unmarshals a gob encoded context

type KV

type KV struct {
	Map map[interface{}]interface{}
	// contains filtered or unexported fields
}

KV is a serialisable key/value store TODO: Replace it with go 1.9 sync/map at some point

type Stepper

type Stepper struct {
	Steps []uint32
	I     int
	// contains filtered or unexported fields
}

Stepper is the atomic counter for context log lines

func NewStepper

func NewStepper() *Stepper

NewStepper builds a new main stepper

func (*Stepper) BranchOff

func (s *Stepper) BranchOff() *Stepper

BranchOff returns a new "child" stepper

func (*Stepper) Inc

func (s *Stepper) Inc() uint

Inc increments the current counter

func (*Stepper) String

func (s *Stepper) String() string

String returns a string representation of the current state

type Type

type Type int

Type represents a context type (Foreground or Background)

const (
	Child Type = iota
	Root
)