hostscan

Documentation

Overview

Service hostscan scans the local network for devices and provides status updates.

Index

• Variables
• type Dependencies
• type Host
  • func (h Host) String() string
• type HostRequest
• type HostScan
  • func New() *HostScan
  • func (h *HostScan) FindLocalNetwork() (string, error)
  • func (h *HostScan) LastStatus(name string) (Host, error)
  • func (h *HostScan) LastStatusAll() ([]Host, error)
  • func (h *HostScan) ScanCurrentHosts() ([]Host, error)
  • func (h *HostScan) Update() ([]Host, error)
• type Service
  • func NewService(deps *Dependencies) *Service
  • func (s *Service) Enable() error
  • func (s *Service) HandleForceUpdate(msg sarif.Message)
  • func (s *Service) HandleLastStatus(msg sarif.Message)
  • func (s *Service) Update() ([]Host, error)

Variables

var Module = &services.Module{
	Name:        "hostscan",
	Version:     "1.0",
	NewInstance: NewService,
}

Types

type Dependencies

type Dependencies struct {
	Log    sfproto.Logger
	Client sarif.Client
}

type Host

type Host struct {
	Ip        string    `json:"ip"`
	Name      string    `json:"name,omitempty"`
	Time      time.Time `json:"time"`
	UpdatedAt time.Time `json:"-"`
	Status    string    `json:"status"`
}

func (Host) String

func (h Host) String() string

type HostRequest

type HostRequest struct {
	Host string `json:"host"`
}

type HostScan

type HostScan struct {
	MinDownInterval time.Duration
	// contains filtered or unexported fields
}

func New

func New() *HostScan

func (*HostScan) FindLocalNetwork

func (h *HostScan) FindLocalNetwork() (string, error)

func (*HostScan) LastStatus

func (h *HostScan) LastStatus(name string) (Host, error)

func (*HostScan) LastStatusAll

func (h *HostScan) LastStatusAll() ([]Host, error)

func (*HostScan) ScanCurrentHosts

func (h *HostScan) ScanCurrentHosts() ([]Host, error)

func (*HostScan) Update

func (h *HostScan) Update() ([]Host, error)

type Service

type Service struct {
	Log sfproto.Logger
	sarif.Client
	// contains filtered or unexported fields
}

func NewService

func NewService(deps *Dependencies) *Service

func (*Service) Enable

func (s *Service) Enable() error

func (*Service) HandleForceUpdate

func (s *Service) HandleForceUpdate(msg sarif.Message)

func (*Service) HandleLastStatus

func (s *Service) HandleLastStatus(msg sarif.Message)

func (*Service) Update

func (s *Service) Update() ([]Host, error)