File: RELEASE-NOTES-v340.html

package info (click to toggle)
libassa 3.5.1-2
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 3,268 kB
  • sloc: cpp: 15,703; sh: 12,083; makefile: 379; perl: 51
file content (318 lines) | stat: -rw-r--r-- 9,953 bytes parent folder | download | duplicates (9)
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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
  <HEAD>
	<STYLE TYPE="text/css">
	  <!--
	  .darkrow, .darkrow TD, .darkrow TH
	  {
	  background-color:#F5F5DC;
	  color:black;
	  }
	  -->
	</STYLE>

    <TITLE>RELEASE NOTES v3.4.0</TITLE>
    <!-- Changed by: , 28-Jun-2001 -->
	<!-- Changed by: Vladislav Grinchenko, 02-Jun-2004 -->
  </HEAD>

  <BODY BGCOLOR="WHITE">
    <CENTER><H1>Release Notes for v3.4.0</H1></CENTER>

	<hr></hr>
	<!-- --------------------------------------------- -->
	<p>
	  Changes introduced in 3.4.2 were mostly to get networking
	  code working in mingw environment. The naming collition 
	  of ASSA::ERROR logging mask was resolved by renaming it to 
	  ASSA::ASSAERR.
	</p>

	<p>
	  <table border="1" frame="border" cellpadding="3" cellspacing="1">
		<caption>Logging Mask name change</caption>
		<tr bgcolor="#E9967A">
		  <th>3.4.1</th>
		  <th>3.4.2</th>
		</tr>
		<tr>
		  <td>ASSA::ERROR</td> 
		  <td>ASSA::ASSAERR</td>
		</tr>
	  </table>
	</p>

	<p>It was discovered by trial-and-error 
	  that you cannot set Socket into <b>blocking</b> mode. 
	  Instead, a Socket can either have O_NONBLOCK flag set or cleared.
	  Therefore, <b>Socket::blocking</b> option was removed.
	  Use <tt>Socket::turnOptionOn (nonblocking)</tt> and
	  <tt>Socket::turnOptionOff (nonblocking)</tt> respectively
	  to manipulate the flag.
	</p>
	

	<hr></hr>
	<!-- --------------------------------------------- -->
	<p>
	  Changes introduced in 3.4.2 were mostly to get networking
	  code working in mingw environment. The naming collition 
	  of ASSA::ERROR logging mask was resolved by renaming it to 
	  ASSA::ASSAERR.
	</p>

	<p>
	  <table border="1" frame="border" cellpadding="3" cellspacing="1">
		<caption>Logging Mask name change</caption>
		<tr bgcolor="#E9967A">
		  <th>3.4.1</th>
		  <th>3.4.2</th>
		</tr>
		<tr>
		  <td>ASSA::ERROR</td> 
		  <td>ASSA::ASSAERR</td>
		</tr>
	  </table>
	</p>

	<p>It was discovered by trial-and-error 
	  that you cannot set Socket into <b>blocking</b> mode. 
	  Instead, a Socket can either have O_NONBLOCK flag set or cleared.
	  Therefore, <b>Socket::blocking</b> option was removed.
	  Use <tt>Socket::turnOptionOn (nonblocking)</tt> and
	  <tt>Socket::turnOptionOff (nonblocking)</tt> respectively
	  to manipulate the flag.
	</p>
	

	<hr></hr>
	<!-- --------------------------------------------- -->
	<p>
	  The interface changes intruduced in version 3.4.0 break backward
	  compatability with the previous versions of the library. This is
	  mostly due to the *feature* of cygwin development tools that fail
	  to differentiate between <tt>Assert.h</tt> in your build directory and
	  system-wide <tt>/usr/include/assert.h</tt> file. 
	</p>

	<p>The file <tt>assa/Assert.h</tt>, therefore, has been renamed 
	  to <tt>assa/Assure.h</tt>.
	</p>

	<p></p>
	<table summary="List of defines changed in Assure class"
	  border="1" frame="border" cellpadding="3" cellspacing="1">
	  <caption>Defines changed</caption>
	  <tr bgcolor="#E9967A">
		<th>3.3.x</th>
		<th>3.4.x</th>
	  </tr>
	  <tr>
		<td>Assert_exit(exp_)</td> 
		<td>Assure_exit(exp_)</td>
	  </tr>	
	  <tr class="darkrow">
		<td>Assert_return(exp_)</td> 
		<td>Assure_return(exp_)</td>
	  </tr>	
	  <tr>
		<td>Assert_return_void(exp_)</td> 
		<td>Assure_return_void(exp_)</td>
	  </tr>	
	  <tr class="darkrow">
		<td>Assert_return_value(exp_, value_)</td> 
		<td>Assure_return_value(exp_, value_)</td>
	  </tr>	
	</table>


	<hr></hr>
	<!-- --------------------------------------------- -->
	<p>
	  Also, a whole lot of function and data member names has been
	  *normalized* in two classes, <tt>GenServer</tt> and <tt>Singleton</tt>
	  in order to improve code readability and consistency. The complete
	  list of changes is listed in the tables below.
	</p>

	<hr></hr>
	<!-- --------------------------------------------- -->
	<p></p>
	<table summary="List of member functions changed in Singleton class"
	  border="1" frame="border" cellpadding="3" cellspacing="1">
	  <caption>Function names changed in Singleton class</caption>
	  <tr bgcolor="#E9967A">
		<th>3.3.x</th>
		<th>3.4.x</th>
	  </tr>
	  <tr>
		<td>getInstance()</td> 
		<td>get_instance()</td>
	  </tr>
	</table>
	<p></p>
	<hr></hr>
	<p></p>
	<table summary="List of functions changed in GenServer class"
	  border="1" frame="border" cellpadding="3" cellspacing="1">
	  <caption>Function names changed in GenServer class</caption>
	  <tr bgcolor="#E9967A">
		<th>3.3.x</th>
		<th>3.4.x</th>
	  </tr>
	  <tr><td>getReactor()</td>                        <td>get_reactor()</td></tr>
	  <tr class="darkrow"><td>initServer()</td>        <td>init_service()</td></tr>
	  <tr><td>processServer()</td>                     <td>process_events()</td></tr>
	  <tr class="darkrow"><td>fatalSignalHook()</td>   <td>fatal_signal_hook()</td></tr>
	  <tr><td>stopServer()</td>                        <td>service_is_active()</td></tr>
	  <tr class="darkrow"><td>setStopServerFlag()</td> <td>stop_service()</td></tr>
	  <tr><td>displayHelp()</td>                       <td>display_help()</td></tr>
	  <tr class="darkrow"><td>getProcName()</td>       <td>get_proc_name()</td></tr>
	  <tr><td>setProcName()</td>                       <td>set_proc_name()</td></tr>
	  <tr class="darkrow"><td>getCmdLineName()</td>    <td>get_cmdline_name()</td></tr>
	  <tr><td>getStdConfigName()</td>                  <td>get_default_config_file()</td></tr>
	  <tr class="darkrow"><td>getAltConfigName()</td>  <td>get_config_file()</td></tr>
	  <tr><td>getPortName()</td>                       <td>get_port()</td></tr>
	  <tr class="darkrow"><td>setPortName()</td>       <td>set_port()</td></tr>
	  <tr><td>becomeDaemon()</td>                      <td>become_daemon()</td></tr>
	  <tr class="darkrow"><td>initInternals()</td>     <td>init_internals()</td></tr>
	  <tr><td>&nbsp;</td>                              <td>get_version()</td></tr>
	  </tr>
	</table>

	<hr></hr>
	<!-- --------------------------------------------- -->
	<p>
	  In case of <tt>stopServer()</tt> member function, the event processing
	  loop typical for ver. 3.3.x or prior should be modified in the
	  following fashion:
	</p>

	<pre>
