model

type ArrayInfo interface {
	fmt.Stringer
	GetSize() uint32
	GetLowerBound() uint32
	GetUpperBound() uint32
}

type PlcBrowseItem interface {
	fmt.Stringer

	GetTag() PlcTag

	GetName() string
	IsReadable() bool
	IsWritable() bool
	IsSubscribable() bool
	GetChildren() map[string]PlcBrowseItem
	GetOptions() map[string]values.PlcValue
}

type PlcBrowseRequest interface {
	PlcRequest

	// Execute Will not return until a potential scan is finished and will return all results in one block
	Execute(ctx context.Context) <-chan PlcBrowseRequestResult
	// ExecuteWithInterceptor Will call the given callback for every found resource
	ExecuteWithInterceptor(ctx context.Context, interceptor func(result PlcBrowseItem) bool) <-chan PlcBrowseRequestResult

	GetQueryNames() []string
	GetQuery(queryName string) PlcQuery
}

type PlcBrowseRequestBuilder interface {
	fmt.Stringer

	AddQuery(name string, query string) PlcBrowseRequestBuilder
	Build() (PlcBrowseRequest, error)
}

type PlcBrowseRequestResult interface {
	fmt.Stringer

	GetRequest() PlcBrowseRequest
	GetResponse() PlcBrowseResponse
	GetErr() error
}

type PlcBrowseResponse interface {
	PlcResponse

	GetRequest() PlcBrowseRequest
	GetQueryNames() []string
	GetResponseCode(name string) PlcResponseCode
	GetQueryResults(name string) []PlcBrowseItem
}

type PlcConnectionMetadata interface {
	fmt.Stringer
	// GetConnectionAttributes Gives access to a map of additional information the driver might be able to provide.
	GetConnectionAttributes() map[string]string
	// CanRead Indicates that the connection supports reading.
	CanRead() bool
	// CanWrite Indicates that the connection supports writing.
	CanWrite() bool
	// CanSubscribe Indicates that the connection supports subscription.
	CanSubscribe() bool
	// CanBrowse Indicates that the connection supports browsing.
	CanBrowse() bool
}

type PlcConsumerRegistration interface {
	GetConsumerId() int
	GetSubscriptionHandles() []PlcSubscriptionHandle
	Unregister()
}

type PlcDiscoveryItem interface {
	fmt.Stringer
	GetProtocolCode() string
	GetTransportCode() string
	GetTransportUrl() url.URL
	GetOptions() map[string][]string
	GetName() string
	GetAttributes() map[string]values.PlcValue
	GetConnectionUrl() string
}

type PlcMessage interface {
	fmt.Stringer
	IsAPlcMessage() bool
}

type PlcQuery interface {
	GetQueryString() string
}

type PlcReadRequest interface {
	PlcRequest

	Execute(ctx context.Context) <-chan PlcReadRequestResult

	GetTagNames() []string
	GetTag(tagName string) PlcTag
}

type PlcReadRequestBuilder interface {
	fmt.Stringer
	AddTagAddress(tagName string, tagAddress string) PlcReadRequestBuilder
	AddTag(tagName string, tag PlcTag) PlcReadRequestBuilder
	Build() (PlcReadRequest, error)
}

type PlcReadRequestResult interface {
	fmt.Stringer
	GetRequest() PlcReadRequest
	GetResponse() PlcReadResponse
	GetErr() error
}

type PlcReadResponse interface {
	PlcResponse
	GetRequest() PlcReadRequest
	GetTagNames() []string
	GetResponseCode(tagName string) PlcResponseCode
	GetValue(tagName string) values.PlcValue
}

type PlcRequest interface {
	PlcMessage
}

type PlcResponse interface {
	PlcMessage
}

type PlcResponseCode uint8

type PlcSubscriptionEvent interface {
	PlcResponse
	// GetTagNames returns all tag names which can be found in this event
	GetTagNames() []string
	// GetResponseCode returns the PlcResponseCode for a tag
	GetResponseCode(tagName string) PlcResponseCode
	// GetAddress returns the address for an event. This is meant to for reading or writing one item.
	// Sometimes there are tags which can't be directly addressed (e.g. only through a broadcast).
	// In that case (if applicable) the GetSource contains the source information about the sending device.
	GetAddress(tagName string) string
	// GetSource returns usually the same as GetAddress in case when the address contains information about the source.
	// If we have a tag which is not directly addressable (see doc for GetAddress) the source is useful to identify the device.
	GetSource(tagName string) string
	// GetValue returns the tag value for a named tag.
	GetValue(tagName string) values.PlcValue
}

