File: index.rst

package info (click to toggle)
firefox 143.0.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,617,328 kB
  • sloc: cpp: 7,478,492; javascript: 6,417,157; ansic: 3,720,058; python: 1,396,372; xml: 627,523; asm: 438,677; java: 186,156; sh: 63,477; makefile: 19,171; objc: 13,059; perl: 12,983; yacc: 4,583; cs: 3,846; pascal: 3,405; lex: 1,720; ruby: 1,003; exp: 762; php: 436; lisp: 258; awk: 247; sql: 66; sed: 53; csh: 10
file content (63 lines) | stat: -rw-r--r-- 2,759 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
=============================
Inspecting server-sent events
=============================

`Server-sent events <https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events>`_ allow for an inversion of the traditional client-initiated web request model, with a server sending new data to a web page at any time by pushing messages. You can inspect server-sent events and their message contents using the :doc:`Network Monitor <../index>`. This article shows you how.

Inspecting the SSE network activity
***********************************

When you are viewing a document that is receiving server-sent events, you can go to the Network Monitor, select the file that is sending the server-sent events, and view the received messages in the *Response* tab on the right-hand panel.

.. image:: basic-sse-message-view.png
  :class: border


At the top of the panel there is a trash can icon, which allows you to trash the messages sent so far, and a filter field in which you can enter a text string to filter the displayed messages by.


Viewing the message contents
****************************

Select one of the messages listed in the *Response* tab, and you'll see the message contents displayed at the bottom of that same tab.

.. image:: see-message-detail-view.png
  :class: border

In the above example, you can see that JSON and raw data representations of the content are shown. For a plain text message, you'd just see a raw data section.

The supported data formats are as follows:

- Mercure protocol
- JSON


Customizing the displayed columns
*********************************

For each message, you'll see *Data* and Time columns by default, but you can right-click on the table header to bring up a context menu in which you can toggle columns on and off, and reset it back to its original state.

.. image:: customize-columns.png
  :class: border

The available columns are as follows:

- *Data*: A summary of the contained message data.
- *Size*: The size of the message.
- *Time*: A timestamp representing when the message was sent.
- *Event Name*: The name of the event type that resulted in the message being sent (e.g. ```message``` or ```ping```).
- *Last Event ID*: The ID of the last event that was fired.
- *Retry*: The interval after which failed message will be resent.


Network Monitor features
************************

The following articles cover different aspects of using the network monitor:

- :doc:`Toolbar <../toolbar/index>`
- :doc:`Network request list <../request_list/index>`
- :doc:`Network request details <../request_details/index>`
- :doc:`Network traffic recording <../performance_analysis/index>`
- :doc:`Throttling <../throttling/index>`
- :doc:`Inspecting web sockets <../inspecting_web_sockets/index>`