diff options
author | Keith Bostic <keith@wiredtiger.com> | 2016-02-21 13:23:51 -0500 |
---|---|---|
committer | Keith Bostic <keith@wiredtiger.com> | 2016-02-21 13:23:51 -0500 |
commit | 9e2430e56c0b578aa5942ecc31353f351d05864b (patch) | |
tree | 07e266f102e3b3817660c164081b9654fca2b6af /src/include/wiredtiger.in | |
parent | c4b6096c81a502e5f5d345e3af92817f49afe229 (diff) | |
download | mongo-9e2430e56c0b578aa5942ecc31353f351d05864b.tar.gz |
WT-2107: Add example code including an event handler
Clean up thread-safe vs. global "display error strings" documentation:
the global code snippet was wrong, there wasn't a java thread-safe
snippet, add a mention of the thread-safe API to the error-handling
page, quit trying to enumerate the underlying strerror(3) standards.
Diffstat (limited to 'src/include/wiredtiger.in')
-rw-r--r-- | src/include/wiredtiger.in | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/src/include/wiredtiger.in b/src/include/wiredtiger.in index 338b95c8208..32def98b5e2 100644 --- a/src/include/wiredtiger.in +++ b/src/include/wiredtiger.in @@ -828,7 +828,8 @@ struct __wt_session { * @snippet ex_all.c Display an error thread safe * * @param session the session handle - * @param error a return value from a WiredTiger function + * @param error a return value from a WiredTiger, ISO C, or POSIX + * standard API * @returns a string representation of the error */ const char *__F(strerror)(WT_SESSION *session, int error); @@ -2434,11 +2435,12 @@ int wiredtiger_open(const char *home, WT_CONNECTION **connectionp); /*! - * Return information about a WiredTiger error as a string, not thread-safe. + * Return information about a WiredTiger error as a string (see + * WT_SESSION::strerror for a thread-safe API). * * @snippet ex_all.c Display an error * - * @param error a return value from a WiredTiger call + * @param error a return value from a WiredTiger, ISO C, or POSIX standard API * @returns a string representation of the error */ const char *wiredtiger_strerror(int error); @@ -2491,8 +2493,9 @@ struct __wt_event_handler { * @param session the WiredTiger session handle in use when the error * was generated. The handle may have been created by the application * or automatically by WiredTiger. - * @param error a WiredTiger, C99 or POSIX error code, which can - * be converted to a string using ::wiredtiger_strerror + * @param error a return value from a WiredTiger, ISO C, or + * POSIX standard API, which can be converted to a string using + * WT_SESSION::strerror * @param message an error string */ int (*handle_error)(WT_EVENT_HANDLER *handler, |