Skip to content
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.

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

gh-128319: Add missing server class attributes to socketserver docs #128320

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
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
27 changes: 21 additions & 6 deletions Doc/library/socketserver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -264,12 +264,6 @@ Server Objects
Clean up the server. May be overridden.


.. attribute:: address_family

The family of protocols to which the server's socket belongs.
Common examples are :const:`socket.AF_INET` and :const:`socket.AF_UNIX`.


.. attribute:: RequestHandlerClass

The user-provided request handler class; an instance of this class is created
Expand All @@ -294,14 +288,35 @@ Server Objects

.. XXX should class variables be covered before instance variables, or vice versa?

.. attribute:: address_family

The family of protocols to which the server's socket belongs.
Common examples are :const:`socket.AF_INET` and :const:`socket.AF_UNIX`.


.. attribute:: allow_reuse_address

Whether the server will allow the reuse of an address. This defaults to
:const:`False`, and can be set in subclasses to change the policy.


.. attribute:: allow_reuse_port

Whether the server will allow the reuse of a port. This defaults to
:const:`False`, and can be set in subclasses to change the policy.

.. attribute:: max_packet_size
stephen-hansen marked this conversation as resolved.
Show resolved Hide resolved

Only for datagram sockets, e.g. UDP.
stephen-hansen marked this conversation as resolved.
Show resolved Hide resolved
The maximum amount of data (in bytes) to receive at once. If a packet is
too large for the buffer, then the excess bytes beyond :attr:`max_packet_size`
are discarded. The default value is usually 8192, but this can be
stephen-hansen marked this conversation as resolved.
Show resolved Hide resolved
overridden by subclasses.


.. attribute:: request_queue_size

Only for stream sockets, e.g. TCP.
stephen-hansen marked this conversation as resolved.
Show resolved Hide resolved
The size of the request queue. If it takes a long time to process a single
request, any requests that arrive while the server is busy are placed into a
queue, up to :attr:`request_queue_size` requests. Once the queue is full,
Expand Down
Loading