tunnel

Documentation

Index

• Constants
• Variables
• type Client
  • func (d *Client) Close() error
  • func (d *Client) Delete(ctx context.Context, tunnelID string) error
  • func (d *Client) Read() chan *events.Outbound
  • func (d *Client) Start(ctx context.Context, bus string, errorCh chan<- *records.ErrorRecord) error
• type Config
• type ITunnel
  • func New(opts *opts.TunnelOptions, cfg *Config) (ITunnel, error)

Constants

const (
	// DefaultTunnelAddress is the default address that the tunnel pkg will
	// use if an alternate address is not specified
	DefaultTunnelAddress = "dproxy.batch.sh:443"

	// ReconnectSleep determines the length of time to wait between reconnect attempts to dProxy
	ReconnectSleep = time.Second * 5

	DefaultGRPCTimeoutSeconds = 5
)

Variables

var (
	ErrNotAuthorized = errors.New("not authorized")
)

Types

type Client

type Client struct {
	Client services.DProxyClient
	Conn   *grpc.ClientConn
	Token  string

	PlumberClusterID  string
	PlumberID         string
	PlumberVersion    string
	OutboundMessageCh chan *events.Outbound

	Options *opts.TunnelOptions
	// contains filtered or unexported fields
}

func (*Client) Close

func (d *Client) Close() error

func (*Client) Delete

func (d *Client) Delete(ctx context.Context, tunnelID string) error

func (*Client) Read

func (d *Client) Read() chan *events.Outbound

func (*Client) Start

func (d *Client) Start(ctx context.Context, bus string, errorCh chan<- *records.ErrorRecord) error

type Config

type Config struct {
	PlumberVersion   string
	PlumberClusterID string
	PlumberID        string
}

type ITunnel

type ITunnel interface {
	// Start is called by a backend's Tunnel() method. It authorizes the connection
	// and begins reading a GRPC stream of responses consisting of Tunnel protobuf
	// messages.
	Start(ctx context.Context, bus string, errorCh chan<- *records.ErrorRecord) error

	// Read returns a channel that will receive replay events from the dProxy service
	Read() chan *events.Outbound

	// Close closes the connection to dProxy service
	Close() error

	// Delete deletes a tunnel from dProxy and from ui-bff destinations.
	// This should be called after the tunnel is deleted from the plumber cluster to ensure proper cleanup.
	Delete(ctx context.Context, tunnelID string) error
}

func New

func New(opts *opts.TunnelOptions, cfg *Config) (ITunnel, error)

New validates CLI options and returns a new Client struct