1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>DbEnv::set_thread_id_string()</title>
<link rel="stylesheet" href="apiReference.css" type="text/css" />
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
<link rel="start" href="index.html" title="Berkeley DB C++ API Reference" />
<link rel="up" href="env.html" title="Chapter 5. The DbEnv Handle" />
<link rel="prev" href="envset_thread_id.html" title="DbEnv::set_thread_id()" />
<link rel="next" href="envset_timeout.html" title="DbEnv::set_timeout()" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.3</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DbEnv::set_thread_id_string()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="envset_thread_id.html">Prev</a> </td>
<th width="60%" align="center">Chapter 5.
The DbEnv Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="envset_timeout.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="envset_thread_id_string"></a>DbEnv::set_thread_id_string()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db_cxx>
int
DbEnv::set_thread_id(void (*thread_id)
(DbEnv *dbenv, pid_t *pid, db_threadid_t *tid)); </pre>
<p>
Declare a function that formats a process ID and thread ID identifier
pair for display into a caller-supplied buffer. The function must
return a reference to the caller-specified buffer. The
<code class="methodname">DbEnv::set_thread_id_string()</code> method supports the
<a class="xref" href="envset_thread_id.html" title="DbEnv::set_thread_id()">DbEnv::set_thread_id()</a>
method.
</p>
<p>
The <code class="methodname">DbEnv::set_thread_id_string()</code> method configures operations
performed using the specified <a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a>
handle, not all operations performed on the underlying database environment.
</p>
<p>
The <code class="methodname">DbEnv::set_thread_id_string()</code> method may be called at any time
during the life of the application.
</p>
<p>
The <code class="methodname">DbEnv::set_thread_id_string()</code> <span>
<span>
method either returns a non-zero error value or throws an
exception that encapsulates a non-zero error value on
failure, and returns 0 on success.
</span>
</span>
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp7639368"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp7630096"></a>thread_id_string</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>thread_id_string</strong></span> parameter is a
function which returns a buffer in which is an identifier pair
formatted for display. The function takes four arguments:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p>
<code class="literal">dbenv</code>
</p>
<p>
The <span class="bold"><strong>dbenv</strong></span> parameter is the enclosing database
environment handle, allowing application access to the application-private
fields of that object.
</p>
</li>
<li>
<p>
<code class="literal">pid</code>
</p>
<p>
The <span class="bold"><strong>pid</strong></span> argument is a process ID.
</p>
</li>
<li>
<p>
<code class="literal">tid</code>
</p>
<p>
The <span class="bold"><strong>tid</strong></span> argument is a thread ID.
</p>
</li>
<li>
<p>
<code class="literal">buf</code>
</p>
<p>
The <span class="bold"><strong>buf</strong></span> argument is character array of at least
DB_THREADID_STRLEN bytes in length, into which the identifier pair should be
formatted.
</p>
</li>
</ul>
</div>
<p>
If no <span class="bold"><strong>thread_id_string</strong></span> function is specified, the default
routine displays the identifier pair as "pid/tid", that is, the process ID represented as
an unsigned integer value, a slash ('/') character, then the thread ID represented as an
unsigned integer value.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp7654544"></a>Errors</h3>
</div>
</div>
</div>
<p>
The <code class="methodname">DbEnv::set_thread_id_string()</code> <span>
<span>
method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a>
exception, encapsulating one of the following non-zero errors, or return one
of the following non-zero errors:
</span>
</span>
</p>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp7656160"></a>EINVAL</h4>
</div>
</div>
</div>
<p>
An invalid flag value or parameter was specified.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp7664592"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp7660736"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="env.html#envlist" title="Database Environments and Related Methods">Database Environments and Related Methods</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="envset_thread_id.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="env.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="envset_timeout.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DbEnv::set_thread_id() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DbEnv::set_timeout()</td>
</tr>
</table>
</div>
</body>
</html>
|
