Added aliases for some types from internal folder

nexcode · nexcode · commit 84b714545097 · 2025-10-30T12:23:18.000Z
diff --git a/attributes.go b/attributes.go
@@ -0,0 +1,29 @@
+/*
+ * Copyright 2025 RPCPlatform Authors
+ *
+ * Licensed 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
+ *
+ *     http://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 rpcplatform
+
+import (
+	"github.com/nexcode/rpcplatform/internal/attributes"
+)
+
+// NewAttributes returns attributes with default values.
+func NewAttributes() *Attributes {
+	return attributes.New()
+}
+
+// Attributes provides server attribute values.
+type Attributes = attributes.Attributes
diff --git a/client.go b/client.go
@@ -22,6 +22,7 @@ import (
 )
 
 type Client struct {
+	id       string
 	target   string
 	client   *grpc.ClientConn
 	resolver *manual.Resolver
diff --git a/client_id.go b/client_id.go
@@ -14,13 +14,9 @@
  * limitations under the License.
  */
 
-package serverinfo
+package rpcplatform
 
-import (
-	"github.com/nexcode/rpcplatform/attributes"
-)
-
-type ServerInfo struct {
-	Address    string
-	Attributes *attributes.Attributes
+// ID return the client identifier.
+func (c *Client) ID() string {
+	return c.id
 }
diff --git a/client_updatestate.go b/client_updatestate.go
@@ -17,12 +17,11 @@
 package rpcplatform
 
 import (
-	"github.com/nexcode/rpcplatform/internal/serverinfo"
 	"google.golang.org/grpc/attributes"
 	"google.golang.org/grpc/resolver"
 )
 
-func (c *Client) updateState(init bool, serverInfoTree map[string]*serverinfo.ServerInfo) {
+func (c *Client) updateState(init bool, serverInfoTree map[string]*ServerInfo) {
 	state := resolver.State{
 		Addresses: make([]resolver.Address, 0, len(serverInfoTree)),
 	}
diff --git a/examples/attributes/client/main.go b/examples/attributes/client/main.go
@@ -24,7 +24,6 @@ import (
 
 	"github.com/nexcode/rpcplatform"
 	"github.com/nexcode/rpcplatform/examples/quickstart/proto"
-	"github.com/nexcode/rpcplatform/options"
 	etcd "go.etcd.io/etcd/client/v3"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/credentials/insecure"
@@ -40,16 +39,16 @@ func main() {
 	}
 
 	rpcp, err := rpcplatform.New("rpcplatform", etcdClient,
-		options.Platform.ClientOptions(
-			options.Client.GRPCOptions(grpc.WithTransportCredentials(insecure.NewCredentials())),
+		rpcplatform.PlatformOptions.ClientOptions(
+			rpcplatform.ClientOptions.GRPCOptions(grpc.WithTransportCredentials(insecure.NewCredentials())),
 		),
 	)
 
 	if err != nil {
 		panic(err)
 	}
 
-	client, err := rpcp.NewClient("server", options.Client.MaxActiveServers(2))
+	client, err := rpcp.NewClient("server", rpcplatform.ClientOptions.MaxActiveServers(2))
 	if err != nil {
 		panic(err)
 	}
diff --git a/examples/attributes/server/main.go b/examples/attributes/server/main.go
@@ -21,9 +21,7 @@ import (
 	"fmt"
 
 	"github.com/nexcode/rpcplatform"
-	"github.com/nexcode/rpcplatform/attributes"
 	"github.com/nexcode/rpcplatform/examples/quickstart/proto"
-	"github.com/nexcode/rpcplatform/options"
 	etcd "go.etcd.io/etcd/client/v3"
 )
 
@@ -57,10 +55,10 @@ func main() {
 		panic(err)
 	}
 
-	attributes := attributes.New()
+	attributes := rpcplatform.NewAttributes()
 	attributes.BalancerWeight = 4
 
-	server, err := rpcp.NewServer("server", "localhost:", options.Server.Attributes(attributes))
+	server, err := rpcp.NewServer("server", "localhost:", rpcplatform.ServerOptions.Attributes(attributes))
 	if err != nil {
 		panic(err)
 	}
diff --git a/examples/opentelemetry/client/main.go b/examples/opentelemetry/client/main.go
@@ -24,7 +24,6 @@ import (
 
 	"github.com/nexcode/rpcplatform"
 	"github.com/nexcode/rpcplatform/examples/quickstart/proto"
-	"github.com/nexcode/rpcplatform/options"
 	etcd "go.etcd.io/etcd/client/v3"
 	"go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc"
 	"go.opentelemetry.io/otel/exporters/zipkin"
@@ -56,10 +55,10 @@ func main() {
 	}
 
 	rpcp, err := rpcplatform.New("rpcplatform", etcdClient,
-		options.Platform.ClientOptions(
-			options.Client.GRPCOptions(grpc.WithTransportCredentials(insecure.NewCredentials())),
+		rpcplatform.PlatformOptions.ClientOptions(
+			rpcplatform.ClientOptions.GRPCOptions(grpc.WithTransportCredentials(insecure.NewCredentials())),
 		),
-		options.Platform.OpenTelemetry("client", 1, otlpExporter, zipkinExporter),
+		rpcplatform.PlatformOptions.OpenTelemetry("client", 1, otlpExporter, zipkinExporter),
 	)
 
 	if err != nil {
diff --git a/examples/opentelemetry/server/main.go b/examples/opentelemetry/server/main.go
@@ -22,7 +22,6 @@ import (
 
 	"github.com/nexcode/rpcplatform"
 	"github.com/nexcode/rpcplatform/examples/quickstart/proto"
-	"github.com/nexcode/rpcplatform/options"
 	etcd "go.etcd.io/etcd/client/v3"
 	"go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc"
 	"go.opentelemetry.io/otel/exporters/zipkin"
@@ -68,7 +67,7 @@ func main() {
 	}
 
 	rpcp, err := rpcplatform.New("rpcplatform", etcdClient,
-		options.Platform.OpenTelemetry("server", 1, otlpExporter, zipkinExporter),
+		rpcplatform.PlatformOptions.OpenTelemetry("server", 1, otlpExporter, zipkinExporter),
 	)
 
 	if err != nil {
diff --git a/examples/quickstart/client/main.go b/examples/quickstart/client/main.go
@@ -24,7 +24,6 @@ import (
 
 	"github.com/nexcode/rpcplatform"
 	"github.com/nexcode/rpcplatform/examples/quickstart/proto"
-	"github.com/nexcode/rpcplatform/options"
 	etcd "go.etcd.io/etcd/client/v3"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/credentials/insecure"
@@ -40,8 +39,8 @@ func main() {
 	}
 
 	rpcp, err := rpcplatform.New("rpcplatform", etcdClient,
-		options.Platform.ClientOptions(
-			options.Client.GRPCOptions(grpc.WithTransportCredentials(insecure.NewCredentials())),
+		rpcplatform.PlatformOptions.ClientOptions(
+			rpcplatform.ClientOptions.GRPCOptions(grpc.WithTransportCredentials(insecure.NewCredentials())),
 		),
 	)
 
diff --git a/internal/attributes/attributes.go b/internal/attributes/attributes.go
@@ -16,14 +16,12 @@
 
 package attributes
 
-// New returns attributes with default values.
 func New() *Attributes {
 	return &Attributes{
 		BalancerWeight: 1,
 	}
 }
 
-// Attributes provides server attribute values.
 type Attributes struct {
 	BalancerPriority int
 	BalancerWeight   int
diff --git a/internal/attributes/const.go b/internal/attributes/const.go
diff --git a/internal/attributes/load.go b/internal/attributes/load.go
@@ -18,16 +18,15 @@ package attributes
 
 import "strconv"
 
-// Load used internally to load keys and values from strings.
-func (sa *Attributes) Load(key, value string) {
+func Load(attrs *Attributes, key, value string) {
 	switch key {
 	case balancerPriority:
 		if v, err := strconv.Atoi(value); err == nil {
-			sa.BalancerPriority = v
+			attrs.BalancerPriority = v
 		}
 	case balancerWeight:
 		if v, err := strconv.Atoi(value); err == nil {
-			sa.BalancerWeight = v
+			attrs.BalancerWeight = v
 		}
 	}
 }
diff --git a/internal/attributes/values.go b/internal/attributes/values.go
@@ -18,10 +18,9 @@ package attributes
 
 import "strconv"
 
-// Values used internally to create an string array of keys and values.
-func (sa *Attributes) Values() []string {
+func Values(attrs *Attributes) []string {
 	return []string{
-		balancerPriority, strconv.Itoa(sa.BalancerPriority),
-		balancerWeight, strconv.Itoa(sa.BalancerWeight),
+		balancerPriority, strconv.Itoa(attrs.BalancerPriority),
+		balancerWeight, strconv.Itoa(attrs.BalancerWeight),
 	}
 }
diff --git a/internal/balancer/pickerbuilder_makeconninfo.go b/internal/balancer/pickerbuilder_makeconninfo.go
@@ -21,7 +21,7 @@ import (
 	"math"
 	"slices"
 
-	"github.com/nexcode/rpcplatform/attributes"
+	"github.com/nexcode/rpcplatform/internal/attributes"
 	"google.golang.org/grpc/balancer"
 	"google.golang.org/grpc/balancer/base"
 )
diff --git a/internal/config/server.go b/internal/config/server.go
@@ -17,7 +17,7 @@
 package config
 
 import (
-	"github.com/nexcode/rpcplatform/attributes"
+	"github.com/nexcode/rpcplatform/internal/attributes"
 	"google.golang.org/grpc"
 )
 
diff --git a/internal/options/client.go b/internal/options/client.go
@@ -21,22 +21,26 @@ import (
 	"google.golang.org/grpc"
 )
 
-// Client provides options used when creating new client.
-var Client = client{}
-
-type client struct{}
+type Client struct{}
 
 // MaxActiveServers sets the maximum number of active servers the client will connect to.
 // If there are more servers than this value, no requests will be made to them.
-func (client) MaxActiveServers(count int) func(*config.Client) {
+func (Client) MaxActiveServers(count int) func(*config.Client) {
 	return func(c *config.Client) {
 		c.MaxActiveServers = count
 	}
 }
 
 // GRPCOptions provide []grpc.DialOption to the client.
-func (client) GRPCOptions(options ...grpc.DialOption) func(*config.Client) {
+func (Client) GRPCOptions(options ...grpc.DialOption) func(*config.Client) {
 	return func(c *config.Client) {
 		c.GRPCOptions = append(c.GRPCOptions, options...)
 	}
 }
+
+// var Client ClientOption = client{}
+
+// type ClientOption interface {
+// 	MaxActiveServers(count int) func(*config.Client)
+// 	GRPCOptions(options ...grpc.DialOption) func(*config.Client)
+// }
diff --git a/internal/options/platform.go b/internal/options/platform.go
@@ -21,27 +21,24 @@ import (
 	"go.opentelemetry.io/otel/sdk/trace"
 )
 
-// Platform provides options used when creating new RPCPlatform.
-var Platform = platform{}
-
-type platform struct{}
+type Platform struct{}
 
 // ClientOptions sets global settings for new clients that can be overwritten by local settings for each client.
-func (platform) ClientOptions(options ...func(*config.Client)) func(*config.Platform) {
+func (Platform) ClientOptions(options ...func(*config.Client)) func(*config.Platform) {
 	return func(c *config.Platform) {
 		c.ClientOptions = append(c.ClientOptions, options...)
 	}
 }
 
 // ServerOptions sets global settings for new servers that can be overwritten by local settings for each server.
-func (platform) ServerOptions(options ...func(*config.Server)) func(*config.Platform) {
+func (Platform) ServerOptions(options ...func(*config.Server)) func(*config.Platform) {
 	return func(c *config.Platform) {
 		c.ServerOptions = append(c.ServerOptions, options...)
 	}
 }
 
 // OpenTelemetry configures OpenTelemetry settings for clients and servers.
-func (platform) OpenTelemetry(serviceName string, sampleRate float64, exporters ...trace.SpanExporter) func(*config.Platform) {
+func (Platform) OpenTelemetry(serviceName string, sampleRate float64, exporters ...trace.SpanExporter) func(*config.Platform) {
 	return func(c *config.Platform) {
 		c.OpenTelemetry = &config.OpenTelemetry{
 			ServiceName: serviceName,
diff --git a/internal/options/server.go b/internal/options/server.go
@@ -17,32 +17,29 @@
 package options
 
 import (
-	"github.com/nexcode/rpcplatform/attributes"
+	"github.com/nexcode/rpcplatform/internal/attributes"
 	"github.com/nexcode/rpcplatform/internal/config"
 	"google.golang.org/grpc"
 )
 
-// Server provides options used when creating new server.
-var Server = server{}
-
-type server struct{}
+type Server struct{}
 
 // PublicAddr is used when the server is not accessible to clients at the address it is located at.
-func (server) PublicAddr(publicAddr string) func(*config.Server) {
+func (Server) PublicAddr(publicAddr string) func(*config.Server) {
 	return func(c *config.Server) {
 		c.PublicAddr = publicAddr
 	}
 }
 
 // Attributes are server settings that are accessible via the API.
-func (server) Attributes(attributes *attributes.Attributes) func(*config.Server) {
+func (Server) Attributes(attributes *attributes.Attributes) func(*config.Server) {
 	return func(c *config.Server) {
 		c.Attributes = attributes
 	}
 }
 
 // GRPCOptions provide []grpc.ServerOption to the server.
-func (server) GRPCOptions(options ...grpc.ServerOption) func(*config.Server) {
+func (Server) GRPCOptions(options ...grpc.ServerOption) func(*config.Server) {
 	return func(c *config.Server) {
 		c.GRPCOptions = append(c.GRPCOptions, options...)
 	}
diff --git a/option.go b/option.go
@@ -0,0 +1,30 @@
+/*
+ * Copyright 2025 RPCPlatform Authors
+ *
+ * Licensed 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
+ *
+ *     http://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 rpcplatform
+
+import (
+	"github.com/nexcode/rpcplatform/internal/config"
+)
+
+// PlatformOption is used to pass [PlatformOptions] when creating a new [RPCPlatform]
+type PlatformOption = func(*config.Platform)
+
+// ClientOption is used to pass [ClientOptions] when creating a new [Client]
+type ClientOption = func(*config.Client)
+
+// ServerOption is used to pass [ServerOptions] when creating a new [Server]
+type ServerOption = func(*config.Server)
diff --git a/rpcplatform.go b/rpcplatform.go
@@ -25,7 +25,7 @@ import (
 // New creates an RPCPlatform object for further creation of clients and servers.
 // All methods of this object are thread safe. You can create this object once
 // and use it in different places in your program.
-func New(etcdPrefix string, etcdClient *etcd.Client, options ...func(*config.Platform)) (*RPCPlatform, error) {
+func New(etcdPrefix string, etcdClient *etcd.Client, options ...PlatformOption) (*RPCPlatform, error) {
 	if etcdPrefix != "" {
 		etcdPrefix = gears.FixPath(etcdPrefix)
 	}
diff --git a/rpcplatform_lookup.go b/rpcplatform_lookup.go
diff --git a/rpcplatform_newclient.go b/rpcplatform_newclient.go
diff --git a/rpcplatform_newserver.go b/rpcplatform_newserver.go
diff --git a/server.go b/server.go
diff --git a/server_serve.go b/server_serve.go
diff --git a/serverinfo.go b/serverinfo.go
diff --git a/var.go b/var.go

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@ import (`
`22`	`22`	`)`
`23`	`23`
`24`	`24`	`type Client struct {`
	`25`	`+ id string`
`25`	`26`	`target string`
`26`	`27`	`client *grpc.ClientConn`
`27`	`28`	`resolver *manual.Resolver`
Original file line number	Diff line number	Diff line change
`@@ -17,12 +17,11 @@`
`17`	`17`	`package rpcplatform`
`18`	`18`
`19`	`19`	`import (`
`20`		`- "github.com/nexcode/rpcplatform/internal/serverinfo"`
`21`	`20`	`"google.golang.org/grpc/attributes"`
`22`	`21`	`"google.golang.org/grpc/resolver"`
`23`	`22`	`)`
`24`	`23`
`25`		`-func (c Client) updateState(init bool, serverInfoTree map[string]serverinfo.ServerInfo) {`
	`24`	`+func (c Client) updateState(init bool, serverInfoTree map[string]ServerInfo) {`
`26`	`25`	`state := resolver.State{`
`27`	`26`	`Addresses: make([]resolver.Address, 0, len(serverInfoTree)),`
`28`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,6 @@ import (`
`24`	`24`
`25`	`25`	`"github.com/nexcode/rpcplatform"`
`26`	`26`	`"github.com/nexcode/rpcplatform/examples/quickstart/proto"`
`27`		`- "github.com/nexcode/rpcplatform/options"`
`28`	`27`	`etcd "go.etcd.io/etcd/client/v3"`
`29`	`28`	`"google.golang.org/grpc"`
`30`	`29`	`"google.golang.org/grpc/credentials/insecure"`
`@@ -40,16 +39,16 @@ func main() {`
`40`	`39`	`}`
`41`	`40`
`42`	`41`	`rpcp, err := rpcplatform.New("rpcplatform", etcdClient,`
`43`		`- options.Platform.ClientOptions(`
`44`		`- options.Client.GRPCOptions(grpc.WithTransportCredentials(insecure.NewCredentials())),`
	`42`	`+ rpcplatform.PlatformOptions.ClientOptions(`
	`43`	`+ rpcplatform.ClientOptions.GRPCOptions(grpc.WithTransportCredentials(insecure.NewCredentials())),`
`45`	`44`	`),`
`46`	`45`	`)`
`47`	`46`
`48`	`47`	`if err != nil {`
`49`	`48`	`panic(err)`
`50`	`49`	`}`
`51`	`50`
`52`		`- client, err := rpcp.NewClient("server", options.Client.MaxActiveServers(2))`
	`51`	`+ client, err := rpcp.NewClient("server", rpcplatform.ClientOptions.MaxActiveServers(2))`
`53`	`52`	`if err != nil {`
`54`	`53`	`panic(err)`
`55`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,9 +21,7 @@ import (`
`21`	`21`	`"fmt"`
`22`	`22`
`23`	`23`	`"github.com/nexcode/rpcplatform"`
`24`		`- "github.com/nexcode/rpcplatform/attributes"`
`25`	`24`	`"github.com/nexcode/rpcplatform/examples/quickstart/proto"`
`26`		`- "github.com/nexcode/rpcplatform/options"`
`27`	`25`	`etcd "go.etcd.io/etcd/client/v3"`
`28`	`26`	`)`
`29`	`27`
`@@ -57,10 +55,10 @@ func main() {`
`57`	`55`	`panic(err)`
`58`	`56`	`}`
`59`	`57`
`60`		`- attributes := attributes.New()`
	`58`	`+ attributes := rpcplatform.NewAttributes()`
`61`	`59`	`attributes.BalancerWeight = 4`
`62`	`60`
`63`		`- server, err := rpcp.NewServer("server", "localhost:", options.Server.Attributes(attributes))`
	`61`	`+ server, err := rpcp.NewServer("server", "localhost:", rpcplatform.ServerOptions.Attributes(attributes))`
`64`	`62`	`if err != nil {`
`65`	`63`	`panic(err)`
`66`	`64`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,6 @@ import (`
`22`	`22`
`23`	`23`	`"github.com/nexcode/rpcplatform"`
`24`	`24`	`"github.com/nexcode/rpcplatform/examples/quickstart/proto"`
`25`		`- "github.com/nexcode/rpcplatform/options"`
`26`	`25`	`etcd "go.etcd.io/etcd/client/v3"`
`27`	`26`	`"go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc"`
`28`	`27`	`"go.opentelemetry.io/otel/exporters/zipkin"`
`@@ -68,7 +67,7 @@ func main() {`
`68`	`67`	`}`
`69`	`68`
`70`	`69`	`rpcp, err := rpcplatform.New("rpcplatform", etcdClient,`
`71`		`- options.Platform.OpenTelemetry("server", 1, otlpExporter, zipkinExporter),`
	`70`	`+ rpcplatform.PlatformOptions.OpenTelemetry("server", 1, otlpExporter, zipkinExporter),`
`72`	`71`	`)`
`73`	`72`
`74`	`73`	`if err != nil {`
Original file line number	Diff line number	Diff line change
`@@ -16,14 +16,12 @@`
`16`	`16`
`17`	`17`	`package attributes`
`18`	`18`
`19`		`-// New returns attributes with default values.`
`20`	`19`	`func New() *Attributes {`
`21`	`20`	`return &Attributes{`
`22`	`21`	`BalancerWeight: 1,`
`23`	`22`	`}`
`24`	`23`	`}`
`25`	`24`
`26`		`-// Attributes provides server attribute values.`
`27`	`25`	`type Attributes struct {`
`28`	`26`	`BalancerPriority int`
`29`	`27`	`BalancerWeight int`