chore: update readme (#94)

Signed-off-by: Yashash H L <[email protected]>
numaproj · Jan 4, 2024 · 133ef26 · 133ef26
1 parent 2903e27
commit 133ef26
Show file tree

Hide file tree

Showing 19 changed files with 23 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -4,6 +4,8 @@ This SDK provides the interfaces to implement [Numaflow](https://github.com/numa
 Source Transformer, Functions, Sinks or SideInputs in Golang.
 - Implement [User Defined Sources](https://pkg.go.dev/github.com/numaproj/numaflow-go/pkg/sourcer)
 - Implement [User Defined Source Transformers](https://pkg.go.dev/github.com/numaproj/numaflow-go/pkg/sourcetransformer)
-- Implement [User Defined Functions](https://pkg.go.dev/github.com/numaproj/numaflow-go/pkg/function)
-- Implement [User Defined Sinks](https://pkg.go.dev/github.com/numaproj/numaflow-go/pkg/sink)
+- Implement User Defined Functions
+  - [Map](https://pkg.go.dev/github.com/numaproj/numaflow-go/pkg/mapper)
+  - [Reduce](https://pkg.go.dev/github.com/numaproj/numaflow-go/pkg/reducer)
+- Implement [User Defined Sinks](https://pkg.go.dev/github.com/numaproj/numaflow-go/pkg/sinker)
 - Implement [User Defined SideInputs](https://pkg.go.dev/github.com/numaproj/numaflow-go/pkg/sideinput)
diff --git a/pkg/mapper/options.go b/pkg/mapper/options.go
@@ -13,7 +13,7 @@ type options struct {
 // Option is the interface to apply options.
 type Option func(*options)
 
-func DefaultOptions() *options {
+func defaultOptions() *options {
 	return &options{
 		sockAddr:           address,
 		maxMessageSize:     defaultMaxMessageSize,

diff --git a/pkg/mapper/server.go b/pkg/mapper/server.go
@@ -20,7 +20,7 @@ type server struct {
 
 // NewServer creates a new map server.
 func NewServer(m Mapper, inputOptions ...Option) numaflow.Server {
-	opts := DefaultOptions()
+	opts := defaultOptions()
 	for _, inputOption := range inputOptions {
 		inputOption(opts)
 	}

diff --git a/pkg/mapstreamer/options.go b/pkg/mapstreamer/options.go
@@ -13,7 +13,7 @@ type options struct {
 // Option is the interface to apply options.
 type Option func(*options)
 
-func DefaultOptions() *options {
+func defaultOptions() *options {
 	return &options{
 		sockAddr:           address,
 		maxMessageSize:     defaultMaxMessageSize,

diff --git a/pkg/mapstreamer/server.go b/pkg/mapstreamer/server.go
@@ -19,7 +19,7 @@ type server struct {
 
 // NewServer creates a new map streaming server.
 func NewServer(ms MapStreamer, inputOptions ...Option) numaflow.Server {
-	opts := DefaultOptions()
+	opts := defaultOptions()
 	for _, inputOption := range inputOptions {
 		inputOption(opts)
 	}

diff --git a/pkg/reducer/options.go b/pkg/reducer/options.go
@@ -13,7 +13,7 @@ type options struct {
 // Option is the interface to apply options.
 type Option func(*options)
 
-func DefaultOptions() *options {
+func defaultOptions() *options {
 	return &options{
 		sockAddr:           address,
 		maxMessageSize:     defaultMaxMessageSize,

diff --git a/pkg/reducer/server.go b/pkg/reducer/server.go
@@ -19,7 +19,7 @@ type server struct {
 
 // NewServer creates a new reduce server.
 func NewServer(r ReducerCreator, inputOptions ...Option) numaflow.Server {
-	opts := DefaultOptions()
+	opts := defaultOptions()
 	for _, inputOption := range inputOptions {
 		inputOption(opts)
 	}

diff --git a/pkg/reducestreamer/options.go b/pkg/reducestreamer/options.go
@@ -13,7 +13,7 @@ type options struct {
 // Option is the interface to apply options.
 type Option func(*options)
 
-func DefaultOptions() *options {
+func defaultOptions() *options {
 	return &options{
 		sockAddr:           address,
 		maxMessageSize:     defaultMaxMessageSize,

diff --git a/pkg/reducestreamer/server.go b/pkg/reducestreamer/server.go
@@ -19,7 +19,7 @@ type server struct {
 
 // NewServer creates a new reduceStream server.
 func NewServer(r ReduceStreamerCreator, inputOptions ...Option) numaflow.Server {
-	opts := DefaultOptions()
+	opts := defaultOptions()
 	for _, inputOption := range inputOptions {
 		inputOption(opts)
 	}

diff --git a/pkg/sessionreducer/options.go b/pkg/sessionreducer/options.go
@@ -13,7 +13,7 @@ type options struct {
 // Option is the interface to apply options.
 type Option func(*options)
 
-func DefaultOptions() *options {
+func defaultOptions() *options {
 	return &options{
 		sockAddr:           address,
 		maxMessageSize:     defaultMaxMessageSize,

diff --git a/pkg/sessionreducer/server.go b/pkg/sessionreducer/server.go
@@ -19,7 +19,7 @@ type server struct {
 
 // NewServer creates a new session reduce server.
 func NewServer(r SessionReducerCreator, inputOptions ...Option) numaflow.Server {
-	opts := DefaultOptions()
+	opts := defaultOptions()
 	for _, inputOption := range inputOptions {
 		inputOption(opts)
 	}

diff --git a/pkg/sideinput/options.go b/pkg/sideinput/options.go
@@ -9,8 +9,8 @@ type options struct {
 // Option is the interface to apply options.
 type Option func(*options)
 
-// DefaultOptions returns the default options.
-func DefaultOptions() *options {
+// defaultOptions returns the default options.
+func defaultOptions() *options {
 	return &options{
 		sockAddr:       address,
 		maxMessageSize: defaultMaxMessageSize,

diff --git a/pkg/sideinput/server.go b/pkg/sideinput/server.go
@@ -20,7 +20,7 @@ type server struct {
 
 // NewSideInputServer creates a new server object.
 func NewSideInputServer(r SideInputRetriever, inputOptions ...Option) numaflow.Server {
-	opts := DefaultOptions()
+	opts := defaultOptions()
 	for _, inputOption := range inputOptions {
 		inputOption(opts)
 	}

diff --git a/pkg/sinker/options.go b/pkg/sinker/options.go
@@ -13,7 +13,7 @@ type options struct {
 // Option is the interface to apply options.
 type Option func(*options)
 
-func DefaultOptions() *options {
+func defaultOptions() *options {
 	return &options{
 		sockAddr:           address,
 		maxMessageSize:     defaultMaxMessageSize,

diff --git a/pkg/sinker/server.go b/pkg/sinker/server.go
@@ -20,7 +20,7 @@ type sinkServer struct {
 
 // NewServer creates a new sinkServer object.
 func NewServer(h Sinker, inputOptions ...Option) numaflow.Server {
-	opts := DefaultOptions()
+	opts := defaultOptions()
 	for _, inputOption := range inputOptions {
 		inputOption(opts)
 	}

diff --git a/pkg/sourcer/options.go b/pkg/sourcer/options.go
@@ -13,7 +13,7 @@ type options struct {
 // Option is the interface to apply options.
 type Option func(*options)
 
-func DefaultOptions() *options {
+func defaultOptions() *options {
 	return &options{
 		sockAddr:           address,
 		maxMessageSize:     defaultMaxMessageSize,

diff --git a/pkg/sourcer/server.go b/pkg/sourcer/server.go
@@ -21,7 +21,7 @@ type server struct {
 func NewServer(
 	source Sourcer,
 	inputOptions ...Option) numaflow.Server {
-	var opts = DefaultOptions()
+	var opts = defaultOptions()
 
 	for _, inputOption := range inputOptions {
 		inputOption(opts)

diff --git a/pkg/sourcetransformer/options.go b/pkg/sourcetransformer/options.go
@@ -13,7 +13,7 @@ type options struct {
 // Option is the interface to apply options.
 type Option func(*options)
 
-func DefaultOptions() *options {
+func defaultOptions() *options {
 	return &options{
 		sockAddr:           address,
 		maxMessageSize:     defaultMaxMessageSize,

diff --git a/pkg/sourcetransformer/server.go b/pkg/sourcetransformer/server.go
@@ -19,7 +19,7 @@ type server struct {
 
 // NewServer creates a new SourceTransformer server.
 func NewServer(m SourceTransformer, inputOptions ...Option) numaflow.Server {
-	opts := DefaultOptions()
+	opts := defaultOptions()
 	for _, inputOption := range inputOptions {
 		inputOption(opts)
 	}