Changeset 104e881 in mod_gnutls for src/gnutls_cache.h


Ignore:
Timestamp:
Dec 6, 2016, 2:13:55 AM (4 years ago)
Author:
Thomas Klute <thomas2.klute@…>
Branches:
debian/master, debian/stretch-backports, master, proxy-ticket, upstream
Children:
e0e0b0f
Parents:
14548b9
Message:

General comment updates for Doxygen compatibility

Mostly /* */ vs. / */ changes so Doxygen does catch the correct
descriptions instead of e.g. license headers, plus some minor comment
updates.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/gnutls_cache.h

    r14548b9 r104e881  
    2020 * @file
    2121 *
    22  * Generic object cache for mod_gnutls
     22 * Generic object cache for mod_gnutls.
    2323 */
    2424
     
    3737 * function is called after the configuration file(s) have been
    3838 * parsed.
     39 *
     40 * @param p configuration memory pool
     41 * @param s default server of the Apache configuration, head of the
     42 * server list
     43 * @param sc mod_gnutls data associated with `s`
    3944 */
    4045int mgs_cache_post_config(apr_pool_t *p, server_rec *s, mgs_srvconf_rec *sc);
    4146
    4247/**
    43  * (Re-)Initialize the cache in a child process after forking
     48 * (Re-)Initialize the cache in a child process after forking.
     49 *
     50 * @param p child memory pool provided by Apache
     51 * @param s default server of the Apache configuration, head of the
     52 * server list
     53 * @param sc mod_gnutls data associated with `s`
    4454 */
    4555int mgs_cache_child_init(apr_pool_t *p, server_rec *s, mgs_srvconf_rec *sc);
    4656
    4757/**
    48  * Setup caching for the given TLS session
     58 * Set up caching for the given TLS session.
    4959 *
    5060 * @param ctxt mod_gnutls session context
     61 *
    5162 * @return 0
    5263 */
     
    5768/**
    5869 * Convert a `time_t` into a null terminated string in a format
    59  * compatible with OpenSSL's `ASN1_TIME_print()`
     70 * compatible with OpenSSL's `ASN1_TIME_print()`.
    6071 *
    6172 * @param t time_t time
    6273 * @param str Location to store the time string
    6374 * @param strsize The maximum length that can be stored in `str`
     75 *
    6476 * @return `str`
    6577 */
     
    6779
    6880/**
    69  * Generic store function for the mod_gnutls object cache
     81 * Generic store function for the mod_gnutls object cache.
    7082 *
    7183 * @param s server associated with the cache entry
     
    7385 * @param data data to be cached
    7486 * @param expiry expiration time
    75  * @return -1 on error, 0 on success
     87 *
     88 * @return `-1` on error, `0` on success
    7689 */
    7790typedef int (*cache_store_func)(server_rec *s, gnutls_datum_t key,
    7891                                gnutls_datum_t data, apr_time_t expiry);
    7992/**
    80  * Generic fetch function for the mod_gnutls object cache
     93 * Generic fetch function for the mod_gnutls object cache.
     94 *
     95 * *Warning*: The `data` element of the returned `gnutls_datum_t` is
     96 * allocated using `gnutls_malloc()` for compatibility with the GnuTLS
     97 * session caching API, and must be released using `gnutls_free()`.
    8198 *
    8299 * @param ctxt mod_gnutls session context for the request
    83100 * @param key key for the cache entry to be fetched
     101 *
    84102 * @return the requested cache entry, or `{NULL, 0}`
    85103 */
Note: See TracChangeset for help on using the changeset viewer.