ptunnel

package

v0.0.0-...-5f133c6 Latest Latest Go to latest Published: Apr 11, 2024 License: BSD-3-Clause, BSD-3-Clause Imports: 21 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/enfabrica/enkit

Documentation ¶

Index ¶

Variables
func Connect(proxy *url.URL, host string, port uint16, pos, ack uint32, mods ...GetModifier) (*websocket.Conn, error)
func ConnectSID(proxy *url.URL, sid string, pos, ack uint32, mods ...ConnectModifier) (*websocket.Conn, error)
func ConnectURL(curl *url.URL, mods ...ConnectModifier) (*websocket.Conn, error)
func DefaultOptions() *options
func GetSID(proxy *url.URL, host string, port uint16, mods ...GetModifier) (string, error)
type ConnectModifier
- func WithBufferSize(read, write int) ConnectModifier
- func WithHandshakeTimeout(t time.Duration) ConnectModifier
- func WithHeader(key, value string) ConnectModifier
type ConnectModifiers
- func (cm ConnectModifiers) Apply(d *websocket.Dialer, h http.Header) error
type Flags
- func DefaultFlags() *Flags
- func (fl *Flags) Register(set kflags.FlagSet, prefix string) *Flags
type Flushable
type GetModifier
- func WithConnectOptions(mods ...ConnectModifier) GetModifier
- func WithGetOptions(mods ...protocol.Modifier) GetModifier
- func WithOptions(r *GetOptions) GetModifier
- func WithRetryOptions(mods ...retry.Modifier) GetModifier
type GetModifiers
- func (mods GetModifiers) Apply(o *GetOptions) error
type GetOptions
type Modifier
- func FromFlags(fl *Flags) Modifier
- func WithLogger(l logger.Logger) Modifier
- func WithTimeouts(t *Timeouts) Modifier
- func WithWindowSize(send, receive int) Modifier
type Modifiers
- func (mods Modifiers) Apply(o *options) error
type TimeSource
type Timeouts
- func DefaultTimeouts() *Timeouts
- func (t *Timeouts) Register(set kflags.FlagSet, prefix string) *Timeouts
type Tunnel
- func NewTunnel(pool *nasshp.BufferPool, mods ...Modifier) (*Tunnel, error)
- func (t *Tunnel) BrowserReceive() error
- func (t *Tunnel) BrowserSend() error
- func (t *Tunnel) Close()
- func (t *Tunnel) KeepConnected(proxy *url.URL, host string, port uint16, mods ...GetModifier) error
- func (t *Tunnel) Receive(file io.Writer) error
- func (t *Tunnel) Send(file io.Reader) error
type TunnelType
- func TunnelTypeForHost(host string) (TunnelType, error)
type WithWriteDeadline

Constants ¶

This section is empty.

Variables ¶

View Source

var CloseRequested = errors.New("close requested")

CloseRequested error is returned to interrupt Reads/Writes once a Close() has been requested by the user.

Functions ¶

func Connect ¶

func Connect(proxy *url.URL, host string, port uint16, pos, ack uint32, mods ...GetModifier) (*websocket.Conn, error)

func ConnectSID ¶

func ConnectSID(proxy *url.URL, sid string, pos, ack uint32, mods ...ConnectModifier) (*websocket.Conn, error)

func ConnectURL ¶

func ConnectURL(curl *url.URL, mods ...ConnectModifier) (*websocket.Conn, error)

func DefaultOptions ¶

func DefaultOptions() *options

func GetSID ¶

func GetSID(proxy *url.URL, host string, port uint16, mods ...GetModifier) (string, error)

Types ¶

type ConnectModifier ¶

type ConnectModifier func(*websocket.Dialer, http.Header) error

func WithBufferSize ¶

func WithBufferSize(read, write int) ConnectModifier

func WithHandshakeTimeout ¶

func WithHandshakeTimeout(t time.Duration) ConnectModifier

func WithHeader ¶

func WithHeader(key, value string) ConnectModifier

type ConnectModifiers ¶

type ConnectModifiers []ConnectModifier

