gRPCServer.jl

A native Julia implementation of a gRPC server.

Overview

gRPCServer.jl provides a complete gRPC server implementation in Julia, enabling you to build high-performance gRPC services. It supports all four RPC patterns, interceptors, health checking, and more.

Features

• All RPC Patterns: Unary, server streaming, client streaming, and bidirectional streaming
• Protocol Buffer Support: Seamless integration with ProtoBuf.jl for message serialization
• Interceptors: Middleware pattern for cross-cutting concerns (logging, auth, metrics)
• Health Checking: Standard gRPC health checking protocol (grpc.health.v1)
• Compression: GZIP and DEFLATE compression support
• TLS Support: Secure connections with TLS and mutual TLS (mTLS)
• Pluggable HTTP/2 Backend: HTTP/2 protocol delegated to PureHTTP2.jl; custom backends can be plugged in via AbstractHTTP2Backend (see HTTP/2 Backends)
• Reflection: gRPC reflection service for tooling integration

Installation

using Pkg

Pkg.dev("https://github.com/s-celles/gRPCServer.jl")

# Pkg.add("gRPCServer")  # when registered

Getting Started

See the Quick Start guide for a complete walkthrough from defining your .proto file to running a gRPC server and testing it with grpcurl.

Table of Contents

• Quick Start
• • Prerequisites
  • Installation
  • Step 1: Define Your Service
  • Step 2: Generate Julia Types
  • Step 3: Implement Handlers
  • Step 4: Create Service Descriptor
  • Step 5: Create and Run Server
  • Complete Example
  • Testing with grpcurl
  • Testing with gRPCClient.jl
  • Adding Interceptors
  • Enabling TLS
  • Error Handling
  • Graceful Shutdown
• API Reference
• • Module
  • Server Types
  • Context Types
  • Service Registration
  • Stream Types
  • Error Handling
  • Interceptors
  • Health Checking
  • Reflection Support
  • Server Lifecycle
  • TLS
  • Context Operations
  • Compression
  • HTTP/2 Backend Abstraction
  • HTTP/2 Stream State
• Examples
• • Learning Path
  • Getting Started
  • Quick Reference
  • Port Assignments
  • Next Steps

License

MIT License