simulated

package

v0.0.0-...-2d02f19 Latest Latest Go to latest Published: May 3, 2024 License: Apache-2.0 Imports: 22 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/apache/plc4x

Links

Open Source Insights

Documentation ¶

Index ¶

func NewDriver(_options ...options.WithOption) plc4go.PlcDriver
type Connection
- func NewConnection(device *Device, tagHandler spi.PlcTagHandler, valueHandler spi.PlcValueHandler, ...) *Connection
- func (c *Connection) BlockingClose()
- func (c *Connection) BrowseRequestBuilder() apiModel.PlcBrowseRequestBuilder
- func (c *Connection) Close() <-chan plc4go.PlcConnectionCloseResult
- func (c *Connection) Connect() <-chan plc4go.PlcConnectionConnectResult
- func (c *Connection) ConnectWithContext(_ context.Context) <-chan plc4go.PlcConnectionConnectResult
- func (c *Connection) GetConnectionId() string
- func (c *Connection) GetMetadata() apiModel.PlcConnectionMetadata
- func (c *Connection) GetTracer() tracer.Tracer
- func (c *Connection) IsConnected() bool
- func (c *Connection) IsTraceEnabled() bool
- func (c *Connection) Ping() <-chan plc4go.PlcConnectionPingResult
- func (c *Connection) ReadRequestBuilder() apiModel.PlcReadRequestBuilder
- func (c *Connection) String() string
- func (c *Connection) SubscriptionRequestBuilder() apiModel.PlcSubscriptionRequestBuilder
- func (c *Connection) UnsubscriptionRequestBuilder() apiModel.PlcUnsubscriptionRequestBuilder
- func (c *Connection) WriteRequestBuilder() apiModel.PlcWriteRequestBuilder
type Device
- func NewDevice(name string, _options ...options.WithOption) *Device
- func (d *Device) Get(tag simulatedTag) *apiValues.PlcValue
- func (d *Device) Set(tag simulatedTag, value *apiValues.PlcValue)
type Driver
- func (d *Driver) GetConnectionWithContext(ctx context.Context, _ url.URL, _ map[string]transports.Transport, ...) <-chan plc4go.PlcConnectionConnectResult
- func (d *Driver) SupportsDiscovery() bool
type Reader
- func NewReader(device *Device, readerOptions map[string][]string, tracer tracer.Tracer, ...) *Reader
- func (r *Reader) Read(_ context.Context, readRequest apiModel.PlcReadRequest) <-chan apiModel.PlcReadRequestResult
type Subscriber
- func NewSubscriber(device *Device, options map[string][]string, tracer tracer.Tracer) *Subscriber
- func (r Subscriber) Register(consumer apiModel.PlcSubscriptionEventConsumer, ...) apiModel.PlcConsumerRegistration
- func (r Subscriber) Subscribe(_ context.Context, subscriptionRequest apiModel.PlcSubscriptionRequest) <-chan apiModel.PlcSubscriptionRequestResult
- func (r Subscriber) Unregister(registration apiModel.PlcConsumerRegistration)
- func (r Subscriber) Unsubscribe(_ context.Context, unsubscriptionRequest apiModel.PlcUnsubscriptionRequest) <-chan apiModel.PlcUnsubscriptionRequestResult
type Tag
- func NewSimulatedTag(tagType TagType, name string, dataTypeSize model.SimulatedDataTypeSizes, ...) Tag
type TagHandler
- func NewTagHandler() TagHandler
- func (m TagHandler) ParseQuery(query string) (apiModel.PlcQuery, error)
- func (m TagHandler) ParseTag(tagAddress string) (apiModel.PlcTag, error)
type TagType
- func (e TagType) Name() string
type ValueHandler
- func NewValueHandler() ValueHandler
- func (v ValueHandler) NewPlcValue(tag apiModel.PlcTag, value any) (apiValues.PlcValue, error)
type Writer
- func NewWriter(device *Device, writerOptions map[string][]string, tracer tracer.Tracer, ...) *Writer
- func (w *Writer) Write(_ context.Context, writeRequest apiModel.PlcWriteRequest) <-chan apiModel.PlcWriteRequestResult

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewDriver ¶

func NewDriver(_options ...options.WithOption) plc4go.PlcDriver

Types ¶

type Connection ¶

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

func NewConnection ¶

func NewConnection(device *Device, tagHandler spi.PlcTagHandler, valueHandler spi.PlcValueHandler, connectionOptions map[string][]string, _options ...options.WithOption) *Connection

func (*Connection) BlockingClose ¶

func (c *Connection) BlockingClose()

func (*Connection) BrowseRequestBuilder ¶

func (c *Connection) BrowseRequestBuilder() apiModel.PlcBrowseRequestBuilder

func (*Connection) Close ¶

func (c *Connection) Close() <-chan plc4go.PlcConnectionCloseResult

func (*Connection) Connect ¶

func (c *Connection) Connect() <-chan plc4go.PlcConnectionConnectResult

func (*Connection) ConnectWithContext ¶

func (c *Connection) ConnectWithContext(_ context.Context) <-chan plc4go.PlcConnectionConnectResult

func (*Connection) GetConnectionId ¶

