iap

package

v0.1.3 Latest Latest Go to latest Published: Apr 24, 2023 License: GPL-3.0 Imports: 9 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/cedws/iapc

Links

Open Source Insights

Documentation ¶

Overview ¶

Package iap provides a client for the IAP tunneling protocol.

Index ¶

func WithCompression() func(*dialOptions)
func WithHost(host, region, network, destGroup string) func(*dialOptions)
func WithInstance(instance, zone, ninterface string) func(*dialOptions)
func WithPort(port string) func(*dialOptions)
func WithProject(project string) func(*dialOptions)
func WithTokenSource(tokenSource *oauth2.TokenSource) func(*dialOptions)
type Conn
- func Dial(ctx context.Context, opts ...DialOption) (*Conn, error)
type ConnectionError
- func (e *ConnectionError) Error() string
type DialOption
type ProtocolError
- func (e *ProtocolError) Error() string

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func WithCompression ¶

func WithCompression() func(*dialOptions)

WithCompression is a functional option that enables compression.

func WithHost ¶

func WithHost(host, region, network, destGroup string) func(*dialOptions)

WithHost is a functional option that sets the host, region, network, and destination group.

func WithInstance ¶

func WithInstance(instance, zone, ninterface string) func(*dialOptions)

WithInstance is a functional option that sets the instance, zone, and network interface.

func WithPort ¶

func WithPort(port string) func(*dialOptions)

WithPort is a functional option that sets the destination port.

func WithProject ¶

func WithProject(project string) func(*dialOptions)

WithProject is a functional option that sets the project ID.

func WithTokenSource ¶ added in v0.1.3

func WithTokenSource(tokenSource *oauth2.TokenSource) func(*dialOptions)

WithTokenSource is a functional option that sets the authorization toke source.

Types ¶

type Conn ¶

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

func Dial ¶

func Dial(ctx context.Context, opts ...DialOption) (*Conn, error)

Dial connects to the IAP proxy and returns a Conn or error if the connection fails.

func (*Conn) Close ¶

func (c *Conn) Close() error

Close closes the connection.

func (*Conn) Read ¶

func (c *Conn) Read(buf []byte) (n int, err error)

Read reads data from the connection.

func (*Conn) Received ¶ added in v0.1.2

func (c *Conn) Received() uint64

Received returns the number of bytes received and acked.

func (*Conn) Sent ¶ added in v0.1.2

func (c *Conn) Sent() uint64

Sent returns the number of bytes sent and acked.

func (*Conn) SessionID ¶

func (c *Conn) SessionID() string

SessionID returns the session ID of the connection.

func (*Conn) Write ¶

func (c *Conn) Write(buf []byte) (n int, err error)

Write writes data to the connection.

type ConnectionError ¶ added in v0.1.3

type ConnectionError struct {
	Err string
}

func (*ConnectionError) Error ¶ added in v0.1.3

func (e *ConnectionError) Error() string

type DialOption ¶

type DialOption func(*dialOptions)

type ProtocolError ¶ added in v0.1.3

type ProtocolError struct {
	Err string
}

func (*ProtocolError) Error ¶ added in v0.1.3

func (e *ProtocolError) Error() string

Source Files ¶

View all Source files

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