[DRIVERS-2166] Rationalize terminology for network errors and timeouts Created: 16/May/18  Updated: 31/Mar/22

Status: Backlog
Project: Drivers
Component/s: Multiple
Fix Version/s: None

Type: Spec Change Priority: Minor - P4
Reporter: David Golden Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: low-hanging-fruits
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Depends
Driver Changes: Needed

 Description   

Different driver specs use slightly inconsistent terminology for network errors, timeouts, exceptions, etc. leading to subtle differences between specs. We should standardize on unambiguous terminology and update all specs to match.

Proposal: Use the prefix "socket" for errors and timeout; use the term "network exception" to mean any sort of socket problem. Having different prefixes for the different scopes makes it harder to accidentally mix up the cases.

Specific examples:

  • Socket Timeout: the condition where a networking socket operation is halted before the sucess or failure of the operation is determined. Examples include (but are not limited to) socket system calls with -1 return value and errno equal to ETIMEDOUT and a zero return value from select().
  • Socket Error: the condition where a networking socket operation is known to have failed or been interrupted.
  • Network Exception: the condition where either a Socket Timeout or Socket Error has occurred.

Generated at Thu Feb 08 08:24:53 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.