Expose TCP_CONGESTION and TCP_USER_TIMEOUT to the socket module

[osandov]

BPO	26273
Nosy	@pitrou, @vstinner, @ned-deily, @vadmium, @serhiy-storchaka, @1st1, @osandov, @JelteF
PRs	[Do Not Merge] Convert Misc/NEWS so that it is managed by towncrier #552
Files	socket_tcp_options.patch socket_doc.patch

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2017-01-23.11:31:12.311>
created_at = <Date 2016-02-03.08:54:44.439>
labels = ['3.7', 'type-feature', 'library']
title = 'Expose TCP_CONGESTION and TCP_USER_TIMEOUT to the socket module'
updated_at = <Date 2017-03-31.16:36:10.224>
user = 'https://github.com/osandov'

bugs.python.org fields:

activity = <Date 2017-03-31.16:36:10.224>
actor = 'dstufft'
assignee = 'none'
closed = True
closed_date = <Date 2017-01-23.11:31:12.311>
closer = 'vstinner'
components = ['Library (Lib)']
creation = <Date 2016-02-03.08:54:44.439>
creator = 'osandov'
dependencies = []
files = ['41787', '45692']
hgrepos = []
issue_num = 26273
keywords = ['patch']
message_count = 16.0
messages = ['259460', '281100', '281997', '282001', '282002', '282003', '282004', '282007', '282011', '282012', '282017', '282019', '282020', '285982', '286076', '286077']
nosy_count = 9.0
nosy_names = ['pitrou', 'vstinner', 'ned.deily', 'python-dev', 'martin.panter', 'serhiy.storchaka', 'yselivanov', 'osandov', 'JelteF']
pr_nums = ['552']
priority = 'normal'
resolution = 'fixed'
stage = 'commit review'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue26273'
versions = ['Python 3.6', 'Python 3.7']

[osandov]

The socket module is missing a couple of TCP socket options: TCP_CONGESTION was added to Linux in v2.6.13 and TCP_USER_TIMEOUT was added in v2.6.37. These should be exposed.

[JelteF]

Is there any issue in merging this? TCP_USER_TIMEOUT is quite useful, for automatic failover of connections that suddenly died.

[pitrou]

+1 for this. The patch looks fine, and there's no need to add any documentation or tests.

[python-dev]

New changeset 674fb9644eaa by Victor Stinner in branch 'default':
Add TCP_CONGESTION and TCP_USER_TIMEOUT
https://hg.python.org/cpython/rev/674fb9644eaa

[vstinner]

@ned Deily: Would you be ok to add these two constants to Python 3.6? I cannot image any regression if 674fb9644eaa is backported to Python 3.6.

@serhiy, Yury: Any opinion on the backport?

[vstinner]

Sorry, I missed this issue.

TCP_USER_TIMEOUT is super useful! It helps a lot to detect when a server is down, especially when using keep alive: at kernel level (TCP keepalive) or application level (ex: RabbitMQ heart beat).

Linux default timeout is more something like 15 minutes. A few years ago, it was longer than 2 days :-)

[pitrou]

Le 29/11/2016 à 16:59, STINNER Victor a écrit :

TCP_USER_TIMEOUT is super useful!

It is :-)

[osandov]

Glad to see this finally get in :)

[serhiy-storchaka]

Shouldn't we add something like versionadded/versionchanged or a mentioning in What's New?

[1st1]

Would be nice to have in 3.6.

[ned-deily]

OK for 3.6.0rc1 (before it times out)

[python-dev]

New changeset 6d69da76be6a by Victor Stinner in branch '3.6':
Add TCP_CONGESTION and TCP_USER_TIMEOUT
https://hg.python.org/cpython/rev/6d69da76be6a

[vstinner]

Serhiy Storchaka: "Shouldn't we add something like versionadded/versionchanged or a mentioning in What's New?"

Oh right, we did that for other new constants added to Python 3.6 like SO_DOMAIN.

Attached socket_doc.patch documents the additional of the two new constants. It seems like "hg transplant" putted the NEWS entry in the wrong section :-/ The patch also fixes that.

[vadmium]

Patch looks good to me.

BTW in bpo-27409 I proposed a patch listing more of these.

[python-dev]

New changeset ffb2534fcbf1 by Victor Stinner in branch '3.6':
Issue bpo-26273: Document TCP_USER_TIMEOUT and TCP_CONGESTION
https://hg.python.org/cpython/rev/ffb2534fcbf1

[vstinner]

Patch looks good to me.

Oh, I forgot socket_doc.patch! Thanks Serhiy for the reminder and Martin for the review :-) I just pushed the patch.