proxymanager

Documentation

Overview

SPDX-FileCopyrightText: 2024 Paulo Almeida <almeidapaulopt@gmail.com> SPDX-License-Identifier: MIT

SPDX-FileCopyrightText: 2024 Paulo Almeida <almeidapaulopt@gmail.com> SPDX-License-Identifier: MIT

Index

• type Proxy
  • func NewProxy(log zerolog.Logger, pcfg *proxyconfig.Config, ...) (*Proxy, error)
  • func (proxy *Proxy) Close()
  • func (proxy *Proxy) GetAuthURL() string
  • func (proxy *Proxy) GetState() proxyconfig.ProxyState
  • func (proxy *Proxy) GetURL() string
  • func (proxy *Proxy) Start()
• type ProxyList
• type ProxyManager
  • func NewProxyManager(logger zerolog.Logger) *ProxyManager
  • func (pm *ProxyManager) HandleContainerEvent(event targetproviders.TargetEvent)
  • func (pm *ProxyManager) Start()
  • func (pm *ProxyManager) StopAllProxies()
  • func (pm *ProxyManager) WatchEvents()
• type ProxyProviderList
• type TargetProviderList

Types

type Proxy

type Proxy struct {
	Config *proxyconfig.Config
	URL    *url.URL
	// contains filtered or unexported fields
}

Proxy struct is a struct that contains all the information needed to run a proxy.

func NewProxy

func NewProxy(log zerolog.Logger,
	pcfg *proxyconfig.Config,
	proxyProvider proxyproviders.Provider,
	targetprovider targetproviders.TargetProvider,
) (*Proxy, error)

NewProxy function is a function that creates a new proxy.

func (*Proxy) Close

func (proxy *Proxy) Close()

Close method is a method that initiate proxy close procedure.

func (*Proxy) GetAuthURL

func (proxy *Proxy) GetAuthURL() string

func (*Proxy) GetState

func (proxy *Proxy) GetState() proxyconfig.ProxyState

func (*Proxy) GetURL

func (proxy *Proxy) GetURL() string

func (*Proxy) Start

func (proxy *Proxy) Start()

type ProxyList

type ProxyList map[string]*Proxy

type ProxyManager

type ProxyManager struct {
	Proxies ProxyList

	TargetProviders TargetProviderList
	ProxyProviders  ProxyProviderList
	// contains filtered or unexported fields
}

ProxyManager struct stores data that is required to manage all proxies

func NewProxyManager

func NewProxyManager(logger zerolog.Logger) *ProxyManager

NewProxyManager function creates a new ProxyManager.

func (*ProxyManager) HandleContainerEvent

func (pm *ProxyManager) HandleContainerEvent(event targetproviders.TargetEvent)

HandleContainerEvent method handles events from a targetprovider

func (*ProxyManager) Start

func (pm *ProxyManager) Start()

Start method starts the ProxyManager.

func (*ProxyManager) StopAllProxies

func (pm *ProxyManager) StopAllProxies()

StopAllProxies method shuts down all proxies.

func (*ProxyManager) WatchEvents

func (pm *ProxyManager) WatchEvents()

WatchEvents method watches for events from all target providers.

type ProxyProviderList

type ProxyProviderList map[string]proxyproviders.Provider

type TargetProviderList

type TargetProviderList map[string]targetproviders.TargetProvider