Ticket #5793 enhancement assigned

Opened 10 months ago

Last modified 4 weeks ago

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

1

Changed 10 months ago by khorn

  • cc kevin.horn@… added

2

Changed 10 months ago by khorn

  • keywords documentation added

3

4

Changed 4 weeks ago by Infinity

  • status changed from new to assigned
  • owner set to Infinity

5

Changed 4 weeks 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.