token

Documentation

Overview

Package token contains necessary logic for passing messages. The Engine will issue a token.Context with a unique ID and sends it to the reader. The New function injects a unique ID into the context and returns it. All readers/recorders should use this ID for returning errors and logging.

Index

• type Context
  • func New(ctx context.Context) *Context
  • func (c *Context) ID() ID
• type ID
  • func NewUID() ID
  • func (i ID) String() string

Examples

• New

Types

type Context

type Context struct {
	context.Context
}

Context is a context.Context with a token as its value. IDEA: add current time. Then log the creation time if required.

func New

func New(ctx context.Context) *Context

New constructs a ReadJob with the provided context.

Example

This example shows how to create a new job from a context.

package main

import (
	"context"
	"fmt"

	"github.com/arsham/expipe/token"
)

func main() {
	job := token.New(context.Background())
	fmt.Println(job)
}

func (*Context) ID

func (c *Context) ID() ID

ID returns the recorded value in the c.

type ID

type ID uuid.UUID

ID is a unique ID. Only the Engine issues this ID and you should pass it along as you receive.

func NewUID

func NewUID() ID

NewUID returns a new unique ID.

func (ID) String

func (i ID) String() string