1841226 - Update the documentation of nsHttpChannel class

Status: NEW

(Core :: Networking, task, P3)

Description

[Sunil Mayya]

The purpose of this bug is to update the documentation of nsHttpChannel class in the code and document an high-level overview of this class in Firefox source docs

The high-level overview in the Firefox source docs could server as an introduction for this class and briefly describe its critical interactions with other Necko classes.

With this bug, we should also review the comments in the code and update/add wherever necessary.

Few things to consider while documenting the high-level overview in Firefox source docs:

• What are the main interfaces this class implements. A brief (one liner) significance of these interfaces would be desired.
• Describe the major functionalities (Authentication/Redirection/Caching etc) implemented in nsHttpChannel class and briefly explain the classes nsHttpChannel class interacts with to achieve these functionalities.
• Various scenarios when the channel is suspended
• Asynchronous control flow patterns in the class
• Try describing the behavior nsHttpchannel in stages and explain what are the significant actions during these stages.
  • Stage 1. Channel open until Connect.
  • Stage 2. Status and Headers parsed (OnStartRequest).
  • Stage 3. OnDataAvailable
  • Stage 4. OnStopRequest