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

• type Ctx
  • func New(ctx app.Ctx) Ctx
  • func ParseText(ctx app.Ctx, text []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

Types

type Ctx

type Ctx interface {
	ctx.Ctx

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

	// Net context functions
	Deadline() (deadline time.Time, ok bool)
	Done() <-chan struct{}
	Err() error
	Value(key interface{}) interface{}

	// Marshalling
	MarshalText() (text []byte, err error)
}

Ctx is the journey context interface

func New

func New(ctx app.Ctx) Ctx

New creates a new context and returns it

func ParseText

func ParseText(ctx app.Ctx, text []byte) (Ctx, error)

ParseText parses a context serialised in text format

type KV

type KV interface {
	Store(k string, v interface{})
	Retrieve(k string) (interface{}, bool)
	Delete(k string)
}

KV is an interface for key/value storage

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
)