client

package

v1.6.1 Latest Latest Go to latest Published: Sep 21, 2023 License: GPL-3.0 Imports: 14 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

This section is empty.

This section is empty.

func ReadFromSession(conf *Config, session *common.Session, sessionsOut chan<- *common.Session)

func ReceiveData(conf *Config, st pb.Tunnel_InitTunnelClient, sessionsOut chan<- *common.Session, host string, port int32, scheme string)

func RunClient(ctx context.Context, opts ...Option) error

RunClient creates a GRPC tunnel client

func SendData(conf *Config, stream pb.Tunnel_InitTunnelClient, sessions <-chan *common.Session)

type Config struct {
	TLS bool
	// contains filtered or unexported fields
}

Config is a config object used to configure a GRPC tunnel from the client side. ClientOption should be used to modify this

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

type Option func(*Config) error

Option is an option able to be configured

func WithLogger(l log.FieldLogger) Option

WithLogger sets the logger to be used by the server. if not set, output will be discarded

func WithServer(host string, p int) Option

WithServer configures the server this client uses

func WithTLS(cert, tlsHostOverride string) Option

WithTLS configures the tunnel to use TLS and sets the certificate expected, and a optional tls hostname override.

func WithTunnels(scheme string, tunnels ...string) Option

WithTunnels configures the tunnels to be exposed by this client. Each string should be in the format of: localPort:remotePort