Skip to content

Commit

Permalink
Dev/doc (#463)
Browse files Browse the repository at this point in the history 
* [+] add mini testfile

* [+] add mini c/s

* [+] server reply if receives a req

* [=] fix mini format

* [=] format code

* [=] fix comment format

* [=] fix comment format

* [=] fix diff

* [=] fix mini_server

* [=] delete global param

* [=] fix global param err
  • Loading branch information
@cherylsy
cherylsy authored Nov 22, 2024
1 parent 7ba7e92 commit b36c1ef
Show file tree
Hide file tree
Showing 23 changed files with 3,400 additions and 480 deletions.
1 change: 1 addition & 0 deletions CMakeLists.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,7 @@ endif()
if(XQC_ENABLE_TESTING)
add_subdirectory(tests)
add_subdirectory(demo)
add_subdirectory(mini)
endif(XQC_ENABLE_TESTING)


Expand Down
6 changes: 6 additions & 0 deletions demo/CMakeLists.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,22 @@ set(
"xqc_hq_conn.c"
"xqc_hq_request.c"
)
set(
TEST_PLATFORM_SOURCES
"../tests/platform.c"
)

set(
DEMO_CLIENT_SOURCES
${HQ_SOURCES}
${TEST_PLATFORM_SOURCES}
"demo_client.c"
)

set(
DEMO_SERVER_SOURCES
${HQ_SOURCES}
${TEST_PLATFORM_SOURCES}
"demo_server.c"
)

Expand Down
4 changes: 2 additions & 2 deletions demo/demo_client.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -892,7 +892,7 @@ xqc_demo_cli_conn_create_path(const xqc_cid_t *cid, void *conn_user_data)
printf("set No.%d path (id = %"PRIu64") to STANDBY state\n", 1, path_id);
xqc_conn_mark_path_standby(ctx->engine, &(user_conn->cid), path_id);
}

}
}

