Opened 2 years ago

Last modified 15 months ago

#5793 enhancement assigned

Docstring for backlog parameter of listenTCP should describe its effects

Reported by: oberstet Owned by: Infinity
Priority: normal Milestone:
Component: core Keywords: documentation easy
Cc: kevin.horn@… Branch:
Author: Launchpad Bug:

Description

The docstring for the backlog parameter of listenTCP/listenSSL could be improved:

"Size of the listen queue. The value is passed directly to the listen system call and it's precise semantics is defined by the platform Twisted runs on."

This way users are made aware that it's not a Twisted-internal tunable, but forwarded to OS, and the effects being platform dependent.

Change History (5)

comment:1 Changed 2 years ago by khorn

  • Cc kevin.horn@… added

comment:2 Changed 2 years ago by khorn

  • Keywords documentation added

comment:4 Changed 15 months ago by Infinity

  • Owner set to Infinity
  • Status changed from new to assigned

comment:5 Changed 15 months ago by exarkun

Size of the listen queue. The value is passed directly to the listen system call and it's precise semantics is defined by the platform Twisted runs on.

The second part of this is definitely true. I'm not sure the first part is. Popular platforms seem to largely ignore this value entirely.

Note: See TracTickets for help on using tickets.