module

Documentation

Overview

Package module implements the core module to start connection with HummingBird.

Index

• type Channel
• type HummingBird
  • func NewHummingBird(context context.T) *HummingBird
  • func (h *HummingBird) ModuleExecute(context context.T) (err error)
  • func (h *HummingBird) ModuleName() string
  • func (h *HummingBird) ModuleRequestStop(stopType contracts.StopType) (err error)

Types

type Channel

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

type HummingBird

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

HummingBird encapsulates the logic on configuring, starting and stopping core modules

func NewHummingBird

func NewHummingBird(context context.T) *HummingBird

NewHummingBird gets HM core module that will manage the websocket connection between Agent and HM service.

func (*HummingBird) ModuleExecute

func (h *HummingBird) ModuleExecute(context context.T) (err error)

ModuleExecute starts the scheduling of the health check module

func (*HummingBird) ModuleName

func (h *HummingBird) ModuleName() string

ModuleName returns the name of module

func (*HummingBird) ModuleRequestStop

func (h *HummingBird) ModuleRequestStop(stopType contracts.StopType) (err error)

RequestStop handles the termination of the web socket plugin job