diff --git a/pkg/apis/proto/source/v1/source.proto b/pkg/apis/proto/source/v1/source.proto index 726da447..10371998 100644 --- a/pkg/apis/proto/source/v1/source.proto +++ b/pkg/apis/proto/source/v1/source.proto @@ -9,9 +9,10 @@ package source.v1; service Source { // Read returns a stream of datum responses. - // The size of the returned ReadResponse is less than or equal to the num_records specified in each ReadRequest. - // If the request timeout is reached on the server side, the returned ReadResponse will contain all the datum that have been read (which could be an empty list). + // The size of the returned responses is less than or equal to the num_records specified in each ReadRequest. + // If the request timeout is reached on the server side, the returned responses will contain all the datum that have been read (which could be an empty list). // The server will continue to read and respond to subsequent ReadRequests until the client closes the stream. + // Once it has sent all the datum, the server will send a ReadResponse with the end of transmission flag set to true. rpc ReadFn(stream ReadRequest) returns (stream ReadResponse); // AckFn acknowledges a stream of datum offsets. @@ -19,6 +20,7 @@ service Source { // The caller (numa) expects the AckFn to be successful, and it does not expect any errors. // If there are some irrecoverable errors when the callee (UDSource) is processing the AckFn request, // then it is best to crash because there are no other retry mechanisms possible. + // Clients sends n requests and expects n responses. rpc AckFn(stream AckRequest) returns (stream AckResponse); // PendingFn returns the number of pending records at the user defined source. @@ -99,8 +101,8 @@ message ReadResponse { // Required field holding the result. Result result = 1; // Status of the response. Holds the end of transmission flag and the status code. - // Status status = 2; + // Handshake message between client and server to indicate the start of transmission. optional Handshake handshake = 3; } @@ -135,6 +137,7 @@ message AckResponse { } // Required field holding the result. Result result = 1; + // Handshake message between client and server to indicate the start of transmission. optional Handshake handshake = 2; } diff --git a/pkg/sourcer/examples/simple_source/Makefile b/pkg/sourcer/examples/simple_source/Makefile index da06d1e1..01879bd1 100644 --- a/pkg/sourcer/examples/simple_source/Makefile +++ b/pkg/sourcer/examples/simple_source/Makefile @@ -1,6 +1,6 @@ TAG ?= stable PUSH ?= false -IMAGE_REGISTRY = quay.io/yhl25/numaflow-go/source-simple-source:${TAG} +IMAGE_REGISTRY = quay.io/numaio/numaflow-go/source-simple-source:${TAG} ARCHITECTURES = amd64 arm64 .PHONY: build