@@ -420,19 +420,9 @@ settings structure:
420420
421421 .. member :: int es_support_push
422422
423- Setting this value to 0 means that
424-
425- For client:
426-
427- 1. we send a SETTINGS frame to indicate that we do not support server
428- push; and
429- 2. all incoming pushed streams get reset immediately.
430-
431- (For maximum effect, set es_max_streams_in to 0.)
432-
433- For server:
434-
435- 1. :func: `lsquic_conn_push_stream() ` will return -1.
423+ Server push is not supported. This setting is retained for API
424+ compatibility. :func: `lsquic_conn_is_push_enabled() ` returns false and
425+ :func: `lsquic_conn_push_stream() ` returns 1.
436426
437427 .. member :: int es_support_tcid0
438428
@@ -1009,7 +999,7 @@ out of date. Please check your :file:`lsquic.h` for actual values.*
1009999
10101000.. macro :: LSQUIC_DF_SUPPORT_PUSH
10111001
1012- Push promises are supported by default .
1002+ Server push is not supported .
10131003
10141004.. macro :: LSQUIC_DF_SUPPORT_TCID0
10151005
@@ -1868,7 +1858,8 @@ fields yourself. In that case, the header set must be "read" from the stream vi
18681858 :param stream: Stream with which the header set is associated. May be set
18691859 to NULL in server mode.
18701860 :param is_push_promise: Boolean value indicating whether this header set is
1871- for a push promise.
1861+ for a push promise. Server push is not supported;
1862+ this parameter is retained for API compatibility.
18721863 :return: Pointer to user-defined header set object.
18731864
18741865 Create a new header set. This object is (and must be) fetched from a
@@ -1946,46 +1937,52 @@ fields yourself. In that case, the header set must be "read" from the stream vi
19461937Push Promises
19471938-------------
19481939
1940+ Server push is not supported. The following functions remain in the API for
1941+ compatibility.
1942+
19491943.. function :: int lsquic_conn_push_stream (lsquic_conn_t *conn, void *hdr_set, lsquic_stream_t *stream, const lsquic_http_headers_t *headers)
19501944
19511945 :return:
19521946
1953- - 0: Stream pushed successfully.
1954- - 1: Stream push failed because it is disabled or because we hit
1955- stream limit or connection is going away.
1956- - -1: Stream push failed because of an internal error.
1957-
1958- A server may push a stream. This call creates a new stream in reference
1959- to stream ``stream ``. It will behave as if the client made a request: it will
1960- trigger ``on_new_stream() `` event and it can be used as a regular client-initiated stream.
1947+ - 1: Stream push failed because server push is not supported.
19611948
1962- `` hdr_set `` must be set. It is passed as-is to :func: ` lsquic_stream_get_hset() ` .
1949+ This function is retained for API compatibility .
19631950
19641951.. function :: int lsquic_conn_is_push_enabled (lsquic_conn_t *conn)
19651952
1966- :return: Boolean value indicating whether push promises are enabled .
1953+ :return: 0 .
19671954
1968- Only makes sense in server mode: the client cannot push a stream and this
1969- function always returns false in client mode.
1955+ This function is retained for API compatibility.
19701956
19711957.. function :: int lsquic_stream_is_pushed (const lsquic_stream_t *stream)
19721958
1973- :return: Boolean value indicating whether this is a pushed stream.
1959+ :return: Boolean value indicating whether this is a legacy pushed stream.
1960+
1961+ This function is retained for API compatibility. Current LSQUIC versions
1962+ do not create pushed streams.
19741963
19751964.. function :: int lsquic_stream_refuse_push (lsquic_stream_t *stream)
19761965
1977- Refuse pushed stream. Call it from ``on_new_stream() ``. No need to
1978- call :func: `lsquic_stream_close() ` after this. ``on_close() `` will be called.
1966+ Refuse a legacy pushed stream.
1967+
1968+ This function is retained for API compatibility. Current LSQUIC versions
1969+ do not create pushed streams.
19791970
19801971.. function :: int lsquic_stream_push_info (const lsquic_stream_t *stream, lsquic_stream_id_t *ref_stream_id, void **hdr_set)
19811972
1982- Get information associated with pushed stream
1973+ Get information associated with a legacy pushed stream.
19831974
1984- :param ref_stream_id: Stream ID in response to which push promise was sent.
1985- :param hdr_set: Header set. This object was passed to or generated by :func: `lsquic_conn_push_stream() `.
1975+ :param ref_stream_id: Stream ID in response to which a push promise would
1976+ have been sent.
1977+ :param hdr_set: Header set. In legacy push-enabled versions, this object
1978+ was passed to or generated by
1979+ :func: `lsquic_conn_push_stream() `.
19861980
19871981 :return: 0 on success and -1 if this is not a pushed stream.
19881982
1983+ This function is retained for API compatibility. Current LSQUIC versions
1984+ do not create pushed streams.
1985+
19891986Stream Priorities
19901987-----------------
19911988
0 commit comments