From 58e67b6118a87b48b0edfb65250af6d7ab647ffb Mon Sep 17 00:00:00 2001 From: Alexandra Ellwood Date: Mon, 10 Sep 2007 21:30:37 +0000 Subject: [PATCH] Fixed macro for cc_ccache_unlock and updated documentation ticket: 4644 git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@19930 dc483132-0cff-0310-8789-dd5450dbe970 --- .../group__cc__ccache__iterator__reference.html | 2 +- doc/ccapi/html/group__cc__ccache__reference.html | 2 +- doc/ccapi/html/group__cc__context__reference.html | 2 +- ...group__cc__credentials__iterator__reference.html | 2 +- .../html/group__cc__credentials__reference.html | 2 +- doc/ccapi/html/group__cc__string__reference.html | 2 +- .../html/group__ccapi__constants__reference.html | 2 +- doc/ccapi/html/group__ccapi__types__reference.html | 2 +- doc/ccapi/html/group__helper__macros.html | 13 +++++-------- doc/ccapi/html/index.html | 2 +- doc/ccapi/html/structcc__ccache__d.html | 2 +- doc/ccapi/html/structcc__ccache__f.html | 10 +++++----- doc/ccapi/html/structcc__ccache__iterator__d.html | 2 +- doc/ccapi/html/structcc__ccache__iterator__f.html | 2 +- doc/ccapi/html/structcc__context__d.html | 2 +- doc/ccapi/html/structcc__context__f.html | 2 +- doc/ccapi/html/structcc__credentials__d.html | 2 +- doc/ccapi/html/structcc__credentials__f.html | 2 +- .../html/structcc__credentials__iterator__d.html | 2 +- .../html/structcc__credentials__iterator__f.html | 2 +- doc/ccapi/html/structcc__credentials__union.html | 2 +- doc/ccapi/html/structcc__credentials__v4__t.html | 2 +- doc/ccapi/html/structcc__credentials__v5__t.html | 2 +- doc/ccapi/html/structcc__data.html | 2 +- doc/ccapi/html/structcc__string__d.html | 2 +- doc/ccapi/html/structcc__string__f.html | 2 +- src/include/CredentialsCache.h | 4 ++-- 27 files changed, 36 insertions(+), 39 deletions(-) diff --git a/doc/ccapi/html/group__cc__ccache__iterator__reference.html b/doc/ccapi/html/group__cc__ccache__iterator__reference.html index 3af31e603..c01b39e3a 100644 --- a/doc/ccapi/html/group__cc__ccache__iterator__reference.html +++ b/doc/ccapi/html/group__cc__ccache__iterator__reference.html @@ -68,7 +68,7 @@ For API function documentation see
Generated on Thu Aug 23 12:45:25 2007 for Credentials Cache API by  +
Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  doxygen 1.5.3
diff --git a/doc/ccapi/html/group__cc__ccache__reference.html b/doc/ccapi/html/group__cc__ccache__reference.html index 952f0eb23..40764ed90 100644 --- a/doc/ccapi/html/group__cc__ccache__reference.html +++ b/doc/ccapi/html/group__cc__ccache__reference.html @@ -67,7 +67,7 @@ For API function documentation see

-

Generated on Thu Aug 23 12:45:25 2007 for Credentials Cache API by  +
Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  doxygen 1.5.3
diff --git a/doc/ccapi/html/group__cc__context__reference.html b/doc/ccapi/html/group__cc__context__reference.html index 2d285ed31..3465ca216 100644 --- a/doc/ccapi/html/group__cc__context__reference.html +++ b/doc/ccapi/html/group__cc__context__reference.html @@ -124,7 +124,7 @@ Initialize a new cc_context.

-

Generated on Thu Aug 23 12:45:25 2007 for Credentials Cache API by  +
Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  doxygen 1.5.3
diff --git a/doc/ccapi/html/group__cc__credentials__iterator__reference.html b/doc/ccapi/html/group__cc__credentials__iterator__reference.html index f27c141fb..3ed6b68c8 100644 --- a/doc/ccapi/html/group__cc__credentials__iterator__reference.html +++ b/doc/ccapi/html/group__cc__credentials__iterator__reference.html @@ -97,7 +97,7 @@ For API function documentation see
Generated on Thu Aug 23 12:45:25 2007 for Credentials Cache API by  +
Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  doxygen 1.5.3
diff --git a/doc/ccapi/html/group__cc__credentials__reference.html b/doc/ccapi/html/group__cc__credentials__reference.html index dbb6eb721..90376def1 100644 --- a/doc/ccapi/html/group__cc__credentials__reference.html +++ b/doc/ccapi/html/group__cc__credentials__reference.html @@ -140,7 +140,7 @@ For API functions see cc_cred

