Skip to content

Add read_timeout and write_timeout #498

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 80 additions & 1 deletion conn.go
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,11 @@ type conn struct {
// Whether to always send []byte parameters over as binary. Enables single
// round-trip mode for non-prepared Query calls.
binaryParameters bool

// Timeouts for read and write operations against the database server.
// A duration of 0 indicates no timeout.
readTimeout time.Duration
writeTimeout time.Duration
}

// Handle driver-side settings in parsed connection string.
Expand All @@ -132,6 +137,13 @@ func (c *conn) handleDriverSettings(o values) (err error) {
return nil
}

intSetting := func(key string) (int, error) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why the different interface compared to boolSetting()?

if value := o.Get(key); value != "" {
return strconv.Atoi(value)
}
return 0, nil
}

err = boolSetting("disable_prepared_binary_result", &c.disablePreparedBinaryResult)
if err != nil {
return err
Expand All @@ -140,6 +152,21 @@ func (c *conn) handleDriverSettings(o values) (err error) {
if err != nil {
return err
}

rt, err := intSetting("read_timeout")
if err != nil {
return err
}
// read_timeout is specified in milliseconds.
c.readTimeout = time.Duration(rt) * time.Millisecond

wt, err := intSetting("write_timeout")
if err != nil {
return err
}
// write_timeout is specified in milliseconds.
c.writeTimeout = time.Duration(wt) * time.Millisecond

return nil
}

Expand Down Expand Up @@ -750,7 +777,7 @@ func (cn *conn) Prepare(q string) (_ driver.Stmt, err error) {

func (cn *conn) Close() (err error) {
if cn.bad {
return driver.ErrBadConn
return cn.c.Close()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't look correct, and should be done in a separate commit.

}
defer cn.errRecover(&err)

Expand Down Expand Up @@ -836,13 +863,37 @@ func (cn *conn) Exec(query string, args []driver.Value) (res driver.Result, err
}

func (cn *conn) send(m *writeBuf) {
defer func() {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

defer allocates. At the very least don't make everyone pay a price for this feature. But ideally don't defer at all.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't realize that. Thanks for the info.

if cn.writeTimeout != 0 {
// Clear the write deadline if we set one.
cn.c.SetWriteDeadline(time.Time{})
}
}()

// Set the write deadline if we have a write timeout set.
if cn.writeTimeout != 0 {
cn.c.SetWriteDeadline(time.Now().Add(cn.writeTimeout))
}

_, err := cn.c.Write(m.wrap())
if err != nil {
panic(err)
}
}

func (cn *conn) sendStartupPacket(m *writeBuf) {
defer func() {
if cn.writeTimeout != 0 {
// Clear the write deadline if we set one.
cn.c.SetWriteDeadline(time.Time{})
}
}()

// Set the write deadline if we have a write timeout set.
if cn.writeTimeout != 0 {
cn.c.SetWriteDeadline(time.Now().Add(cn.writeTimeout))
}

// sanity check
if m.buf[0] != 0 {
panic("oops")
Expand All @@ -858,6 +909,18 @@ func (cn *conn) sendStartupPacket(m *writeBuf) {
// message should have no payload. This method does not use the scratch
// buffer.
func (cn *conn) sendSimpleMessage(typ byte) (err error) {
defer func() {
if cn.writeTimeout != 0 {
// Clear the write deadline if we set one.
cn.c.SetWriteDeadline(time.Time{})
}
}()

// Set the write deadline if we have a write timeout set.
if cn.writeTimeout != 0 {
cn.c.SetWriteDeadline(time.Now().Add(cn.writeTimeout))
}

_, err = cn.c.Write([]byte{typ, '\x00', '\x00', '\x00', '\x04'})
return err
}
Expand All @@ -879,6 +942,18 @@ func (cn *conn) saveMessage(typ byte, buf *readBuf) {
// recvMessage receives any message from the backend, or returns an error if
// a problem occurred while reading the message.
func (cn *conn) recvMessage(r *readBuf) (byte, error) {
defer func() {
if cn.readTimeout != 0 {
// Clear the read deadline if we set one.
cn.c.SetReadDeadline(time.Time{})
}
}()

// Set the read deadline if we have a read timeout set.
if cn.readTimeout != 0 {
cn.c.SetReadDeadline(time.Now().Add(cn.readTimeout))
}

// workaround for a QueryRow bug, see exec
if cn.saveMessageType != 0 {
t := cn.saveMessageType
Expand Down Expand Up @@ -1144,6 +1219,10 @@ func isDriverSetting(key string) bool {
return true
case "binary_parameters":
return true
case "read_timeout":
return true
case "write_timeout":
return true

default:
return false
Expand Down