agent

Documentation

Overview

Package agent implements the functions, types, and interfaces for the module.

Package agent implements the functions, types, and interfaces for the module.

Package agent implements the functions, types, and interfaces for the module.

Package agent implements the functions, types, and interfaces for the module.

Index

• Constants
• Variables
• func FromHTTPContext(ctx context.Context) (transhttp.Context, bool)
• func HTTPContext(c transhttp.Context) context.Context
• func NewHTTPContext(ctx context.Context, c transhttp.Context) context.Context
• type Agent
  • func NewAgent(httpServer *transhttp.Server, grpcServer *transgrpc.Server) Agent
  • func NewAgentWithGRPC(grpcServer *transgrpc.Server) Agent
  • func NewAgentWithHTTP(server *transhttp.Server) Agent
• type GRPCAgent
  • func NewGRPC(server *transgrpc.Server) GRPCAgent
• type HTTPAgent
  • func NewHTTP(server *http.Server) HTTPAgent

Constants

const ApiVersionV1 = "/api/v1"

ApiVersionV1 defines the version number of the API

const DefaultPrefix = "/api"

DefaultPrefix defines the default API prefix

const DefaultVersion = "v1"

DefaultVersion defines the default API version

Variables

var ErrContextNotFound = errors.New("http context not found")

Functions

func FromHTTPContext

func FromHTTPContext(ctx context.Context) (transhttp.Context, bool)

func HTTPContext

func HTTPContext(c transhttp.Context) context.Context

func NewHTTPContext

func NewHTTPContext(ctx context.Context, c transhttp.Context) context.Context

Types

type Agent

type Agent interface {
	HTTPAgent
	GRPCAgent
}

Agent is an interface that combines the HTTPAgent and GRPCAgent interfaces

var UnimplementedAgent Agent = &unimplementedAgent{}

func NewAgent

func NewAgent(httpServer *transhttp.Server, grpcServer *transgrpc.Server) Agent

NewAgent creates a new Agent instance that supports both HTTP and gRPC

func NewAgentWithGRPC

func NewAgentWithGRPC(grpcServer *transgrpc.Server) Agent

NewAgentWithGRPC creates a new Agent instance that only supports gRPC

func NewAgentWithHTTP

func NewAgentWithHTTP(server *transhttp.Server) Agent

NewAgentWithHTTP creates a new Agent instance that only supports HTTP

type GRPCAgent

type GRPCAgent interface {
	// Server returns an instance of the gRPC server
	Server() *transgrpc.Server
	// RegisterService registers a gRPC service
	RegisterService(desc *grpc.ServiceDesc, impl interface{})
}

GRPCAgent is an interface that defines the basic methods of a gRPC proxy

func NewGRPC

func NewGRPC(server *transgrpc.Server) GRPCAgent

type HTTPAgent

type HTTPAgent interface {
	// URI returns the URI of the HTTP service
	URI() string
	// HTTPServer returns an instance of the HTTP server
	HTTPServer() *transhttp.Server
	// Route returns an instance of the HTTP router
	Route() *transhttp.Router
}

HTTPAgent is an interface that defines the basic methods of an HTTP proxy

func NewHTTP

func NewHTTP(server *http.Server) HTTPAgent