Expand Down Expand Up @@ -2225,7 +2225,7 @@ xqc_demo_cli_send_h3_req(xqc_demo_cli_user_conn_t *user_conn,
if (req_create_cnt == user_conn->ctx->args->req_cfg.throttled_req) {
settings.recv_rate_bytes_per_sec = user_conn->ctx->args->quic_cfg.recv_rate;
}

if (req_create_cnt != 0
&& user_conn->ctx->args->req_cfg.throttled_req != 0
&& (req_create_cnt % user_conn->ctx->args->req_cfg.throttled_req) == 0)
Expand Down
264 changes: 135 additions & 129 deletions include/xquic/xqc_errno.h
View file

Large diffs are not rendered by default.

129 changes: 73 additions & 56 deletions include/xquic/xqc_http3.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,22 @@ extern "C" {
* @brief read flag of xqc_h3_request_read_notify_pt
*/
typedef enum {
/* nothing readable */
/** nothing readable */
XQC_REQ_NOTIFY_READ_NULL = 0,

/* read header section flag, this will be set when the first HEADERS is processed */
/** read header section flag, this will be set when the first HEADERS is processed */
XQC_REQ_NOTIFY_READ_HEADER = 1 << 0,

/* read body flag, this will be set when a DATA frame is processed */
/** read body flag, this will be set when a DATA frame is processed */
XQC_REQ_NOTIFY_READ_BODY = 1 << 1,

/* read trailer section flag, this will be set when trailer HEADERS frame is processed */
/** read trailer section flag, this will be set when trailer HEADERS frame is processed */
XQC_REQ_NOTIFY_READ_TRAILER = 1 << 2,

/* read empty fin flag, notify callback will be triggered when a single fin frame is received
while HEADERS and DATA were notified. This flag will NEVER be set with other flags */
/**
* read empty fin flag, notify callback will be triggered when a single fin frame is received
while HEADERS and DATA were notified. This flag will NEVER be set with other flags
*/
XQC_REQ_NOTIFY_READ_EMPTY_FIN = 1 << 3,
} xqc_request_notify_flag_t;

Expand Down Expand Up @@ -88,28 +90,28 @@ typedef enum xqc_http3_nv_flag_s {


typedef struct xqc_http_header_s {
/* name of http header */
/** name of http header */
struct iovec name;

/* value of http header */
/** value of http header */
struct iovec value;

/* flags of xqc_http3_nv_flag_t with OR operator */
/** flags of xqc_http3_nv_flag_t with OR operator */
uint8_t flags;
} xqc_http_header_t;


typedef struct xqc_http_headers_s {
/* array of http headers */
/** array of http headers */
xqc_http_header_t *headers;

/* count of headers */
/** count of headers */
size_t count;

/* capacity of headers */
/** capacity of headers */
size_t capacity;

/* total byte count of headers */
/** total byte count of headers */
size_t total_len;
} xqc_http_headers_t;

Expand All @@ -122,19 +124,32 @@ typedef struct xqc_http_headers_s {
typedef struct xqc_request_stats_s {
size_t send_body_size;
size_t recv_body_size;
size_t send_header_size; /* plaintext header size */
size_t recv_header_size; /* plaintext header size */
size_t send_hdr_compressed; /* compressed header size */
size_t recv_hdr_compressed; /* compressed header size */
int stream_err; /* QUIC layer error code, 0 for no error */
xqc_usec_t blocked_time; /* time of h3 stream being blocked */
xqc_usec_t unblocked_time; /* time of h3 stream being unblocked */
xqc_usec_t stream_fin_time; /* time of receiving transport fin */
xqc_usec_t h3r_begin_time; /* time of creating request */
xqc_usec_t h3r_end_time; /* time of request fin */
xqc_usec_t h3r_header_begin_time; /* time of receiving HEADERS frame */
xqc_usec_t h3r_header_end_time; /* time of finishing processing HEADERS frame */
xqc_usec_t h3r_body_begin_time; /* time of receiving DATA frame */
/** plaintext header size */
size_t send_header_size;
/** plaintext header size */
size_t recv_header_size;
/** compressed header size */
size_t send_hdr_compressed;
/** compressed header size */
size_t recv_hdr_compressed;
/** QUIC layer error code, 0 for no error */
int stream_err;
/** time of h3 stream being blocked */
xqc_usec_t blocked_time;
/** time of h3 stream being unblocked */
xqc_usec_t unblocked_time;
/** time of receiving transport fin */
xqc_usec_t stream_fin_time;
/** time of creating request */
xqc_usec_t h3r_begin_time;
/** time of request fin */
xqc_usec_t h3r_end_time;
/** time of receiving HEADERS frame */
xqc_usec_t h3r_header_begin_time;
/** time of finishing processing HEADERS frame */
xqc_usec_t h3r_header_end_time;
/** time of receiving DATA frame */
xqc_usec_t h3r_body_begin_time;
xqc_usec_t h3r_header_send_time;
xqc_usec_t h3r_body_send_time;
xqc_usec_t stream_fin_send_time;
Expand Down Expand Up @@ -171,7 +186,7 @@ typedef struct xqc_request_stats_s {
/**
* @brief how long the request was blocked by congestion control (ms)
*/
xqc_msec_t cwnd_blocked_ms;
xqc_msec_t cwnd_blocked_ms;
/**
* @brief the number of packet has been retransmitted
*/
Expand Down Expand Up @@ -209,25 +224,27 @@ typedef struct xqc_h3_ext_bytestream_stats_s {
xqc_usec_t first_byte_rcvd_time;
} xqc_h3_ext_bytestream_stats_t;

/* connection settings for http3 */
/**
* @brief connection settings for http3
*/
typedef struct xqc_h3_conn_settings_s {
/* MAX_FIELD_SECTION_SIZE of http3 */
/** MAX_FIELD_SECTION_SIZE of http3 */
uint64_t max_field_section_size;

/* MAX_PUSH_STREAMS */
/** MAX_PUSH_STREAMS */
uint64_t max_pushes;

/* ENC_MAX_DYNAMIC_TABLE_CAPACITY */
/** ENC_MAX_DYNAMIC_TABLE_CAPACITY */
uint64_t qpack_enc_max_table_capacity;

/* DEC_MAX_DYNAMIC_TABLE_CAPACITY */
/** DEC_MAX_DYNAMIC_TABLE_CAPACITY */
uint64_t qpack_dec_max_table_capacity;

/* MAX_BLOCKED_STREAMS */
/** MAX_BLOCKED_STREAMS */
uint64_t qpack_blocked_streams;

#ifdef XQC_COMPAT_DUPLICATE
/* compat with the original qpack encoder's duplicate strategy */
/** compat with the original qpack encoder's duplicate strategy */
xqc_bool_t qpack_compat_duplicate;
#endif

Expand Down Expand Up @@ -316,16 +333,16 @@ typedef void (*xqc_h3_ext_datagram_mss_updated_notify_pt)(xqc_h3_conn_t *conn,

typedef struct xqc_h3_ext_dgram_callbacks_s {

/* the return value is ignored by XQUIC stack */
/** the return value is ignored by XQUIC stack */
xqc_h3_ext_datagram_read_notify_pt dgram_read_notify;

/* the return value is ignored by XQUIC stack */
/** the return value is ignored by XQUIC stack */
xqc_h3_ext_datagram_write_notify_pt dgram_write_notify;

/* the return value is ignored by XQUIC stack */
/** the return value is ignored by XQUIC stack */
xqc_h3_ext_datagram_acked_notify_pt dgram_acked_notify;

/* the return value is ignored by XQUIC stack */
/** the return value is ignored by XQUIC stack */
xqc_h3_ext_datagram_lost_notify_pt dgram_lost_notify;
xqc_h3_ext_datagram_mss_updated_notify_pt dgram_mss_updated_notify;

Expand All @@ -335,16 +352,16 @@ typedef struct xqc_h3_ext_dgram_callbacks_s {
* @brief http3 connection callbacks for application layer
*/
typedef struct xqc_h3_conn_callbacks_s {
/* http3 connection creation callback, REQUIRED for server, OPTIONAL for client */
/** http3 connection creation callback, REQUIRED for server, OPTIONAL for client */
xqc_h3_conn_notify_pt h3_conn_create_notify;

/* http3 connection close callback */
/** http3 connection close callback */
xqc_h3_conn_notify_pt h3_conn_close_notify;

/* handshake finished callback. which will be triggered when HANDSHAKE_DONE is received */
/** handshake finished callback. which will be triggered when HANDSHAKE_DONE is received */
xqc_h3_handshake_finished_pt h3_conn_handshake_finished;

/* ping callback. which will be triggered when ping is acked */
/** ping callback. which will be triggered when ping is acked */
xqc_h3_conn_ping_ack_notify_pt h3_conn_ping_acked; /* optional */

} xqc_h3_conn_callbacks_t;
Expand All @@ -354,53 +371,53 @@ typedef struct xqc_h3_conn_callbacks_s {
* @brief http3 request callbacks for application layer
*/
typedef struct xqc_h3_request_callbacks_s {
/* request creation notify. it will be triggered after a request was created, and is required
/** request creation notify. it will be triggered after a request was created, and is required
for server, optional for client */
xqc_h3_request_notify_pt h3_request_create_notify;

/* request close notify. which will be triggered after a request was closed */
/** request close notify. which will be triggered after a request was closed */
xqc_h3_request_notify_pt h3_request_close_notify;

/* request read notify callback. which will be triggered after received http headers or body */
/** request read notify callback. which will be triggered after received http headers or body */
xqc_h3_request_read_notify_pt h3_request_read_notify;

/* request write notify callback. when triggered, users can continue to send headers or body */
/** request write notify callback. when triggered, users can continue to send headers or body */
xqc_h3_request_notify_pt h3_request_write_notify;

/* request closing notify callback, will be triggered when request is closing */
/** request closing notify callback, will be triggered when request is closing */
xqc_h3_request_closing_notify_pt h3_request_closing_notify;

} xqc_h3_request_callbacks_t;

typedef struct xqc_h3_ext_bytestream_callbacks_s {

/* the return value is ignored by XQUIC stack */
/** the return value is ignored by XQUIC stack */
xqc_h3_ext_bytestream_notify_pt bs_create_notify;

/* the return value is ignored by XQUIC stack */
/** the return value is ignored by XQUIC stack */
xqc_h3_ext_bytestream_notify_pt bs_close_notify;

/* negative return values will cause the connection to be closed */
/** negative return values will cause the connection to be closed */
xqc_h3_ext_bytestream_read_notify_pt bs_read_notify;

/* negative return values will cause the connection to be closed */
/** negative return values will cause the connection to be closed */
xqc_h3_ext_bytestream_notify_pt bs_write_notify;

} xqc_h3_ext_bytestream_callbacks_t;


typedef struct xqc_h3_callbacks_s {

/* http3 connection callbacks */
/** http3 connection callbacks */
xqc_h3_conn_callbacks_t h3c_cbs;

/* http3 request callbacks */
/** http3 request callbacks */
xqc_h3_request_callbacks_t h3r_cbs;

/* datagram callbacks */
/** datagram callbacks */
xqc_h3_ext_dgram_callbacks_t h3_ext_dgram_cbs;

/* bytestream callbacks */
/** bytestream callbacks */
xqc_h3_ext_bytestream_callbacks_t h3_ext_bs_cbs;

} xqc_h3_callbacks_t;
Expand Down Expand Up @@ -496,7 +513,7 @@ void xqc_h3_engine_set_local_settings(xqc_engine_t *engine,
* @brief create and http3 connection
*
* @param engine return from xqc_engine_create
* @param conn_settings connection settings
* @param conn_settings Include all the connection settings, which should be customized according to the actual needs, and will be defaultly set to internal_default_conn_settings if not specified.
* @param token token receive from server, xqc_save_token_pt callback
* @param token_len length of token
* @param server_host server domain
Expand Down
Loading

0 comments on commit b36c1ef

Please sign in to comment.