iap

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 CloseError
  • func (e *CloseError) Error() string
• type Conn
  • func Dial(ctx context.Context, opts ...DialOption) (*Conn, error)
  • func (c *Conn) Close() error
  • func (c *Conn) LocalAddr() net.Addr
  • func (c *Conn) Read(buf []byte) (n int, err error)
  • func (c *Conn) Received() uint64
  • func (c *Conn) RemoteAddr() net.Addr
  • func (c *Conn) Sent() uint64
  • func (c *Conn) SessionID() string
  • func (c *Conn) SetDeadline(t time.Time) error
  • func (c *Conn) SetReadDeadline(t time.Time) error
  • func (c *Conn) SetWriteDeadline(t time.Time) error
  • func (c *Conn) Write(buf []byte) (n int, err error)
• type DialOption
• type ProtocolError
  • func (e *ProtocolError) Error() string

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

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

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

Types

type CloseError

type CloseError struct {
	Code   int
	Reason string
}

func (*CloseError) Error

func (e *CloseError) Error() string

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) LocalAddr

func (c *Conn) LocalAddr() net.Addr

LocalAddr returns the local network address.

func (*Conn) Read

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

Read reads data from the connection.

func (*Conn) Received

func (c *Conn) Received() uint64

Received returns the number of bytes received and acked.

func (*Conn) RemoteAddr

func (c *Conn) RemoteAddr() net.Addr

RemoteAddr returns the remote network address.

func (*Conn) Sent

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) SetDeadline

func (c *Conn) SetDeadline(t time.Time) error

SetDeadline sets the read and write deadlines associated with the connection.

func (*Conn) SetReadDeadline

func (c *Conn) SetReadDeadline(t time.Time) error

SetReadDeadline sets the deadline for future Read calls.

func (*Conn) SetWriteDeadline

func (c *Conn) SetWriteDeadline(t time.Time) error

SetWriteDeadline sets the deadline for future Write calls.

func (*Conn) Write

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

Write writes data to the connection.

type DialOption

type DialOption func(*dialOptions)

type ProtocolError

type ProtocolError struct {
	Err string
}

func (*ProtocolError) Error

func (e *ProtocolError) Error() string