grpc-swift

Swift gRPC API

This repository contains an experimental Swift gRPC API.

Not yet intended for production use, it provides low-level Swift wrappers for the C gRPC API that can be used to build higher-level structures supporting streaming and nonstreaming gRPC APIs.

Temporary protocol buffer support is provided in the QuickProto library. This simple Swift library provides an API for building and parsing protocol buffers with no generated code. Conversion to Apple's swift-protobuf library is in progress.

Code is provided for both gRPC clients and servers, and it can be built either with Xcode or the Swift Package Manager. The Xcode build is demonstrated with Echo, a sample Mac app that can be used to run echo clients and servers with streaming and nonstreaming interfaces over secure (TLS) and insecure channels.

Other examples include Sessions, StickyNotes, and Speech.

Swift Package Manager builds are demonstrated on Linux using the instructions in the Packages directory.

Getting started

After cloning this repository, cd third_party; RUNME.sh to download its dependencies (we don't use git submodules to keep this repository lean for imports with the Swift Package Manager).

Building grpc

Swift gRPC currently requires a separate build of the grpc core library. To do this, enter the grpc directory and run git submodule update --init and then make install. If you get build errors, edit the Makefile and remove "-Werror" from the line that begins with "CPPFLAGS +=".

Can't find something?

To make it easier for the Swift Package manager to find, the code for gRPC, CgRPC, and QuickProto is in the [Sources] directory.

Having build problems?

grpc-swift depends on Swift, Xcode, and swift-proto, all of which are in flux and potential sources of breaking changes. We are currently testing with the following versions:

• Xcode 8.2
• Swift 3.0.2
• swift-proto 0.9.24

License

grpc-swift is released under the same license as gRPC, repeated in LICENSE.

Contributing

Please get involved! See our guidelines for contributing.