notifications

Documentation

Overview

******************************************************************************

• Copyright 2017 Dell Inc.
• Copyright (c) 2019 Intel 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. ******************************************************************************

main is the central entry point for the application and calls all the startup logic.

Index

• Constants
• Variables
• func Main(ctx context.Context, cancel context.CancelFunc, router *mux.Router, ...)
• type Bootstrap
  • func NewBootstrap(router *mux.Router) *Bootstrap
  • func (b *Bootstrap) BootstrapHandler(_ context.Context, _ *sync.WaitGroup, _ startup.Timer, dic *di.Container) bool

Constants

const (
	ExceededMaxResultCount string = "error, exceeded the max limit as defined in config"
)

Variables

var (
	/* ----------------------- CONSTANTS ----------------------------*/
	ESCALATIONSUBSCRIPTIONSLUG = "ESCALATION"
	ESCALATIONPREFIX           = "escalated-"
	ESCALATEDCONTENTNOTICE     = "This notification is escalated by the transmission"

	/* ---------------- URL PARAM NAMES -----------------------*/
	START        = "start"
	END          = "end"
	LIMIT        = "limit"
	NOTIFICATION = "notification"
	SUBSCRIPTION = "subscription"
	TRANSMISSION = "transmission"
	CLEANUP      = "cleanup"
	SLUG         = "slug"
	LABELS       = "labels"
	CATEGORIES   = "categories"
	ID           = "id"
	SENDER       = "sender"
	RECEIVER     = "receiver"
	AGE          = "age"
	NEW          = "new"
	ESCALATED    = "escalated"
	ACKNOWLEDGED = "acknowledged"
	FAILED       = "failed"
	SENT         = "sent"
)

Functions

func Main

func Main(ctx context.Context, cancel context.CancelFunc, router *mux.Router, readyStream chan<- bool)

Types

type Bootstrap

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

Bootstrap contains references to dependencies required by the BootstrapHandler.

func NewBootstrap

func NewBootstrap(router *mux.Router) *Bootstrap

NewBootstrap is a factory method that returns an initialized Bootstrap receiver struct.

func (*Bootstrap) BootstrapHandler

func (b *Bootstrap) BootstrapHandler(_ context.Context, _ *sync.WaitGroup, _ startup.Timer, dic *di.Container) bool

BootstrapHandler fulfills the BootstrapHandler contract and performs initialization for the notifications service.