How to use python socket.settimeout() properly

Question

As far as I know, when you call socket.settimeout(value) and you set a float value greater than 0.0, that socket will raise a scocket.timeout when a call to, for example, socket.recv has to wait longer than the value specified.

But imagine I have to receive a big amount of data, and I have to call recv() several times, then how does settimeout affect that?

Given the following code:

to_receive = # an integer representing the bytes we want to receive
socket = # a connected socket

socket.settimeout(20)
received = 0
received_data = b""

while received < to_receive:
    tmp = socket.recv(4096)
    if len(tmp) == 0:
        raise Exception()
    received += len(tmp)
    received_data += tmp

socket.settimeout(None)

The third line of the code sets the timeout of the socket to 20 seconds. Does that timeout reset every iteration? Will timeout be raised only if one of those iteration takes more than 20 seconds?

A) How can I recode it so that it raises an exception if it is taking more than 20 seconds to receive all the expected data?

B) If I don't set the timeout to None after we read all data, could anything bad happen? (the connection is keep-alive and more data could be requested in the future).

Timmmm · Accepted Answer · 2021-11-23 15:59:38Z

The timeout applies independently to each call to socket read/write operation. So next call it will be 20 seconds again.

A) To have a timeout shared by several consequential calls, you'll have to track it manually. Something along these lines:

deadline = time.time() + 20.0
while not data_received:
    if time.time() >= deadline:
        raise Exception() # ...
    socket.settimeout(deadline - time.time())
    socket.read() # ...

B) Any code that's using a socket with a timeout and isn't ready to handle socket.timeout exception will likely fail. It is more reliable to remember the socket's timeout value before you start your operation, and restore it when you are done:

def my_socket_function(socket, ...):
    # some initialization and stuff
    old_timeout = socket.gettimeout() # Save
    # do your stuff with socket
    socket.settimeout(old_timeout) # Restore
    # etc

This way, your function will not affect the functioning of the code that's calling it, no matter what either of them do with the socket's timeout.

DisappointedByUnaccountableMod · Accepted Answer · 2015-12-19 13:23:16Z

2

The timeout applies to each call to recv().

A) simply use your existing timeout and call recv(to_receive) - I.e. Try to receive all the data in one recv call - in fact I don't see why you shouldn't use this as the default way it works

B) No nothing bad could happen, but any other code which uses that socket needs to be aware of handling timeout.

On your existing code, shouldn't the recv() call be recv(max(4096,to_receive-received)) - that way you won't unintentionally consume any data which follows after the to_receive bytes.

edited Dec 19, 2015 at 13:23

answered Dec 19, 2015 at 13:15

DisappointedByUnaccountableMod

6,8444 gold badges21 silver badges23 bronze badges

Comments

Martijn Pieters · Accepted Answer · 2019-01-29 11:11:05Z

0

See my server script, you will get the idea to use it properly.

import socket
import sys
fragments = []
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
s.bind(("192.168.1.4",9001))
s.listen(5)
while True:
    c,a = s.accept()
    c.settimeout(10.0)
    print "Someone came in Server from %s and port %s" %(a[0],a[1])
    c.send("Welcome to system")
    while True:
        chunk = c.recv(2048)
        if not chunk.strip():
            break
        else:
            fragments.append(chunk)
            continue
    combiner = "".join(fragments)
    print combiner
    shutdown = str(raw_input("Wanna Quit(Y/y) or (N/n): "))
    if shutdown == 'Y' or shutdown == 'y':
        c.close()
        sys.exit()
    else:
        continue

This script is just to give you an idea about the socket.settimeout().

edited Jan 29, 2019 at 11:11

Martijn Pieters

1.1m326 gold badges4.2k silver badges3.4k bronze badges

answered Jan 29, 2019 at 10:35

Himanshu Kanojiya

672 bronze badges

Comments

GoalLine · Accepted Answer · 2022-02-13 19:58:22Z

0

https://docs.python.org/3/library/socket.html#socket.socket.settimeout

"Changed in version 3.5: The socket timeout is no more reset each time data is sent successfully. The socket timeout is now the maximum total duration to send all data."

answered Feb 13, 2022 at 19:58

GoalLine

1

1 Comment

gremwell Over a year ago

That talks about sending, but it doesn't actually mention whether you need to set it for each recv call.

Collectives™ on Stack Overflow

How to use python socket.settimeout() properly

4 Answers 4

Comments

Comments

Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

Comments

Comments

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related