stream

Documentation

Index

• type CloseFunc
• type Context
  • func NewCancelContext(cancel context.CancelFunc) Context
  • func NewContext(close CloseFunc) Context
• type Event
• type EventType

Types

type CloseFunc

type CloseFunc func()

CloseFunc is a Context Close function

type Context

type Context interface {
	// Close closes the stream. The stream channel will be closed and resources used by the
	// stream will be released.
	Close()
}

Context is a stream context

func NewCancelContext

func NewCancelContext(cancel context.CancelFunc) Context

NewCancelContext creates a new stream context from a context CancelFunc

func NewContext

func NewContext(close CloseFunc) Context

NewContext creates a new context with a close function

type Event

type Event struct {
	// Type is the stream event type
	Type EventType

	// Object is the event object
	Object interface{}
}

Event is a stream event

type EventType

type EventType string

EventType is a stream event type

const (
	// None indicates an object was not changed
	None EventType = ""
	// Created indicates an object was created
	Created EventType = "Created"
	// Updated indicates an object was updated
	Updated EventType = "Updated"
	// Deleted indicates an object was deleted
	Deleted EventType = "Deleted"
)