# README
HCP SCADA Provider 
SCADA is an internal component of the infrastructure of the Hashicorp Cloud Platform control plane and it stands for Supervisory Control And Data Acquisition. It provides HCP with access to functions and data on HCP-managed clusters.
The provider package establishes and maintains a long-lived connection to allow incoming requests to be served by components running in relative network isolation.
SCADA is a variation on a NAT traversal technique.
Who uses it
It's in use internally at Hashicorp.
License
# Packages
No description provided by the author
No description provided by the author
No description provided by the author
# Functions
New creates a new SCADA provider instance using the configuration in config.
NewTimeError tries to map err to one of the known error values in ErrorPrefixes and it returns a timeError value set to either the error it found in ErrorPrefixes, or set to the caller's err.
PrefixError prefixes a known err error with prefixes from ErrorPrefixes, depending on the type of err.
# Constants
SessionStatusConnected is the state of the SCADA session if the session is established and active.
SessionStatusConnecting is the initial state of the SCADA connection as well as the state it will be in if the connection got disrupted and the library is trying to reconnect.
SessionStatusDisconnected is the state of the SCADA session if the provider has not been started or has been stopped.
SessionStatusRetrying is the state of a SCADA session that was previous connected and is now in a wait-connect cycle.
# Variables
could not obtain a token with the configured credentials.
ErrorPrefixes maintains a mapping between error types and their variable names.
the principal behind the creds does not have permission to register as provider.
the provider is not started.
# Structs
Config is used to parameterize a provider.
ConnectRequest holds parameters for the broker RPC Connect call to the provider.
ConnectResponse is the response to a Connect RPC call.
DisconnectRequest holds parameters for the broker RPC Disconnect call to the provider.
DisconnectResponse is the response to a Disconnect RPC call.
No description provided by the author
Provider is a high-level interface to SCADA by which instances declare themselves as a Service providing capabilities.
# Interfaces
SCADAProvider allows to expose services via SCADA capabilities.
# Type aliases
SessionStatus is used to express the current status of the SCADA session.