func (c *Connection) GetConnectionId() string

func (*Connection) GetMetadata ¶

func (c *Connection) GetMetadata() apiModel.PlcConnectionMetadata

func (*Connection) GetTracer ¶

func (c *Connection) GetTracer() tracer.Tracer

func (*Connection) IsConnected ¶

func (c *Connection) IsConnected() bool

func (*Connection) IsTraceEnabled ¶

func (c *Connection) IsTraceEnabled() bool

func (*Connection) Ping ¶

func (c *Connection) Ping() <-chan plc4go.PlcConnectionPingResult

func (*Connection) ReadRequestBuilder ¶

func (c *Connection) ReadRequestBuilder() apiModel.PlcReadRequestBuilder

func (*Connection) String ¶

func (c *Connection) String() string

func (*Connection) SubscriptionRequestBuilder ¶

func (c *Connection) SubscriptionRequestBuilder() apiModel.PlcSubscriptionRequestBuilder

func (*Connection) UnsubscriptionRequestBuilder ¶

func (c *Connection) UnsubscriptionRequestBuilder() apiModel.PlcUnsubscriptionRequestBuilder

func (*Connection) WriteRequestBuilder ¶

func (c *Connection) WriteRequestBuilder() apiModel.PlcWriteRequestBuilder

type Device ¶

type Device struct {
	Name  string
	State map[simulatedTag]*apiValues.PlcValue
	// contains filtered or unexported fields
}

func NewDevice ¶

func NewDevice(name string, _options ...options.WithOption) *Device

func (*Device) Get ¶

func (d *Device) Get(tag simulatedTag) *apiValues.PlcValue

func (*Device) Set ¶

func (d *Device) Set(tag simulatedTag, value *apiValues.PlcValue)

type Driver ¶

type Driver struct {
	_default.DefaultDriver
	// contains filtered or unexported fields
}

func (*Driver) GetConnectionWithContext ¶

func (d *Driver) GetConnectionWithContext(ctx context.Context, _ url.URL, _ map[string]transports.Transport, driverOptions map[string][]string) <-chan plc4go.PlcConnectionConnectResult

func (*Driver) SupportsDiscovery ¶

func (d *Driver) SupportsDiscovery() bool

SupportsDiscovery returns true if this driver supports discovery TODO: Actually the connection could support discovery to list up all tags in the Device

type Reader ¶

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

func NewReader ¶

func NewReader(device *Device, readerOptions map[string][]string, tracer tracer.Tracer, _options ...options.WithOption) *Reader

func (*Reader) Read ¶

func (r *Reader) Read(_ context.Context, readRequest apiModel.PlcReadRequest) <-chan apiModel.PlcReadRequestResult

type Subscriber ¶

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

func NewSubscriber ¶

func NewSubscriber(device *Device, options map[string][]string, tracer tracer.Tracer) *Subscriber

func (Subscriber) Register ¶

func (r Subscriber) Register(consumer apiModel.PlcSubscriptionEventConsumer, handles []apiModel.PlcSubscriptionHandle) apiModel.PlcConsumerRegistration

func (r Subscriber) Subscribe(_ context.Context, subscriptionRequest apiModel.PlcSubscriptionRequest) <-chan apiModel.PlcSubscriptionRequestResult

func (Subscriber) Unregister ¶

func (r Subscriber) Unregister(registration apiModel.PlcConsumerRegistration)

func (Subscriber) Unsubscribe ¶

func (r Subscriber) Unsubscribe(_ context.Context, unsubscriptionRequest apiModel.PlcUnsubscriptionRequest) <-chan apiModel.PlcUnsubscriptionRequestResult

type Tag ¶

type Tag interface {
	apiModel.PlcTag

	GetTagType() TagType
	GetName() string
	GetDataTypeSize() model.SimulatedDataTypeSizes
}

func NewSimulatedTag ¶

func NewSimulatedTag(tagType TagType, name string, dataTypeSize model.SimulatedDataTypeSizes, quantity uint16) Tag

type TagHandler ¶

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

func NewTagHandler ¶

func NewTagHandler() TagHandler

func (TagHandler) ParseQuery ¶

func (m TagHandler) ParseQuery(query string) (apiModel.PlcQuery, error)

func (TagHandler) ParseTag ¶

func (m TagHandler) ParseTag(tagAddress string) (apiModel.PlcTag, error)

type TagType ¶

type TagType uint8

const (
	TagRandom TagType = iota
	TagState
	TagStdOut
)

func (TagType) Name ¶

func (e TagType) Name() string

type ValueHandler ¶

type ValueHandler struct {
}

func NewValueHandler ¶

func NewValueHandler() ValueHandler

func (ValueHandler) NewPlcValue ¶

func (v ValueHandler) NewPlcValue(tag apiModel.PlcTag, value any) (apiValues.PlcValue, error)

type Writer ¶

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

func NewWriter ¶

func NewWriter(device *Device, writerOptions map[string][]string, tracer tracer.Tracer, _options ...options.WithOption) *Writer

func (*Writer) Write ¶

func (w *Writer) Write(_ context.Context, writeRequest apiModel.PlcWriteRequest) <-chan apiModel.PlcWriteRequestResult

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL