ballerina/grpc Ballerina library

Overview

This module provides APIs for connecting and interacting with gRPC endpoints.

gRPC is an inter-process communication technology that allows you to connect, invoke, and operate distributed, heterogeneous applications as easily as making a local function call. The gRPC protocol is layered over HTTP/2 and uses Protocol Buffers for marshaling/unmarshaling messages. This makes gRPC highly efficient on wire and a simple service definition framework.

When you develop a gRPC application, the first thing you do is define a service definition using Protocol Buffers.

Protocol buffers

This is a mechanism to serialize the structured data introduced by Google and used by the gRPC framework. Defining the service using Protocol Buffers includes defining remote methods in the service and defining message types that are sent across the network. A sample service definition is shown below.

syntax = "proto3";

service Helloworld {
    rpc hello(HelloRequest) returns (HelloResponse);
}

message HelloRequest {
    string name = 1;
}

message HelloResponse {
    string message = 1;
}

gRPC allows client applications to directly call the server-side methods using the auto-generated stubs. Protocol Buffer compiler is used to generate the stubs for the specified language. In Ballerina, the stubs are generated using the built-in 'Protocol Buffers to Ballerina' tool.

For information on how to generate Ballerina code for Protocol Buffers definition, see Write a gRPC service with Ballerina.

gRPC communication patterns

The common communication pattern between a client and server is simple request-response style communication. However, with gRPC, you can leverage different inter-process communication patterns other than the simple request-response pattern. This module supports four fundamental communication patterns used in gRPC-based applications: simple RPC(unary RPC), server streaming RPC, client streaming RPC, and bidirectional streaming RPC.

Simple RPC (Unary RPC)

In this pattern, the client invokes a remote function of a server and sends a single request to the server. The server sends a single response in return to the client along with status details.

service HelloWorld {
    rpc hello (google.protobuf.StringValue)
          returns (google.protobuf.StringValue);
}

Implement the gRPC server

The code snippet given below contains a service that sends a response to each request.

// The gRPC service is attached to the listener.
service HelloWorld on new grpc:Listener(9090)  {
    // The function accepts a string message.
    remote function hello(string name) returns string|error {
        // Send the response to the client.
        return "Hi " + name + "! Greetings from gRPC service!");
    }
}

Implement the gRPC client

The code snippet given below calls the above service in a synchronized manner using an auto-generated Ballerina stub.

// Use ‘HelloWorldClient’ to execute the call in the synchronized mode.
HelloWorldClient helloClient = check new("http://localhost:9090");

// Call the service remote function using a client stub.
string responseFromServer = check helloClient->hello("Ballerina");

Server streaming RPC

In server-side streaming RPC, the server sends back a sequence of responses after getting the client's request message. After sending all the server responses, the server marks the end of the stream by sending the server status details. You can invoke this in a non-blocking manner.

service HelloWorld {
    rpc lotsOfReplies (google.protobuf.StringValue)
          returns (stream google.protobuf.StringValue);
}

Implement the gRPC server

The code snippet given below contains a service that sends a sequence of responses to each request.

// The gRPC service is attached to the listener.
service HelloWorld on new grpc:Listener(9090) {
    remote function lotsOfReplies(string name) returns stream<string, grpc:Error?> {
        string[] greets = ["Hi " + name, "Welcome " + name];
        // Send multiple responses to the client.
        return greets.toStream();
   }
}

Implement the gRPC server

The code snippet given below calls the above service using the auto-generated Ballerina client stub and reads multiple server responses using a stream. Here, the message stream is ended with a () value.

// Client endpoint configurations.
 HelloWorldClient helloworldClient = check new("http://localhost:9090");

 // Execute the service streaming call by registering a message listener.
 stream<string, grpc:Error?> result = 
                             check helloworldClient->lotsOfReplies("Ballerina");

Client streaming RPC

In client streaming RPC, the client sends multiple messages to the server instead of a single request. The server sends back a single response to the client.

service HelloWorld {
    rpc lotsOfGreetings (stream google.protobuf.StringValue)
          returns (google.protobuf.StringValue);
}

Implement the gRPC server

The code snippet given below contains a service that receives a sequence of requests from the client and sends a single response in return.

// The gRPC service is attached to the listener.
service HelloWorld on new grpc:Listener(9090) {

    // This function is triggered when a new client connection is initialized.
    remote function lotsOfGreetings(stream<string, grpc:Error?> clientStream) 
                                                        returns string|error {
        // Iterate through the client stream
        check clientStream.forEach(function(string name) {
            // Handle the message sent from the stream here
        });
        // A nil value is returned once the client stream is ended
        // Return server response to the client.
        return "Ack";
    }
}

Implement the gRPC server

The code snippet given below calls the above service using the auto-generated Ballerina client stub and sends multiple request messages from the server.

// Client endpoint configurations.
HelloWorldClient helloworldClient = check new("http://localhost:9090");

// Execute the service streaming call by registering a message listener.
LotsOfGreetingsStreamingClient streamingClient = 
                                    check helloworldClient->lotsOfGreetings();

// Send multiple messages to the server.
string[] greets = ["Hi", "Hey", "GM"];
foreach string greet in greets {
    grpc:Error? connErr = streamingClient->sendstring(greet + " " + "Ballerina");
}

// Once all the messages are sent, the client notifies the server 
// by closing the stream.
grpc:Error? result = streamingClient->complete();
// Receive the message from the server.
string|grpc:Error response = streamingClient->receiveString();

Bidirectional streaming RPC

In bidirectional streaming RPC, the client is sending a request to the server as a stream of messages. The server also responds with a stream of messages.

service Chat {
    rpc chat (stream ChatMessage)
          returns (stream google.protobuf.StringValue);
}

Implement the gRPC server

The code snippet given below includes a service that handles bidirectional streaming.

// The gRPC service is attached to the listener.
service Chat on new grpc:Listener(9090) {

    //This `resource` is triggered when a new caller connection is initialized.
    remote function chat(ChatStringCaller caller, 
                                    stream<ChatMessage, grpc:Error?> clientStream) {
        //Iterate through the client stream
        check clientStream.forEach(function(ChatMessage chatMsg) {
            // Handle the streamed messages sent from the client here
            grpc:Error? err = caller->sendString(
                                    string `${chatMsg.name}: ${chatMsg.message}`);
        });
        // A nil value is returned once the client stream is ended
        // Handle once the client has completed streaming
        caller->complete();
    }
}

Implement the gRPC server

The code snippet given below calls the above service using the auto-generated Ballerina client stub and sends multiple request messages to the server and receives multiple responses from the server.

// Client endpoint configurations.
ChatClient chatClient = check new("http://localhost:9090");

// Execute the service streaming call by registering a message listener.
ChatStreamingClient streamingClient = check chatClient->chat();

// Send multiple messages to the server.
string[] greets = ["Hi", "Hey", "GM"];
foreach string greet in greets {
    ChatMessage mes = {name: "Ballerina", message: greet};
    grpc:Error? connErr = streamingClient->sendChatMessage(mes);
}

// Once all the messages are sent, the server notifies the caller 
// with a `complete` message.
grpc:Error? result = streamingClient->complete();
...

// Receive the server stream response iteratively.
string? result = check streamingClient->receiveString();
while !(result is ()) {
    io:println(result);
    result = streamingClient->receiveString();
}

Advanced use cases

Use the TLS protocol

The Ballerina gRPC module allows the use of TLS in communication. This setting expects a secure socket to be set in the connection configuration as shown below.

Configure TLS in server side

// Server endpoint configuration with the SSL configurations.
listener grpc:Listener ep = new (9090, {
    host: "localhost",
    secureSocket: {
        key: {
            certFile: "../resource/path/to/public.crt",
            keyFile: "../resource/path/to/private.key"
        }
    }
});

service HelloWorld on ep {
    
}

Configure TLS in client side

// Client endpoint configuration with SSL configurations.
HelloWorldClient helloWorldClient = check new ("https://localhost:9090", {
    secureSocket: {
        cert: "../resource/path/to/public.crt"
    }
});

Use headers

The Ballerina gRPC module allows to send/receive headers with the request and response using the context record type. The context record type consists of two fields called headers and content. E.g: For the string message, a type generated context record type will be as follows.

public type ContextString record {|
    string content;
    map<string|string[]> headers;
|};

Use headers at the client side

// Set the custom headers to the request.
ContextString requestMessage =
{content: "WSO2", headers: {client_header_key: "0987654321"}};
// Execute the remote call.
ContextString result = check ep->helloContext(requestMessage);
// Read Response content.
string content = result.content;
// Read Response header value.
string headerValue = check grpc:getHeader(result.headers, 
                                                "server_header_key");

Use headers at the server side

service "HelloWorld" on new grpc:Listener(9090) {
    remote function hello(ContextString request) returns ContextString|error {
        // Read the request content.
        string message = "Hello " + request.content;

        // Read custom headers in request message.
        string reqHeader = check grpc:getHeader(request.headers, 
                                                        "client_header_key");

        // Send response with custom headers.
        return {content: message, 
                        headers: {server_header_key: "Response Header value"}};
    }
}

Use deadlines

Deadlines allow gRPC clients to specify how long they are willing to wait for an RPC to complete before the RPC is terminated with the DEADLINE_EXCEEDED error. In Ballerina, a deadline value is set directly to the headers and it is sent via the request headers.

Set a deadline in the request headers

time:Utc current = time:utcNow();
time:Utc deadline = time:utcAddSeconds(current, 300);
map<string|string[]> headers = grpc:setDeadline(deadline);

Check the deadlines

boolean cancel = check grpc:isCancelled(request.headers);
if (cancel) {
    return error DeadlineExceededError("Deadline exceeded");
}