summaryrefslogtreecommitdiff
path: root/doc/dlt_extended_network_trace.md
diff options
context:
space:
mode:
authorthanhbnq <49302843+thanhbnq@users.noreply.github.com>2019-04-16 14:52:52 +0700
committerSaya Sugiura <39760799+ssugiura@users.noreply.github.com>2019-04-16 16:52:52 +0900
commit5d21bc4858c7d0d67adb1e0cdec9880d97b83567 (patch)
tree7ff7f2e5bb6ebf3c2d51e5e3eb2a08df2449aaef /doc/dlt_extended_network_trace.md
parent376bf6c1750d8d1c6bb1a5abc73e5b081d7b7825 (diff)
downloadDLT-daemon-5d21bc4858c7d0d67adb1e0cdec9880d97b83567.tar.gz
doc: Update doc/CMakeList.txt after cleanup documentation (#111) (#117)
* doc: Update after cleanup documentation - Add ascii_doc check - Spaces instead of tabs in doc/CMakeList.txt - Change style in markdown files to avoid error while converting from md to html - Since manpages are generated by pandoc, "doc-man" part is removed from doc/CMakeList.txt Signed-off-by: thanhbnq <thanh.buinguyenquoc@vn.bosch.vn>
Diffstat (limited to 'doc/dlt_extended_network_trace.md')
-rw-r--r--doc/dlt_extended_network_trace.md14
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/dlt_extended_network_trace.md b/doc/dlt_extended_network_trace.md
index 24554c0..8bc7ea0 100644
--- a/doc/dlt_extended_network_trace.md
+++ b/doc/dlt_extended_network_trace.md
@@ -20,7 +20,7 @@ Finally after sending all the data segments, one more packet is sent to indicate
Truncated message can be sent using the following function:
-> int dlt_user_trace_network_truncated(DltContext *handle, DltNetworkTraceType nw_trace_type, uint16_t header_len, void *header, uint16_t payload_len, void *payload, int allow_truncate)
+` int dlt_user_trace_network_truncated(DltContext *handle, DltNetworkTraceType nw_trace_type, uint16_t header_len, void *header, uint16_t payload_len, void *payload, int allow_truncate) `
This will send a packet in the following format:
@@ -35,17 +35,17 @@ payload | The truncated nw_trace payload | RAW
User can send a segmented network trace message asynchronously using:
-> void dlt_user_trace_network_segmented(DltContext *handle, DltNetworkTraceType nw_trace_type, uint16_t header_len, void *header, uint16_t payload_len, void *payload)
+` void dlt_user_trace_network_segmented(DltContext *handle, DltNetworkTraceType nw_trace_type, uint16_t header_len, void *header, uint16_t payload_len, void *payload) `
This will start a background thread and return immediately.
User can also send all the required packages one by one using:
-> int dlt_user_trace_network_segmented_start(unsigned int *id, DltContext *handle, DltNetworkTraceType nw_trace_type, uint16_t header_len, void *header, uint16_t payload_len)
->
-> int dlt_user_trace_network_segmented_segment(int id, DltContext *handle, DltNetworkTraceType nw_trace_type, int sequence, uint16_t payload_len, void *payload)
->
-> int dlt_user_trace_network_segmented_end(int id, DltContext *handle, DltNetworkTraceType nw_trace_type)
+` int dlt_user_trace_network_segmented_start(unsigned int *id, DltContext *handle, DltNetworkTraceType nw_trace_type, uint16_t header_len, void *header, uint16_t payload_len) `
+
+` int dlt_user_trace_network_segmented_segment(int id, DltContext *handle, DltNetworkTraceType nw_trace_type, int sequence, uint16_t payload_len, void *payload) `
+
+` int dlt_user_trace_network_segmented_end(int id, DltContext *handle, DltNetworkTraceType nw_trace_type) `
*NOTE*: It is not recommended to use these functions unless you really have to.