refactor(plc4go): streamlined plc_browse api

plc4go/examples/knx/discovery/hello_world_plc4go_knx_discovery.go

@@ -70,9 +70,9 @@ func main() {
 
 		// Try to find all KNX devices on the current network
 		browseRequest, err := connection.BrowseRequestBuilder().
-			AddItem("allDevices", "[1-15].[1-15].[0-255]").
-			//AddItem("allMyDevices", "[1-3].[1-6].[0-60]").
-			//AddItem("onlyOneDevice", "1.1.20")
+			AddQuery("allDevices", "[1-15].[1-15].[0-255]").
+			//AddQuery("allMyDevices", "[1-3].[1-6].[0-60]").
+			//AddQuery("onlyOneDevice", "1.1.20")
 			Build()
 		if err != nil {
 			log.Error().Err(err).Msg("error creating browse request")
@@ -85,7 +85,7 @@ func main() {
 
 			// Try to get all the com-objects and the group addresses they are attached to.
 			browseRequest, err := connection.BrowseRequestBuilder().
-				AddItem("comObjects", knxAddress+"#com-obj").
+				AddQuery("comObjects", knxAddress+"#com-obj").
 				Build()
 			if err != nil {
 				log.Error().Err(err).Msg("error creating read request")

plc4go/internal/cbus/Browser.go

@@ -0,0 +1,54 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package cbus
+
+import (
+	"github.com/apache/plc4x/plc4go/internal/spi"
+	apiModel "github.com/apache/plc4x/plc4go/pkg/api/model"
+)
+
+type Browser struct {
+	connection      *Connection
+	messageCodec    spi.MessageCodec
+	sequenceCounter uint8
+}
+
+func NewBrowser(connection *Connection, messageCodec spi.MessageCodec) *Browser {
+	return &Browser{
+		connection:      connection,
+		messageCodec:    messageCodec,
+		sequenceCounter: 0,
+	}
+}
+
+func (m Browser) Browse(browseRequest apiModel.PlcBrowseRequest) <-chan apiModel.PlcBrowseRequestResult {
+	return m.BrowseWithInterceptor(browseRequest, func(result apiModel.PlcBrowseEvent) bool {
+		return true
+	})
+}
+
+func (m Browser) BrowseWithInterceptor(browseRequest apiModel.PlcBrowseRequest, interceptor func(result apiModel.PlcBrowseEvent) bool) <-chan apiModel.PlcBrowseRequestResult {
+	result := make(chan apiModel.PlcBrowseRequestResult)
+
+	go func() {
+		// TODO: implement me
+	}()
+	return result
+}

plc4go/internal/cbus/Connection.go

@@ -157,8 +157,7 @@ func (c *Connection) UnsubscriptionRequestBuilder() apiModel.PlcUnsubscriptionRe
 }
 
 func (c *Connection) BrowseRequestBuilder() apiModel.PlcBrowseRequestBuilder {
-	// TODO: where do we get the browser from
-	return internalModel.NewDefaultPlcBrowseRequestBuilder(nil)
+	return internalModel.NewDefaultPlcBrowseRequestBuilder(NewBrowser(c, c.messageCodec))
 }
 
 func (c *Connection) addSubscriber(subscriber *Subscriber) {

plc4go/internal/knxnetip/Browser.go

@@ -67,43 +67,38 @@ func (m Browser) BrowseWithInterceptor(browseRequest apiModel.PlcBrowseRequest,
 	}
 
 	go func() {
-		results := map[string][]apiModel.PlcBrowseQueryResult{}
-		for _, queryName := range browseRequest.GetQueryNames() {
-			queryString := browseRequest.GetQueryString(queryName)
-			field, err := m.connection.fieldHandler.ParseQuery(queryString)
-			if err != nil {
-				sendResult(nil, err)
-				return
-			}
+		responseCodes := map[string]apiModel.PlcResponseCode{}
+		results := map[string][]apiModel.PlcBrowseFoundField{}
+		for _, fieldName := range browseRequest.GetFieldNames() {
+			field := browseRequest.GetField(fieldName)
 
 			switch field.(type) {
 			case DeviceQueryField:
-				queryResults, err := m.executeDeviceQuery(field.(DeviceQueryField), browseRequest, queryName, interceptor)
+				queryResults, err := m.executeDeviceQuery(field.(DeviceQueryField), browseRequest, fieldName, interceptor)
 				if err != nil {
-					// TODO: Return some sort of return code like with the read and write APIs
-					results[queryName] = nil
+					log.Warn().Err(err).Msg("Error executing device query")
+					responseCodes[fieldName] = apiModel.PlcResponseCode_INTERNAL_ERROR
 				} else {
-					results[queryName] = queryResults
+					results[fieldName] = queryResults
 				}
 			case CommunicationObjectQueryField:
 				queryResults, err := m.executeCommunicationObjectQuery(field.(CommunicationObjectQueryField))
 				if err != nil {
-					// TODO: Return some sort of return code like with the read and write APIs
-					results[queryName] = nil
+					log.Warn().Err(err).Msg("Error executing device query")
+					responseCodes[fieldName] = apiModel.PlcResponseCode_INTERNAL_ERROR
 				} else {
-					results[queryName] = queryResults
+					results[fieldName] = queryResults
 				}
 			default:
-				// TODO: Return some sort of return code like with the read and write APIs
-				results[queryName] = nil
+				responseCodes[fieldName] = apiModel.PlcResponseCode_INTERNAL_ERROR
 			}
 		}
-		sendResult(model.NewDefaultPlcBrowseResponse(browseRequest, results), nil)
+		sendResult(model.NewDefaultPlcBrowseResponse(browseRequest, results, responseCodes), nil)
 	}()
 	return result
 }
 
-func (m Browser) executeDeviceQuery(field DeviceQueryField, browseRequest apiModel.PlcBrowseRequest, queryName string, interceptor func(result apiModel.PlcBrowseEvent) bool) ([]apiModel.PlcBrowseQueryResult, error) {
+func (m Browser) executeDeviceQuery(field DeviceQueryField, browseRequest apiModel.PlcBrowseRequest, fieldName string, interceptor func(result apiModel.PlcBrowseEvent) bool) ([]apiModel.PlcBrowseFoundField, error) {
 	// Create a list of address strings, which doesn't contain any ranges, lists or wildcards
 	knxAddresses, err := m.calculateAddresses(field)
 	if err != nil {
@@ -113,7 +108,7 @@ func (m Browser) executeDeviceQuery(field DeviceQueryField, browseRequest apiMod
 		return nil, errors.New("query resulted in not a single valid address")
 	}
 
-	var queryResults []apiModel.PlcBrowseQueryResult
+	var queryResults []apiModel.PlcBrowseFoundField
 	// Parse each of these expanded addresses and handle them accordingly.
 	for _, knxAddress := range knxAddresses {
 		// Send a connection request to the device
@@ -141,7 +136,7 @@ func (m Browser) executeDeviceQuery(field DeviceQueryField, browseRequest apiMod
 				if interceptor != nil {
 					add = interceptor(&model.DefaultPlcBrowseEvent{
 						Request:   browseRequest,
-						QueryName: queryName,
+						FieldName: fieldName,
 						Result:    queryResult,
 						Err:       nil,
 					})
@@ -174,8 +169,8 @@ func (m Browser) executeDeviceQuery(field DeviceQueryField, browseRequest apiMod
 	return queryResults, nil
 }
 
-func (m Browser) executeCommunicationObjectQuery(field CommunicationObjectQueryField) ([]apiModel.PlcBrowseQueryResult, error) {
-	var results []apiModel.PlcBrowseQueryResult
+func (m Browser) executeCommunicationObjectQuery(field CommunicationObjectQueryField) ([]apiModel.PlcBrowseFoundField, error) {
+	var results []apiModel.PlcBrowseFoundField
 
 	knxAddress := field.toKnxAddress()
 	knxAddressString := KnxAddressToString(knxAddress)
@@ -404,7 +399,7 @@ func (m Browser) executeCommunicationObjectQuery(field CommunicationObjectQueryF
 				continue
 			}
 
-			// Assemble a PlcBrowseQueryResult
+			// Assemble a PlcBrowseFoundField
 			var field apiModel.PlcField
 			communicationEnable := descriptor.GetCommunicationEnable()
 			readable := communicationEnable && descriptor.GetReadEnable()

plc4go/internal/spi/model/DefaultPlcBrowseEvent.go

@@ -23,20 +23,20 @@ import "github.com/apache/plc4x/plc4go/pkg/api/model"
 
 type DefaultPlcBrowseEvent struct {
 	Request   model.PlcBrowseRequest
-	QueryName string
-	Result    model.PlcBrowseQueryResult
+	FieldName string
+	Result    model.PlcBrowseFoundField
 	Err       error
 }
 
 func (d *DefaultPlcBrowseEvent) GetRequest() model.PlcBrowseRequest {
 	return d.Request
 }
 
-func (d *DefaultPlcBrowseEvent) GetQueryName() string {
-	return d.QueryName
+func (d *DefaultPlcBrowseEvent) GetFieldName() string {
+	return d.FieldName
 }
 
-func (d *DefaultPlcBrowseEvent) GetResult() model.PlcBrowseQueryResult {
+func (d *DefaultPlcBrowseEvent) GetResult() model.PlcBrowseFoundField {
 	return d.Result
 }
 

plc4go/internal/spi/model/DefaultPlcBrowseQueryResult.go

@@ -19,7 +19,10 @@
 
 package model
 
-import "github.com/apache/plc4x/plc4go/pkg/api/model"
+import (
+	"github.com/apache/plc4x/plc4go/pkg/api/model"
+	"github.com/apache/plc4x/plc4go/pkg/api/values"
+)
 
 type DefaultPlcBrowseQueryResult struct {
 	Field             model.PlcField
@@ -28,6 +31,7 @@ type DefaultPlcBrowseQueryResult struct {
 	Writable          bool
 	Subscribable      bool
 	PossibleDataTypes []string
+	Attributes        map[string]values.PlcValue
 }
 
 func (d *DefaultPlcBrowseQueryResult) GetField() model.PlcField {
@@ -53,3 +57,7 @@ func (d *DefaultPlcBrowseQueryResult) IsSubscribable() bool {
 func (d *DefaultPlcBrowseQueryResult) GetPossibleDataTypes() []string {
 	return d.PossibleDataTypes
 }
+
+func (d *DefaultPlcBrowseQueryResult) GetAttributes() map[string]values.PlcValue {
+	return d.Attributes
+}