dial

Documentation

Overview

Package dial provides types to implement go-hdb custom dialers.

Index

• type Dialer
• type DialerOptions

Types

type Dialer

type Dialer interface {
	DialContext(ctx context.Context, address string, options DialerOptions) (net.Conn, error)
}

The Dialer interface needs to be implemented by custom Dialers. A Dialer for providing a custom driver connection to the database can be set in the driver.Connector object.

var DefaultDialer Dialer = &dialer{}

DefaultDialer is the default driver Dialer implementation.

type DialerOptions

type DialerOptions struct {
	Timeout, TCPKeepAlive time.Duration
	TCPKeepAliveConfig    net.KeepAliveConfig
}

DialerOptions contains optional parameters that might be used by a Dialer.