hcp_link

Documentation

Index

• Constants
• type HCPLinkVaultInterface
• type SessionStatus
• type WrappedHCPLinkVault
  • func NewHCPLink(linkConf *configutil.HCPLinkConfig, core *vault.Core, logger hclog.Logger) (*WrappedHCPLinkVault, error)
  • func (h *WrappedHCPLinkVault) GetConnectionStatusMessage(scadaStatus string) string
  • func (h *WrappedHCPLinkVault) GetScadaSessionStatus() string
  • func (h *WrappedHCPLinkVault) Shutdown() error

Constants

const (
	// Connected HCP link connection status when it is connected
	Connected = SessionStatus("connected")
	// Disconnected HCP link connection status when it is disconnected
	Disconnected = SessionStatus("disconnected")
)

Types

type HCPLinkVaultInterface

type HCPLinkVaultInterface interface {
	Shutdown() error
	GetScadaSessionStatus() string
	GetConnectionStatusMessage(string) string
}

type SessionStatus

type SessionStatus = string

SessionStatus is used to express the current status of the SCADA session.

type WrappedHCPLinkVault

type WrappedHCPLinkVault struct {
	HCPLinkVaultInterface
}

func NewHCPLink

func NewHCPLink(linkConf *configutil.HCPLinkConfig, core *vault.Core, logger hclog.Logger) (*WrappedHCPLinkVault, error)

func (*WrappedHCPLinkVault) GetConnectionStatusMessage

func (h *WrappedHCPLinkVault) GetConnectionStatusMessage(scadaStatus string) string

func (*WrappedHCPLinkVault) GetScadaSessionStatus

func (h *WrappedHCPLinkVault) GetScadaSessionStatus() string

func (*WrappedHCPLinkVault) Shutdown

func (h *WrappedHCPLinkVault) Shutdown() error