api

Documentation

Overview

Package api exposes application configurations via a gRPC API.

Index

• func RegisterServer(s *grpc.Server, apps ...configkit.Application)
• type Client
  • func NewClient(conn grpc.ClientConnInterface) Client

Functions

func RegisterServer

func RegisterServer(
	s *grpc.Server,
	apps ...configkit.Application,
)

RegisterServer registers a config server for the given applications.

Types

type Client

type Client interface {
	// ListApplicationIdentities returns the identities of applications hosted
	// by the server.
	ListApplicationIdentities(ctx context.Context) ([]configkit.Identity, error)

	// ListApplications returns the configurations of the applications hosted by
	// the server. The handler objects in the returned configuration are nil.
	ListApplications(ctx context.Context) ([]configkit.Application, error)
}

Client is used to query a server about its application configurations.

func NewClient

func NewClient(conn grpc.ClientConnInterface) Client

NewClient returns a new configuration client for the given connection.