async

Documentation

Index

• type AsyncOrigin
  • func ParseAsyncOrigin(origin string) (AsyncOrigin, error)
• type AsyncOriginCron
  • func (a AsyncOriginCron) Origin() string
  • func (a AsyncOriginCron) String() string
• type AsyncOriginPubSub
  • func (a AsyncOriginPubSub) Origin() string
  • func (a AsyncOriginPubSub) String() string

Types

type AsyncOrigin

type AsyncOrigin interface {

	// Origin returns the origin type.
	Origin() string
	String() string
	// contains filtered or unexported methods
}

AsyncOrigin is a sum type representing the originator of an async call.

This is used to determine how to handle the result of the async call.

func ParseAsyncOrigin

func ParseAsyncOrigin(origin string) (AsyncOrigin, error)

ParseAsyncOrigin parses an async origin key.

type AsyncOriginCron

type AsyncOriginCron struct {
	CronJobKey model.CronJobKey `parser:"'cron' ':' @(~EOF)+"`
}

AsyncOriginCron represents the context for the originator of a cron async call.

It is in the form cron:<module>.<verb>

func (AsyncOriginCron) Origin

func (a AsyncOriginCron) Origin() string

func (AsyncOriginCron) String

func (a AsyncOriginCron) String() string

type AsyncOriginPubSub

type AsyncOriginPubSub struct {
	Subscription schema.RefKey `parser:"'sub' ':' @@"`
}

AsyncOriginPubSub represents the context for the originator of an PubSub async call.

It is in the form sub:<module>.<subscription_name>

func (AsyncOriginPubSub) Origin

func (a AsyncOriginPubSub) Origin() string

func (AsyncOriginPubSub) String

func (a AsyncOriginPubSub) String() string