From d0bca4a65aae56d887b7f767541f12a07d503dcd Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Tue, 4 Dec 2007 16:34:00 +0000 Subject: [PATCH] Add GChecksum public API. 2007-12-04 Emmanuele Bassi * glib/glib-sections.txt: Add GChecksum public API. * glib/tmpl/checksum.sgml: * glib/glib-docs.sgml: Add the checksums API page. svn path=/trunk/; revision=6044 --- docs/reference/ChangeLog | 7 ++ docs/reference/glib/glib-docs.sgml | 2 + docs/reference/glib/glib-sections.txt | 16 ++++ docs/reference/glib/tmpl/checksum.sgml | 128 +++++++++++++++++++++++++ 4 files changed, 153 insertions(+) create mode 100644 docs/reference/glib/tmpl/checksum.sgml diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index f6fd9965..95ae07ec 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,10 @@ +2007-12-04 Emmanuele Bassi + + * glib/glib-sections.txt: Add GChecksum public API. + + * glib/tmpl/checksum.sgml: + * glib/glib-docs.sgml: Add the checksums API page. + 2007-11-29 Behdad Esfahbod Bug 500361 – Improve docs for g_array_free() and g_ptr_array_free() diff --git a/docs/reference/glib/glib-docs.sgml b/docs/reference/glib/glib-docs.sgml index d4f92005..43389260 100644 --- a/docs/reference/glib/glib-docs.sgml +++ b/docs/reference/glib/glib-docs.sgml @@ -60,6 +60,7 @@ + @@ -142,6 +143,7 @@ synchronize their operation. &glib-Character-Set-Conversion; &glib-Unicode-Manipulation; &glib-Base64; + &glib-Checksum; &glib-i18n; &glib-Date-and-Time-Functions; &glib-Random-Numbers; diff --git a/docs/reference/glib/glib-sections.txt b/docs/reference/glib/glib-sections.txt index a86f3ca6..e54f028d 100644 --- a/docs/reference/glib/glib-sections.txt +++ b/docs/reference/glib/glib-sections.txt @@ -2518,3 +2518,19 @@ g_uri_get_scheme g_uri_unescape_segment g_uri_unescape_string + +
+Data Checksums +checksum +GChecksumType +GChecksum +g_checksum_new +g_checksum_copy +g_checksum_free +g_checksum_update +g_checksum_get_string +g_checksum_get_digest + +g_compute_checksum_for_data +g_compute_checksum_for_string +
diff --git a/docs/reference/glib/tmpl/checksum.sgml b/docs/reference/glib/tmpl/checksum.sgml new file mode 100644 index 00000000..7d453770 --- /dev/null +++ b/docs/reference/glib/tmpl/checksum.sgml @@ -0,0 +1,128 @@ + +Data Checksums + + +Computes the checksum for data + + + +GLib provides a generic API for computing checksums (or "digests") for a +sequence of arbitrary bytes, using various hashing algorithms like MD5, +SHA-1 and SHA-256. Checksums are commonly used in various environments and +specifications. + + + +GLib supports incremental checksums using the GChecksum data structure, by +calling g_checksum_update() as long as there's data available and then using +g_checksum_get_string() or g_checksum_get_digest() to compute the checksum +and return it either as a string in hexadecimal form, or as a raw sequence +of bytes. To compute the checksum for binary blobs and NUL-terminated strings +in one go, use the convenience functions g_compute_checksum_for_data() and +g_compute_checksum_for_string(), respectively. + + + +Support for checksums has been added in GLib 2.16 + + + + + + + + + + + + + + + +@G_CHECKSUM_MD5: +@G_CHECKSUM_SHA1: +@G_CHECKSUM_SHA256: + + + + + + + + + + + + +@checksum_type: +@Returns: + + + + + + + +@checksum: +@Returns: + + + + + + + +@checksum: + + + + + + + +@checksum: +@data: +@length: + + + + + + + +@checksum: +@Returns: + + + + + + + +@checksum: +@digest: +@digest_len: + + + + + + + +@checksum_type: +@data: +@length: +@Returns: + + + + + + + +@checksum_type: +@str: +@length: +@Returns: + + -- 2.34.1