sender

Documentation

Index

• Constants
• Variables
• func NewCloudEvent(data interface{}, typ string) cloudevents.Event
• func NewEventID() string
• func PopulateSpanWithEvent(ctx context.Context, ce cloudevents.Event, spanName string) (context.Context, *trace.Span)
• func RegisterEventSender(es EventSender)
• func RegisterEventSenderWithContext(es EventSenderWithContext)
• func ResetEventSenders()
• func SendEvent(ctx context.Context, ce cloudevents.Event, endpoint interface{}) error
• type EndpointSupporter
• type EventSender
• type EventSenderWithContext
• type Sender
  • func New() Sender

Constants

const (
	Name = "wathola-sender"
)

Variables

var (
	// ErrEndpointTypeNotSupported is raised if configured endpoint isn't
	// supported by any of the event senders that are registered.
	ErrEndpointTypeNotSupported = errors.New("given endpoint isn't " +
		"supported by any registered event sender")
)

Functions

func NewCloudEvent

func NewCloudEvent(data interface{}, typ string) cloudevents.Event

NewCloudEvent creates a new cloud event

func NewEventID

func NewEventID() string

NewEventID creates new event ID

func PopulateSpanWithEvent

func PopulateSpanWithEvent(ctx context.Context, ce cloudevents.Event, spanName string) (context.Context, *trace.Span)

func RegisterEventSender

func RegisterEventSender(es EventSender)

RegisterEventSender will register a EventSender to be used. Deprecated. Use RegisterEventSenderWithContext.

func RegisterEventSenderWithContext

func RegisterEventSenderWithContext(es EventSenderWithContext)

RegisterEventSenderWithContext will register EventSenderWithContext to be used.

func ResetEventSenders

func ResetEventSenders()

ResetEventSenders will reset configured event senders to defaults.

func SendEvent

func SendEvent(ctx context.Context, ce cloudevents.Event, endpoint interface{}) error

SendEvent will send cloud event to given url

Types

type EndpointSupporter

type EndpointSupporter interface {
	// Supports will check given endpoint definition and decide if it's valid for
	// this sender.
	Supports(endpoint interface{}) bool
}

type EventSender

type EventSender interface {
	EndpointSupporter
	// SendEvent will send event to given endpoint.
	SendEvent(ce cloudevents.Event, endpoint interface{}) error
}

EventSender will be used to send events to configured endpoint. Deprecated. Use EventSenderWithContext.

type EventSenderWithContext

type EventSenderWithContext interface {
	EndpointSupporter
	// SendEventWithContext will send event to the given endpoint and pass context.
	SendEventWithContext(ctx context.Context, ce cloudevents.Event, endpoint interface{}) error
}

EventSenderWithContext will be used to send events to configured endpoint, passing a context.

type Sender

type Sender interface {
	SendContinually()
}

Sender will send messages continuously until process receives a SIGINT

func New

func New() Sender

New creates new Sender