events

Documentation

Index

• func NewCompletedEvent(message string)
• func NewErrorEvent(err error, description string)
• func NewEvent(eventType EventType, message string)
• func NewStatusEvent(message string)
• type Event
  • func GetEvent(data string) (*Event, error)
• type EventAwaiter
  • func NewEventAwaiter() *EventAwaiter
  • func (ep *EventAwaiter) AwaitCompletedEvent(stream io.Reader) (string, error)
• type EventType

Functions

func NewCompletedEvent

func NewCompletedEvent(message string)

NewCompletedEvent is used to publish completed event

func NewErrorEvent

func NewErrorEvent(err error, description string)

NewErrorEvent is used to publish error event

func NewEvent

func NewEvent(eventType EventType, message string)

NewEvent is used to publish new event

func NewStatusEvent

func NewStatusEvent(message string)

NewStatusEvent is used to publish status event

Types

type Event

type Event struct {
	Type    EventType `json:"type"`
	Message string    `json:"message"`
}

Event is struct for events

func GetEvent

func GetEvent(data string) (*Event, error)

GetEvent is used to read published event

type EventAwaiter

type EventAwaiter struct {
	// contains filtered or unexported fields
}

func NewEventAwaiter

func NewEventAwaiter() *EventAwaiter

func (*EventAwaiter) AwaitCompletedEvent

func (ep *EventAwaiter) AwaitCompletedEvent(stream io.Reader) (string, error)

type EventType

type EventType string

EventType is type for further parsing

const (
	Error     EventType = "error"
	Status    EventType = "status"
	Completed EventType = "completed"
)

available event types