-

Generated on Thu Aug 23 12:45:25 2007 for Credentials Cache API by  +
Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  doxygen 1.5.3
diff --git a/doc/ccapi/html/group__cc__string__reference.html b/doc/ccapi/html/group__cc__string__reference.html index 7af692b25..4a17dde2d 100644 --- a/doc/ccapi/html/group__cc__string__reference.html +++ b/doc/ccapi/html/group__cc__string__reference.html @@ -67,7 +67,7 @@ For API function documentation see

-

Generated on Thu Aug 23 12:45:25 2007 for Credentials Cache API by  +
Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  doxygen 1.5.3
diff --git a/doc/ccapi/html/group__ccapi__constants__reference.html b/doc/ccapi/html/group__ccapi__constants__reference.html index ab06bb012..84cc317f1 100644 --- a/doc/ccapi/html/group__ccapi__constants__reference.html +++ b/doc/ccapi/html/group__ccapi__constants__reference.html @@ -344,7 +344,7 @@ String to key type (Kerberos v4 only)
Enumerator:

-

Generated on Thu Aug 23 12:45:25 2007 for Credentials Cache API by  +
Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  doxygen 1.5.3
diff --git a/doc/ccapi/html/group__ccapi__types__reference.html b/doc/ccapi/html/group__ccapi__types__reference.html index f3b8272d1..a9da54d21 100644 --- a/doc/ccapi/html/group__ccapi__types__reference.html +++ b/doc/ccapi/html/group__ccapi__types__reference.html @@ -91,7 +91,7 @@ Signed 64-bit integer type The cc_time_t type is used to represent a time in seconds. The time must be stored as the number of seconds since midnight GMT on January 1, 1970.

-

