From f770b7e084d6c2d1ac04d9e723cd793ec52187d9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Thu, 23 Jan 2020 18:49:50 +0100 Subject: [PATCH] man: document man/sd_bus_message_dump.xml --- man/rules/meson.build | 1 + man/sd-bus.xml | 1 + man/sd_bus_message_dump.xml | 107 ++++++++++++++++++++++++++++++++++++ 3 files changed, 109 insertions(+) create mode 100644 man/sd_bus_message_dump.xml diff --git a/man/rules/meson.build b/man/rules/meson.build index 90376da7759..58c1f612418 100644 --- a/man/rules/meson.build +++ b/man/rules/meson.build @@ -230,6 +230,7 @@ manpages = [ ''], ['sd_bus_message_append_strv', '3', [], ''], ['sd_bus_message_copy', '3', [], ''], + ['sd_bus_message_dump', '3', [], ''], ['sd_bus_message_get_cookie', '3', ['sd_bus_message_get_reply_cookie'], ''], ['sd_bus_message_get_monotonic_usec', '3', diff --git a/man/sd-bus.xml b/man/sd-bus.xml index e9a66d87ddd..76865e1f8ee 100644 --- a/man/sd-bus.xml +++ b/man/sd-bus.xml @@ -58,6 +58,7 @@ sd_bus_message_append_string_memfd3, sd_bus_message_append_strv3, sd_bus_message_copy3, +sd_bus_message_dump3, sd_bus_message_get_cookie3, sd_bus_message_get_monotonic_usec3, sd_bus_message_get_signature3, diff --git a/man/sd_bus_message_dump.xml b/man/sd_bus_message_dump.xml new file mode 100644 index 00000000000..db9e46d9913 --- /dev/null +++ b/man/sd_bus_message_dump.xml @@ -0,0 +1,107 @@ + + + + + + + + sd_bus_message_dump + systemd + + + + sd_bus_message_dump + 3 + + + + sd_bus_message_dump + + Produce a string representation of a message for debugging purposes + + + + + #include <systemd/sd-bus.h> + + + int sd_bus_message_dump + sd_bus_message *m + FILE *f + uint64_t flags + + + + + SD_BUS_MESSAGE_DUMP_WITH_HEADER, + SD_BUS_MESSAGE_DUMP_SUBTREE_ONLY + + + + + Description + + The sd_bus_message_dump() function writes a textual representation of the + message m to the stream f. This function is intended to be + used for debugging purposes, and the output is neither stable nor designed to be machine readable. + + + The flags parameter may be used to modify the output. With + SD_BUS_MESSAGE_DUMP_WITH_HEADER, a header that specifies the message type and flags + and some additional metadata is printed. When SD_BUS_MESSAGE_DUMP_SUBTREE_ONLY is + not passed, the contents of the whole message are printed. When it is passed, + only the current container in printed. + + Note that this function moves the read pointer of the message. It may be necessary to reset the + position afterwards, for example with + sd_bus_message_rewind3. + + + + + Examples + + Output for a signal message (with SD_BUS_MESSAGE_DUMP_WITH_HEADER): + +‣ Type=signal Endian=l Flags=1 Version=1 Priority=0 Cookie=22 + Path=/value/a Interface=org.freedesktop.DBus.Properties Member=PropertiesChanged + MESSAGE "sa{sv}as" { + STRING "org.freedesktop.systemd.ValueTest"; + ARRAY "{sv}" { + DICT_ENTRY "sv" { + STRING "Value"; + VARIANT "s" { + STRING "object 0x1e, path /value/a"; + }; + }; + }; + ARRAY "s" { + STRING "Value2"; + STRING "AnExplicitProperty"; + }; + }; + + + + + + Return Value + + On success, this function returns 0 or a positive integer. On failure, it returns a negative + errno-style error code. No error codes are currently defined. + + + + + + See Also + + + systemd1, + sd-bus3 + + + +