Project

General

Profile

Bug #6059

tcp keepalive params could be more prominently documented

Added by David Pacheco over 5 years ago. Updated over 5 years ago.

Status:
New
Priority:
Normal
Assignee:
-
Category:
-
Start date:
2015-07-15
Due date:
% Done:

0%

Estimated time:
Difficulty:
Medium
Tags:
needs-triage
Gerrit CR:

Description

TCP keepalive is a useful mechanism, but figuring out how to configure it is non-trivial. getsockopt(3SOCKET) describes SO_KEEPALIVE, but doesn't talk about the various related options like how often probes are sent and how long they can be outstanding before the connection is terminated. In fact, the default is two hours, which seems less than useful for many applications, so configuring it is important.

getsocket(3SOCKET) does reference tcp(7p) in the "SEE ALSO" section, and that man page does describe the socket options TCP_KEEPALIVE_THRESHOLD, TCP_KEEPALIVE_ABORT_THRESHOLD, and the more portable parameters TCP_KEEPIDLE, TCP_KEEPCNT, and TCP_KEEPINTVL.

I think it would help a lot if the existing paragraph about SO_KEEPALIVE in the getsockopt(3SOCKET) page had a sentence like this:

"Protocol-specific parameters that determine how often these messages are transmitted and when connections are terminated by this mechanism are documented in tcp(7p)."


Related issues

Related to illumos gate - Feature #7007: document TCP parametersNew2016-05-27

Actions
Related to illumos gate - Bug #6711: TCP options need documentationNew2016-03-01

Actions
#1

Updated by David Pacheco over 5 years ago

This was previously filed as Joyent's OS-4229.

#2

Updated by David Pacheco over 4 years ago

#3

Updated by David Pacheco over 3 years ago

  • Related to Bug #6711: TCP options need documentation added

Also available in: Atom PDF