event

Documentation

Overview

Copyright 2020 IBM Corporation

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• func EnqueueHandler(queue Queue) http.HandlerFunc
• func ProcessQueueWorker(queue Queue, handler Handler)
• type Event
• type Handler
• type Queue
  • func NewQueue() Queue
• type Type

Constants

const (
	// MessageHeader is the message key containing the request's headers
	MessageHeader = "header"
	// MessageBody is the message key containing the request's payload
	MessageBody = "body"
)

Functions

func EnqueueHandler

func EnqueueHandler(queue Queue) http.HandlerFunc

Event listener listens for REST requests and enqueues a message consisting of the request's headers and payloads.

func ProcessQueueWorker

func ProcessQueueWorker(queue Queue, handler Handler)

ProcessQueueWorker processes events on the Queue

Types

type Event

type Event struct {
	URL        *url.URL
	RemoteAddr string
	Header     map[string][]string
	Body       map[string]interface{}
}

Event contains the destination URL, headers, and a body

type Handler

type Handler func(event *Event) error

A handler that responds to an event

type Queue

type Queue interface {
	Enqueue(elem interface{})
	Dequeue() interface{}
	Len() int
}

func NewQueue

func NewQueue() Queue

type Type

type Type int

Types of events

const (
	TypeOther Type = iota
	TypeGitHub
)