Skip to content

Added read_timeout and write_timeout #792

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.

Sign up for GitHub

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

Open
Alex4Yang wants to merge 1 commit into
base: master
Choose a base branch
from
+71 −0
Open

Added read_timeout and write_timeout #792

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
71 changes: 71 additions & 0 deletions conn.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,12 @@ type conn struct {
// 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.
// specified in milliseconds
readTimeout time.Duration
writeTimeout time.Duration

// If true this connection is in the middle of a COPY
inCopy bool
}
Expand All @@ -151,6 +157,28 @@ func (cn *conn) handleDriverSettings(o values) (err error) {
return nil
}

timeSetting := func(key string, val *time.Duration) error {
if value := o[key]; value != "" {
timeout, err := strconv.Atoi(value)
if err != nil {
return err
}
// timeout is specified in milliseconds.
*val = time.Duration(timeout) * time.Millisecond
} else {
*val = time.Duration(0) * time.Millisecond
}
return nil
}

err = timeSetting("read_timeout", &cn.readTimeout)
if err != nil {
return err
}
err = timeSetting("write_timeout", &cn.writeTimeout)
if err != nil {
return err
}
err = boolSetting("disable_prepared_binary_result", &cn.disablePreparedBinaryResult)
if err != nil {
return err
Expand Down Expand Up @@ -911,23 +939,57 @@ func (cn *conn) Exec(query string, args []driver.Value) (res driver.Result, err
return r, err
}

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

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

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

func (cn *conn) cleanReadTimeout() {
if cn.readTimeout != 0 {
// Clear the read deadline if we set one.
cn.c.SetReadDeadline(time.Time{})
}
}

func (cn *conn) send(m *writeBuf) {
cn.setWriteTimeout()
_, err := cn.c.Write(m.wrap())
if err != nil {
panic(err)
}
cn.cleanWriteTimeout()
}

func (cn *conn) sendStartupPacket(m *writeBuf) error {
cn.setWriteTimeout()
_, err := cn.c.Write((m.wrap())[1:])
cn.cleanWriteTimeout()
return err
}

// Send a message of type typ to the server on the other end of cn. The
// message should have no payload. This method does not use the scratch
// buffer.
func (cn *conn) sendSimpleMessage(typ byte) (err error) {
cn.setWriteTimeout()
_, err = cn.c.Write([]byte{typ, '\x00', '\x00', '\x00', '\x04'})
cn.cleanWriteTimeout()
return err
}

Expand Down Expand Up @@ -957,9 +1019,11 @@ func (cn *conn) recvMessage(r *readBuf) (byte, error) {
return t, nil
}

cn.setReadTimeout()
x := cn.scratch[:5]
_, err := io.ReadFull(cn.buf, x)
if err != nil {
cn.cleanReadTimeout()
return 0, err
}

Expand All @@ -972,11 +1036,14 @@ func (cn *conn) recvMessage(r *readBuf) (byte, error) {
} else {
y = make([]byte, n)
}
cn.setReadTimeout()
_, err = io.ReadFull(cn.buf, y)
if err != nil {
cn.cleanReadTimeout()
return 0, err
}
*r = y
cn.cleanReadTimeout()
return t, nil
}

Expand Down Expand Up @@ -1083,6 +1150,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