// ver. 3.3.x and prior

    while (!stopServer()) {
        m_reactor.waitForEvents ();
    }

// ver. 3.4.x

    while (service_is_active ()) {
        m_reactor.waitForEvents ();
    }
	</pre>

	<hr></hr>
	<!-- --------------------------------------------- -->
	<p>
	  To accommodate a certain way of initializing applications written
	  with <tt>libassa</tt>, the way <tt>BOOL</tt> command-line arguments
	  are parsed and interpreted was changed. In the previous versions,
	  a whole group of options was used as flags. For example,
	  <tt>--daemon</tt> option was used to tell <tt>libassa</tt> to deamonize 
	  the process. This has been changed to <tt>--daemon=BOOL</tt> format
	  where <font color="brown">BOOL</font> is either "<tt>yes</tt>" or
	  "<tt>no</tt>" (any other combinations are invalid and would result
	  in the value being interpreted as "<tt>no</tt>").
	</p>
	<p>
	  <tt>libassa</tt> still supports flag options (i.e. <tt>--help</tt>),
	  but they should be rather an exception then a commonplace practice.
	</p>
	<p>
	  This change is driven by the desire to give an application writer
	  the fullest level of initialization control. The order of initialization
	  is as follows:
	  <ol>
		<li>
		  The command-line arguments are assigned values in the 
		  constructor of the class derived from <tt>GenServer</tt> class.
		</li>
		<li>
		  The arguments are later can be overwritten by the INI configuration
		  file using a new function, 
		  <font color="brown">CmdLineOpts::parse_config_file(IniFile&)</font>
		  introduced by this release.
		</li>
		<li>
		  At last, the arguments can be changed by the values given
		  on a command-line.
		</li>
	  </ol>
	</p>
	<p>
	  <b>NOTE:</b> This change has sudden sude-effect. If you forget to
	  adjust the way you pass your old *flag* command-line argument to your 
	  program, the value assigned to it would be "<tt>no</tt>" by default!
	  So, say what you mean with "<tt>yes</tt>"!
	</p>
	<hr></hr>		
	<!-- --------------------------------------------- -->
	<hr></hr>		
	<!-- --------------------------------------------- -->
	<p></p>
	<table summary="List of data members changed in GenServer class"
	  border="1" frame="border" cellpadding="3" cellspacing="1">
	  <caption>Data member names changed in GenServer class</caption>
	  <tr bgcolor="#E9967A">
		<th>3.3.x</th>
		<th>3.4.x</th>
	  </tr>
	  <tr>
		<td>m_debug_mask</td> 
		<td>m_mask</td>
	  </tr>
	  <tr class="darkrow">
		<td>m_alt_config_name</td> 
		<td>m_config_file</td>
	  </tr>
	  <tr>
		<td>m_std_config_name</td> 
		<td>m_default_config_file</td>
	  </tr>
	  <tr class="darkrow">
		<td><b>bool</b> m_with_log_server</td> 
		<td><b>string</b> m_with_log_server</td>
	  </tr>
	  <tr>
		<td><b>bool</b> m_log_stdout_flag</td> 
		<td><b>string</b> m_log_stdout</td>
	  </tr>
	  <tr class="darkrow">
		<td><b>bool</b> m_daemon_flag</td> 
		<td><b>string</b> m_daemon</td>
	  </tr>
	  <tr>
		<td><b>bool</b> m_ommit_pidflock_flag</td> 
		<td><b>string</b> m_ommit_pidfile</td>
	  </tr>
	</table>
	<hr></hr>

	<!-- --------------------------------------------- -->
	<p>
	  If you use automake tools, modify your <tt>configure.in</tt>
	  (or <tt>configure.ac</tt>) accordingly:
	</p>
	<pre>
dnl -----------------------------
dnl Pick up ASSA library flags.
dnl -----------------------------

PKG_CHECK_MODULES(ASSA, assa-3.4 >= 3.4.0)

AC_SUBST(ASSA_CFLAGS)
AC_SUBST(ASSA_LIBS)
	</pre>
	<!-- --------------------------------------------- -->
	<p></p>
    <HR></HR>
    <address>
      <a href="mailto:vlg@users.sourceforge.net">Vladislav Grinchenko</a></address>
    <!-- Created: Wed Jan 26 09:24:51 EST 2000 -->
    <!-- hhmts start -->
Last modified: Tue Jul 25 12:13:53 EDT 2006
<!-- hhmts end -->

  </BODY>
</HTML>