func (ConnectModifiers) Apply ¶

func (cm ConnectModifiers) Apply(d *websocket.Dialer, h http.Header) error

type Flags ¶

type Flags struct {
	MaxReceiveWindow int
	MaxSendWindow    int

	*Timeouts
}

func DefaultFlags ¶

func DefaultFlags() *Flags

func (*Flags) Register ¶

func (fl *Flags) Register(set kflags.FlagSet, prefix string) *Flags

type Flushable ¶

type Flushable interface {
	Flush() error
}

type GetModifier ¶

type GetModifier func(*GetOptions) error

func WithConnectOptions ¶

func WithConnectOptions(mods ...ConnectModifier) GetModifier

Configures options to use to establish the websocket moving bytes around.

This mostly affects the Connect(), ConnectSID() and ConnectURL() call, invoked once per attempt to establish the websocket used as the actual tunnel.

func WithGetOptions ¶

func WithGetOptions(mods ...protocol.Modifier) GetModifier

Configures options to use in the GET requests to prepare the tunnel. This mostly affects the GetSID() call, invoked once per attempt to log in.

func WithOptions ¶

func WithOptions(r *GetOptions) GetModifier

func WithRetryOptions ¶

func WithRetryOptions(mods ...retry.Modifier) GetModifier

type GetModifiers ¶

type GetModifiers []GetModifier

func (GetModifiers) Apply ¶

func (mods GetModifiers) Apply(o *GetOptions) error

type GetOptions ¶

type GetOptions struct {
	// contains filtered or unexported fields
}

type Modifier ¶

type Modifier func(o *options) error

func FromFlags ¶

func FromFlags(fl *Flags) Modifier

func WithLogger ¶

func WithLogger(l logger.Logger) Modifier

func WithTimeouts ¶

func WithTimeouts(t *Timeouts) Modifier

func WithWindowSize ¶

func WithWindowSize(send, receive int) Modifier

type Modifiers ¶

type Modifiers []Modifier

func (Modifiers) Apply ¶

func (mods Modifiers) Apply(o *options) error

type TimeSource ¶

type TimeSource func() time.Time

type Timeouts ¶

type Timeouts struct {
	Now TimeSource

	ConnWriteTimeout    time.Duration
	BrowserWriteTimeout time.Duration

	BrowserAckInterval  time.Duration
	BrowserPingInterval time.Duration
	BrowserPingTimeout  time.Duration
}

func DefaultTimeouts ¶

func DefaultTimeouts() *Timeouts

func (*Timeouts) Register ¶

func (t *Timeouts) Register(set kflags.FlagSet, prefix string) *Timeouts

type Tunnel ¶

type Tunnel struct {
	SendWin    *nasshp.BlockingSendWindow
	ReceiveWin *nasshp.BlockingReceiveWindow
	// contains filtered or unexported fields
}

func NewTunnel ¶

func NewTunnel(pool *nasshp.BufferPool, mods ...Modifier) (*Tunnel, error)

func (*Tunnel) BrowserReceive ¶

func (t *Tunnel) BrowserReceive() error

func (*Tunnel) BrowserSend ¶

func (t *Tunnel) BrowserSend() error

func (*Tunnel) Close ¶

func (t *Tunnel) Close()

func (*Tunnel) KeepConnected ¶

func (t *Tunnel) KeepConnected(proxy *url.URL, host string, port uint16, mods ...GetModifier) error

func (*Tunnel) Receive ¶

func (t *Tunnel) Receive(file io.Writer) error

func (*Tunnel) Send ¶

func (t *Tunnel) Send(file io.Reader) error

type TunnelType ¶

type TunnelType int

const (
	TunnelTypeNone TunnelType = iota
	TunnelTypePersistent
	TunnelTypeLocal
)

func TunnelTypeForHost ¶

func TunnelTypeForHost(host string) (TunnelType, error)

type WithWriteDeadline ¶

type WithWriteDeadline interface {
	SetWriteDeadline(time.Time) error
}

Source Files ¶

View all Source files

tunnel.go

Directories ¶

Path	Synopsis
commands
exec

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL