opcua

package
v1.36.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 29, 2025 License: MIT Imports: 23 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ErrInvalidEndpoint indicates an invalid or malformed endpoint URL
	ErrInvalidEndpoint = errors.New("invalid endpoint")

	// ErrInvalidSecurityPolicy indicates an unsupported security policy
	ErrInvalidSecurityPolicy = errors.New("invalid security policy")

	// ErrInvalidSecurityMode indicates an unsupported security mode
	ErrInvalidSecurityMode = errors.New("invalid security mode")

	// ErrInvalidAuthMethod indicates an unsupported authentication method
	ErrInvalidAuthMethod = errors.New("invalid authentication method")

	// ErrCertificateGeneration indicates a failure in certificate generation
	ErrCertificateGeneration = errors.New("certificate generation failed")

	// ErrConnectionFailed indicates a connection failure
	ErrConnectionFailed = errors.New("connection failed")

	// ErrEndpointNotFound indicates no suitable endpoint was found
	ErrEndpointNotFound = errors.New("no suitable endpoint found")

	// ErrInvalidConfiguration indicates invalid configuration parameters
	ErrInvalidConfiguration = errors.New("invalid configuration")

	// ErrStatusCodeParsing indicates failure to parse status codes
	ErrStatusCodeParsing = errors.New("status code parsing failed")
)

Common OPC UA error types for better error handling and classification

Functions

This section is empty.

Types

type AuthenticationError added in v1.36.0 

type AuthenticationError struct {
	Method string
	Err    error
}

AuthenticationError represents an error related to authentication

func (*AuthenticationError) Error added in v1.36.0 

func (e *AuthenticationError) Error() string

func (*AuthenticationError) Unwrap added in v1.36.0 

func (e *AuthenticationError) Unwrap() error

type CertificateError added in v1.36.0 

type CertificateError struct {
	Operation string
	Path      string
	Err       error
}

CertificateError represents an error related to certificate operations

func (*CertificateError) Error added in v1.36.0 

func (e *CertificateError) Error() string

func (*CertificateError) Unwrap added in v1.36.0 

func (e *CertificateError) Unwrap() error

type ConnectionState 

type ConnectionState opcua.ConnState
const (
	Closed       ConnectionState = ConnectionState(opcua.Closed)
	Connected    ConnectionState = ConnectionState(opcua.Connected)
	Connecting   ConnectionState = ConnectionState(opcua.Connecting)
	Disconnected ConnectionState = ConnectionState(opcua.Disconnected)
	Reconnecting ConnectionState = ConnectionState(opcua.Reconnecting)
)

func (ConnectionState) String added in v1.27.2 

func (c ConnectionState) String() string

type DebugLogger added in v1.29.3 

type DebugLogger struct {
	Log telegraf.Logger
}

DebugLogger logs messages from opcua at the debug level.

func (*DebugLogger) Write added in v1.29.3 

func (l *DebugLogger) Write(p []byte) (n int, err error)

type EndpointError added in v1.36.0 

type EndpointError struct {
	Endpoint string
	Err      error
}

EndpointError represents an error related to endpoint configuration

func (*EndpointError) Error added in v1.36.0 

func (e *EndpointError) Error() string

func (*EndpointError) Unwrap added in v1.36.0 

func (e *EndpointError) Unwrap() error

type OpcUAClient 

type OpcUAClient struct {
	Config *OpcUAClientConfig
	Log    telegraf.Logger

	Client *opcua.Client
	// contains filtered or unexported fields
}

func (*OpcUAClient) Connect 

func (o *OpcUAClient) Connect(ctx context.Context) error

Connect to an OPC UA device

func (*OpcUAClient) Disconnect 

func (o *OpcUAClient) Disconnect(ctx context.Context) error

func (*OpcUAClient) SetupOptions added in v1.25.1 

func (o *OpcUAClient) SetupOptions() error

SetupOptions reads the endpoints from the specified server and sets up all authentication

func (*OpcUAClient) State 

func (o *OpcUAClient) State() ConnectionState

func (*OpcUAClient) StatusCodeOK 

func (o *OpcUAClient) StatusCodeOK(code ua.StatusCode) bool

type OpcUAClientConfig 

type OpcUAClientConfig struct {
	Endpoint       string          `toml:"endpoint"`
	SecurityPolicy string          `toml:"security_policy"`
	SecurityMode   string          `toml:"security_mode"`
	Certificate    string          `toml:"certificate"`
	PrivateKey     string          `toml:"private_key"`
	Username       config.Secret   `toml:"username"`
	Password       config.Secret   `toml:"password"`
	AuthMethod     string          `toml:"auth_method"`
	ConnectTimeout config.Duration `toml:"connect_timeout"`
	RequestTimeout config.Duration `toml:"request_timeout"`
	ClientTrace    bool            `toml:"client_trace"`

	OptionalFields []string         `toml:"optional_fields"`
	Workarounds    OpcUAWorkarounds `toml:"workarounds"`
	SessionTimeout config.Duration  `toml:"session_timeout"`
}

func (*OpcUAClientConfig) CreateClient 

func (o *OpcUAClientConfig) CreateClient(telegrafLogger telegraf.Logger) (*OpcUAClient, error)

func (*OpcUAClientConfig) Validate 

func (o *OpcUAClientConfig) Validate() error

type OpcUAWorkarounds 

type OpcUAWorkarounds struct {
	AdditionalValidStatusCodes []string `toml:"additional_valid_status_codes"`
}

type SecurityError added in v1.36.0 

type SecurityError struct {
	Policy string
	Mode   string
	Err    error
}

SecurityError represents an error related to security configuration

func (*SecurityError) Error added in v1.36.0 

func (e *SecurityError) Error() string

func (*SecurityError) Unwrap added in v1.36.0 

func (e *SecurityError) Unwrap() error

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.