type PlcSubscriptionEventConsumer func(event PlcSubscriptionEvent)

type PlcSubscriptionHandle interface {
	fmt.Stringer
	Register(consumer PlcSubscriptionEventConsumer) PlcConsumerRegistration
}

type PlcSubscriptionRequest interface {
	PlcRequest

	Execute(ctx context.Context) <-chan PlcSubscriptionRequestResult

	GetTagNames() []string
	GetTag(tagName string) PlcSubscriptionTag
}

type PlcSubscriptionRequestBuilder interface {
	AddCyclicTagAddress(tagName string, tagAddress string, interval time.Duration) PlcSubscriptionRequestBuilder
	AddCyclicTag(tagName string, tag PlcSubscriptionTag, interval time.Duration) PlcSubscriptionRequestBuilder
	AddChangeOfStateTagAddress(tagName string, tagAddress string) PlcSubscriptionRequestBuilder
	AddChangeOfStateTag(tagName string, tag PlcSubscriptionTag) PlcSubscriptionRequestBuilder
	AddEventTagAddress(tagName string, tagAddress string) PlcSubscriptionRequestBuilder
	AddEventTag(tagName string, tag PlcSubscriptionTag) PlcSubscriptionRequestBuilder
	AddPreRegisteredConsumer(tagName string, consumer PlcSubscriptionEventConsumer) PlcSubscriptionRequestBuilder
	Build() (PlcSubscriptionRequest, error)
}

type PlcSubscriptionRequestResult interface {
	GetRequest() PlcSubscriptionRequest
	GetResponse() PlcSubscriptionResponse
	GetErr() error
}

type PlcSubscriptionResponse interface {
	fmt.Stringer
	GetRequest() PlcSubscriptionRequest
	GetTagNames() []string
	GetResponseCode(name string) PlcResponseCode
	GetSubscriptionHandle(name string) (PlcSubscriptionHandle, error)
	GetSubscriptionHandles() []PlcSubscriptionHandle
}

type PlcSubscriptionTag interface {
	PlcTag
	GetPlcSubscriptionType() PlcSubscriptionType
	GetDuration() time.Duration
}

type PlcSubscriptionType uint8

type PlcTag interface {
	fmt.Stringer
	GetAddressString() string
	GetValueType() values.PlcValueType
	GetArrayInfo() []ArrayInfo
}

type PlcUnsubscriptionRequest interface {
	PlcRequest
	Execute(ctx context.Context) <-chan PlcUnsubscriptionRequestResult
}

type PlcUnsubscriptionRequestBuilder interface {
	fmt.Stringer
	AddHandles(handles ...PlcSubscriptionHandle) PlcUnsubscriptionRequestBuilder
	Build() (PlcUnsubscriptionRequest, error)
}

type PlcUnsubscriptionRequestResult interface {
	fmt.Stringer
	GetRequest() PlcUnsubscriptionRequest
	GetResponse() PlcUnsubscriptionResponse
	GetErr() error
}

type PlcUnsubscriptionResponse interface {
	fmt.Stringer
	GetRequest() PlcUnsubscriptionRequest
}

type PlcWriteRequest interface {
	PlcRequest

	Execute(ctx context.Context) <-chan PlcWriteRequestResult

	GetTagNames() []string
	GetTag(tagName string) PlcTag
	GetValue(tagName string) values.PlcValue
}

type PlcWriteRequestBuilder interface {
	fmt.Stringer

	AddTagAddress(tagName string, tagAddress string, value any) PlcWriteRequestBuilder
	AddTag(tagName string, tag PlcTag, value any) PlcWriteRequestBuilder
	Build() (PlcWriteRequest, error)
}

type PlcWriteRequestResult interface {
	fmt.Stringer

	GetRequest() PlcWriteRequest
	GetResponse() PlcWriteResponse
	GetErr() error
}

type PlcWriteResponse interface {
	PlcResponse
	GetRequest() PlcWriteRequest
	GetTagNames() []string
	GetResponseCode(tagName string) PlcResponseCode
}