Generated on Thu Aug 23 12:45:25 2007 for Credentials Cache API by  +
Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  doxygen 1.5.3
diff --git a/doc/ccapi/html/group__helper__macros.html b/doc/ccapi/html/group__helper__macros.html index add1dab6a..30f19568c 100644 --- a/doc/ccapi/html/group__helper__macros.html +++ b/doc/ccapi/html/group__helper__macros.html @@ -33,7 +33,7 @@
  • #define cc_ccache_remove_credentials(ccache, credentials)   ((ccache) -> functions -> remove_credentials (ccache, credentials))
  • #define cc_ccache_new_credentials_iterator(ccache, iterator)   ((ccache) -> functions -> new_credentials_iterator (ccache, iterator))
  • #define cc_ccache_lock(ccache, type, block)   ((ccache) -> functions -> lock (ccache, type, block)) -
  • #define cc_ccache_unlock(ccache, unlock)   ((ccache) -> functions -> unlock (ccache, unlock)) +
  • #define cc_ccache_unlock(ccache)   ((ccache) -> functions -> unlock (ccache))
  • #define cc_ccache_get_last_default_time(ccache, last_default_time)   ((ccache) -> functions -> get_last_default_time (ccache, last_default_time))
  • #define cc_ccache_get_change_time(ccache, change_time)   ((ccache) -> functions -> get_change_time (ccache, change_time))
  • #define cc_ccache_move(source, destination)   ((source) -> functions -> move (source, destination)) @@ -626,20 +626,17 @@ Helper macro for cc_ccache_f n Helper macro for cc_ccache_f lock()

    - +

    - - - - + - +
    #define cc_ccache_unlock (ccache,
    unlock ccache   )    ((ccache) -> functions -> unlock (ccache, unlock))   ((ccache) -> functions -> unlock (ccache))
    @@ -1037,7 +1034,7 @@ Helper macro for cc Helper macro for cc_credentials_iterator_f clone()

    -

    Generated on Thu Aug 23 12:45:25 2007 for Credentials Cache API by  +
    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  doxygen 1.5.3
    diff --git a/doc/ccapi/html/index.html b/doc/ccapi/html/index.html index 3933a7581..47f5e07c2 100644 --- a/doc/ccapi/html/index.html +++ b/doc/ccapi/html/index.html @@ -78,7 +78,7 @@ has an equivalent convenience macro of the form cc_type_some_function():
    Implementing the API in this manner allows us to extend and change the interface in the future, while preserving compatibility with older clients.

    For example, consider the case when the signature or the semantics of a cc_ccache_t function is changed. The API version number is incremented. The library implementation contains both a function with the old signature and semantics and a function with the new signature and semantics. When a context is created, the API version number used in that context is stored in the context, and therefore it can be used whenever a ccache is created in that context. When a ccache is created in a context with the old API version number, the function pointer structure for the ccache is filled with pointers to functions implementing the old semantics; when a ccache is created in a context with the new API version number, the function pointer structure for the ccache is filled with poitners to functions implementing the new semantics.

    -Similarly, if a function is added to the API, the version number in the context can be used to decide whether to include the implementation of the new function in the appropriate function pointer structure or not.

    Generated on Thu Aug 23 12:45:25 2007 for Credentials Cache API by  +Similarly, if a function is added to the API, the version number in the context can be used to decide whether to include the implementation of the new function in the appropriate function pointer structure or not.
    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  doxygen 1.5.3
    diff --git a/doc/ccapi/html/structcc__ccache__d.html b/doc/ccapi/html/structcc__ccache__d.html index 53d198bb5..255367dd9 100644 --- a/doc/ccapi/html/structcc__ccache__d.html +++ b/doc/ccapi/html/structcc__ccache__d.html @@ -28,7 +28,7 @@

    -

    Generated on Thu Aug 23 12:45:25 2007 for Credentials Cache API by  +
    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  doxygen 1.5.3
    diff --git a/doc/ccapi/html/structcc__ccache__f.html b/doc/ccapi/html/structcc__ccache__f.html index d4894d210..480c630ca 100644 --- a/doc/ccapi/html/structcc__ccache__f.html +++ b/doc/ccapi/html/structcc__ccache__f.html @@ -21,7 +21,7 @@ Function pointer table for cc_ccache_t. For more information see
    cc_ccache_new_credentials_iterator(): Iterate over credentials in a ccache.
  • cc_int32(* move )(cc_ccache_t io_source_ccache, cc_ccache_t io_destination_ccache)
    cc_ccache_move(): Move the contents of one ccache into another, destroying the source.
  • cc_int32(* lock )(cc_ccache_t io_ccache, cc_uint32 in_lock_type, cc_uint32 in_block)
    cc_ccache_lock(): Lock a ccache.
  • cc_int32(* unlock )(cc_ccache_t io_ccache) -
    cc_ccache_unlock(): Unlock a ccache.
  • cc_int32(* get_last_default_time )(cc_ccache_t in_ccache, cc_time_t *out_last_default_time) +
    cc_ccache_unlock(): Unlock a ccache.
  • cc_int32(* get_last_default_time )(cc_ccache_t in_ccache, cc_time_t *out_last_default_time)
    cc_ccache_get_change_time(): Get the last time a ccache was the default ccache.
  • cc_int32(* get_change_time )(cc_ccache_t in_ccache, cc_time_t *out_change_time)
    cc_ccache_get_change_time(): Get the last time a ccache changed.
  • cc_int32(* compare )(cc_ccache_t in_ccache, cc_ccache_t in_compare_to_ccache, cc_uint32 *out_equal)
    cc_ccache_compare(): Compare two ccache objects.
  • cc_int32(* get_kdc_time_offset )(cc_ccache_t in_ccache, cc_uint32 in_credentials_version, cc_time_t *out_time_offset) @@ -330,8 +330,8 @@ Attempts to acquire a lock for a ccache. Allowed values for lock_type are:

    If block is cc_lock_block, lock() will not return until the lock is acquired. If block is cc_lock_noblock, lock() will return immediately, either acquiring the lock and returning ccNoError, or failing to acquire the lock and returning an error explaining why.

    To avoid having to deal with differences between thread semantics on different platforms, locks are granted per ccache, rather than per thread or per process. That means that different threads of execution have to acquire separate contexts in order to be able to synchronize with each other.

    -The lock should be unlocked by using cc_ccache_unlock().

    -

    Note:
    All locks are advisory. For example, callers which do not call cc_ccache_lock() and cc_ccache_unlock() will not be prevented from writing to the ccache when you have a read lock. This is because the CCAPI locking was added later and thus adding mandatory locks would have changed the user experience and performance of existing applications.
    +The lock should be unlocked by using cc_ccache_unlock().

    +

    Note:
    All locks are advisory. For example, callers which do not call cc_ccache_lock() and cc_ccache_unlock() will not be prevented from writing to the ccache when you have a read lock. This is because the CCAPI locking was added later and thus adding mandatory locks would have changed the user experience and performance of existing applications.

    @@ -347,7 +347,7 @@ The lock should be unlocked by using

    -cc_ccache_unlock(): Unlock a ccache. +cc_ccache_unlock(): Unlock a ccache.

    Parameters:
    @@ -553,7 +553,7 @@ This function blocks until the next change is made to the ccache referenced by <

    -

    Generated on Thu Aug 23 12:45:25 2007 for Credentials Cache API by  +
    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  doxygen 1.5.3
    diff --git a/doc/ccapi/html/structcc__ccache__iterator__d.html b/doc/ccapi/html/structcc__ccache__iterator__d.html index dcc87ac71..696aa6aff 100644 --- a/doc/ccapi/html/structcc__ccache__iterator__d.html +++ b/doc/ccapi/html/structcc__ccache__iterator__d.html @@ -29,7 +29,7 @@

    -

    Generated on Thu Aug 23 12:45:25 2007 for Credentials Cache API by  +
    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  doxygen 1.5.3
    diff --git a/doc/ccapi/html/structcc__ccache__iterator__f.html b/doc/ccapi/html/structcc__ccache__iterator__f.html index 08c9cc615..af0643ab2 100644 --- a/doc/ccapi/html/structcc__ccache__iterator__f.html +++ b/doc/ccapi/html/structcc__ccache__iterator__f.html @@ -84,7 +84,7 @@ Function pointer table for cc_ccache_iterator_t. For more information see

    -

    Generated on Thu Aug 23 12:45:25 2007 for Credentials Cache API by  +
    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  doxygen 1.5.3
    diff --git a/doc/ccapi/html/structcc__context__d.html b/doc/ccapi/html/structcc__context__d.html index 482438c95..6f2dc456a 100644 --- a/doc/ccapi/html/structcc__context__d.html +++ b/doc/ccapi/html/structcc__context__d.html @@ -28,7 +28,7 @@

    -

    Generated on Thu Aug 23 12:45:25 2007 for Credentials Cache API by  +
    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  doxygen 1.5.3
    diff --git a/doc/ccapi/html/structcc__context__f.html b/doc/ccapi/html/structcc__context__f.html index c1e3083c4..c5a182c63 100644 --- a/doc/ccapi/html/structcc__context__f.html +++ b/doc/ccapi/html/structcc__context__f.html @@ -400,7 +400,7 @@ This function blocks until the next change is made to the cache collection ccach

    -

    Generated on Thu Aug 23 12:45:25 2007 for Credentials Cache API by  +
    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  doxygen 1.5.3
    diff --git a/doc/ccapi/html/structcc__credentials__d.html b/doc/ccapi/html/structcc__credentials__d.html index 0ecb880ce..b616019b4 100644 --- a/doc/ccapi/html/structcc__credentials__d.html +++ b/doc/ccapi/html/structcc__credentials__d.html @@ -45,7 +45,7 @@

    -

    Generated on Thu Aug 23 12:45:25 2007 for Credentials Cache API by  +
    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  doxygen 1.5.3
    diff --git a/doc/ccapi/html/structcc__credentials__f.html b/doc/ccapi/html/structcc__credentials__f.html index 6f4bc74e1..68a833fdb 100644 --- a/doc/ccapi/html/structcc__credentials__f.html +++ b/doc/ccapi/html/structcc__credentials__f.html @@ -60,7 +60,7 @@ Function pointer table for cc_credentials_t. For more information see
    Generated on Thu Aug 23 12:45:25 2007 for Credentials Cache API by  +
    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  doxygen 1.5.3
    diff --git a/doc/ccapi/html/structcc__credentials__iterator__d.html b/doc/ccapi/html/structcc__credentials__iterator__d.html index bc3ccbef9..5b9cef49b 100644 --- a/doc/ccapi/html/structcc__credentials__iterator__d.html +++ b/doc/ccapi/html/structcc__credentials__iterator__d.html @@ -29,7 +29,7 @@

    -

    Generated on Thu Aug 23 12:45:25 2007 for Credentials Cache API by  +
    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  doxygen 1.5.3
    diff --git a/doc/ccapi/html/structcc__credentials__iterator__f.html b/doc/ccapi/html/structcc__credentials__iterator__f.html index 849ee3143..494c7a9a4 100644 --- a/doc/ccapi/html/structcc__credentials__iterator__f.html +++ b/doc/ccapi/html/structcc__credentials__iterator__f.html @@ -60,7 +60,7 @@ Function pointer table for cc_credentials_iterator_t. For more information see <

    -

    Generated on Thu Aug 23 12:45:25 2007 for Credentials Cache API by  +
    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  doxygen 1.5.3
    diff --git a/doc/ccapi/html/structcc__credentials__union.html b/doc/ccapi/html/structcc__credentials__union.html index e2b249b66..81e0ba58c 100644 --- a/doc/ccapi/html/structcc__credentials__union.html +++ b/doc/ccapi/html/structcc__credentials__union.html @@ -79,7 +79,7 @@ If version is
    Generated on Thu Aug 23 12:45:25 2007 for Credentials Cache API by  +
    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  doxygen 1.5.3
    diff --git a/doc/ccapi/html/structcc__credentials__v4__t.html b/doc/ccapi/html/structcc__credentials__v4__t.html index 1eba067cf..df3f8e315 100644 --- a/doc/ccapi/html/structcc__credentials__v4__t.html +++ b/doc/ccapi/html/structcc__credentials__v4__t.html @@ -237,7 +237,7 @@ Ticket size (no greater than cc_v4_ticket_size) Ticket data

    -

    Generated on Thu Aug 23 12:45:25 2007 for Credentials Cache API by  +
    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  doxygen 1.5.3
    diff --git a/doc/ccapi/html/structcc__credentials__v5__t.html b/doc/ccapi/html/structcc__credentials__v5__t.html index 192242afc..0d33734de 100644 --- a/doc/ccapi/html/structcc__credentials__v5__t.html +++ b/doc/ccapi/html/structcc__credentials__v5__t.html @@ -221,7 +221,7 @@ Second ticket data. Authorization data.

    -

    Generated on Thu Aug 23 12:45:25 2007 for Credentials Cache API by  +
    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  doxygen 1.5.3
    diff --git a/doc/ccapi/html/structcc__data.html b/doc/ccapi/html/structcc__data.html index 28b2d37f0..1c2bd7d60 100644 --- a/doc/ccapi/html/structcc__data.html +++ b/doc/ccapi/html/structcc__data.html @@ -61,7 +61,7 @@ The length of data. The data buffer.

    -

    Generated on Thu Aug 23 12:45:25 2007 for Credentials Cache API by  +
    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  doxygen 1.5.3
    diff --git a/doc/ccapi/html/structcc__string__d.html b/doc/ccapi/html/structcc__string__d.html index acc90bde2..d9f958353 100644 --- a/doc/ccapi/html/structcc__string__d.html +++ b/doc/ccapi/html/structcc__string__d.html @@ -44,7 +44,7 @@

    -

    Generated on Thu Aug 23 12:45:25 2007 for Credentials Cache API by  +
    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  doxygen 1.5.3
    diff --git a/doc/ccapi/html/structcc__string__f.html b/doc/ccapi/html/structcc__string__f.html index eae7f3166..40fad79df 100644 --- a/doc/ccapi/html/structcc__string__f.html +++ b/doc/ccapi/html/structcc__string__f.html @@ -34,7 +34,7 @@ Function pointer table for cc_string_t. For more information see

    -

    Generated on Thu Aug 23 12:45:25 2007 for Credentials Cache API by  +
    Generated on Mon Sep 10 17:00:32 2007 for Credentials Cache API by  doxygen 1.5.3
    diff --git a/src/include/CredentialsCache.h b/src/include/CredentialsCache.h index 829a8979d..84783ae51 100644 --- a/src/include/CredentialsCache.h +++ b/src/include/CredentialsCache.h @@ -1514,8 +1514,8 @@ CCACHE_API cc_int32 cc_initialize (cc_context_t *out_context, #define cc_ccache_lock(ccache, type, block) \ ((ccache) -> functions -> lock (ccache, type, block)) /*! Helper macro for cc_ccache_f unlock() */ -#define cc_ccache_unlock(ccache, unlock) \ - ((ccache) -> functions -> unlock (ccache, unlock)) +#define cc_ccache_unlock(ccache) \ + ((ccache) -> functions -> unlock (ccache)) /*! Helper macro for cc_ccache_f get_last_default_time() */ #define cc_ccache_get_last_default_time(ccache, last_default_time) \ ((ccache) -> functions -> get_last_default_time (ccache, last_default_time)) -- 2.26.2