proxy

Documentation

Overview

Package proxy is a transport proxy built on the vine/server

Package proxy is a transport proxy built on the vine/server

Index

• Variables
• type Option
  • func WithClient(c client.Client) Option
  • func WithEndpoint(e string) Option
  • func WithLink(name string, c client.Client) Option
  • func WithRouter(r router.Router) Option
• type Options
• type Proxy

Variables

var (
	DefaultEndpoint = "localhost:9090"
)

Types

type Option

type Option func(o *Options)

func WithClient

func WithClient(c client.Client) Option

WithClient sets the client

func WithEndpoint

func WithEndpoint(e string) Option

WithEndpoint sets a proxy endpoint

func WithLink

func WithLink(name string, c client.Client) Option

WithLink sets a link for outbound requests

func WithRouter

func WithRouter(r router.Router) Option

WithRouter specific the router to use

type Options

type Options struct {
	// Specific endpoint to always call
	Endpoint string
	// The default client to use
	Client client.Client
	// The default router to use
	Router router.Router
	// Extra links for different clients
	Links map[string]client.Client
}

type Proxy

type Proxy interface {
	// ProcessMessage handles inbound messages
	ProcessMessage(context.Context, server.Message) error
	// ServeRequest handles inbound requests
	ServeRequest(context.Context, server.Request, server.Response) error
	// Name of the proxy protocol
	String() string
}

Proxy can be used as a proxy server for vine services