grpcweb

README

GopherJS bindings for Improbable's gRPC-Web implementation

This package provides GopherJS bindings for Improbable's gRPC-web implementation.

It also implements a websocket client to the websocket-bi-directional streaming proxy.

The API is still experimental, and is not currently intended for general use outside of via the GopherJS protoc compiler plugin. See the protoc-gen-gopherjs README for more information on generating the interface.

Documentation

Overview

Package grpcweb defines a couple of convenience wrappers around the Improbable TS gRPC-web implementation. It should be used in conjunction with the protoc-gen-gopherjs tool.

Index

• Constants
• type CallOption
  • func Header(headers *metadata.MD) CallOption
  • func Trailer(trailers *metadata.MD) CallOption
• type Client
  • func NewClient(host, service string, opts ...DialOption) *Client
  • func (c *Client) NewClientStream(ctx context.Context, method string) (ClientStream, error)
  • func (c Client) NewServerStream(ctx context.Context, method string, req []byte, opts ...CallOption) (ServerStream, error)
  • func (c Client) RPCCall(ctx context.Context, method string, req []byte, opts ...CallOption) ([]byte, error)
• type ClientStream
• type DialOption
• type ServerStream

Constants

const GrpcWebPackageIsVersion2 = true

GrpcWebPackageIsVersion2 is referenced from generated protocol buffer files to assert that that code is compatible with this version of the proto package.

Types

type CallOption

type CallOption interface {
	// contains filtered or unexported methods
}

CallOption is a stub for any call options that may be implemented

func Header

func Header(headers *metadata.MD) CallOption

Header returns a CallOptions that retrieves the header metadata for a unary RPC.

func Trailer

func Trailer(trailers *metadata.MD) CallOption

Trailer returns a CallOptions that retrieves the trailer metadata for a unary RPC.

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client encapsulates all gRPC calls to a host-service combination.

func NewClient

func NewClient(host, service string, opts ...DialOption) *Client

NewClient creates a new Client.

func (*Client) NewClientStream

func (c *Client) NewClientStream(ctx context.Context, method string) (ClientStream, error)

NewClientStream opens a new WebSocket connection for performing client-side and bi-directional streaming. It will block until the connection is established or fails to connect.

func (Client) NewServerStream

func (c Client) NewServerStream(ctx context.Context, method string, req []byte, opts ...CallOption) (ServerStream, error)

NewServerStream performs a server-to-client streaming RPC call, returning a struct which exposes a Go gRPC like streaming interface. It is non-blocking.

func (Client) RPCCall

func (c Client) RPCCall(ctx context.Context, method string, req []byte, opts ...CallOption) ([]byte, error)

RPCCall performs a unary call to an endpoint, blocking until a reply has been received or the context was canceled.

type ClientStream

type ClientStream interface {
	RecvMsg() ([]byte, error)
	SendMsg([]byte) error
	CloseSend() error
	CloseAndRecv() ([]byte, error)
	Context() context.Context
}

ClientStream is the interface exposed by the websocket proxy

type DialOption

type DialOption func(*Client)

DialOption is a stub for any dial options that may be implemented

type ServerStream

type ServerStream interface {
	RecvMsg() ([]byte, error)
	Context() context.Context
}

ServerStream is implemented by StreamClient