grpc-swift/Sources/GRPCCore/Documentation.docc/Documentation.md

GRPCCore

A gRPC library for Swift written natively in Swift.

🚧 This module is part of gRPC Swift v2 which is under active development and in the pre-release stage.

Package structure

gRPC Swift is distributed across multiple Swift packages. These are:

• grpc-swift (this package) containing core gRPC abstractions and an in-process transport.
  • GitHub repository: grpc/grpc-swift
  • Documentation: hosted on the Swift Package Index
• grpc-swift-nio-transport contains high-performance HTTP/2 transports built on top of SwiftNIO.
  • GitHub repository: grpc/grpc-swift-nio-transport
  • Documentation: hosted on the Swift Package Index
• grpc-swift-protobuf contains runtime serialization components to interoperate with SwiftProtobuf as well as a plugin for the Protocol Buffers compiler, protoc.
  • GitHub repository: grpc/grpc-swift-protobuf
  • Documentation: hosted on the Swift Package Index
• grpc-swift-extras contains optional runtime components and integrations with other packages.
  • GitHub repository: grpc/grpc-swift-extras
  • Documentation: hosted on the Swift Package Index

This package, and this module (GRPCCore) in particular, include higher level documentation such as tutorials.

Modules in this package

• GRPCCore (this module) contains core abstractions, currency types and runtime components for gRPC Swift.
• GRPCInProcessTransport contains an in-process implementation of the ClientTransport and ServerTransport protocols.
• GRPCodeGen contains components for building a code generator.

Topics

Tutorials

• doc:Hello-World
• doc:Route-Guide

Essentials

• doc:Generating-stubs

Getting involved

Resources for developers working on gRPC Swift:

• doc:Design
• doc:Benchmarks