aboutsummaryrefslogtreecommitdiffstats
path: root/lib/jinterface/doc/src/notes.xml
blob: 1590a0fdff7b7fdcc0a644a72bbd95bce1aa873e (plain) (blame)
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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE chapter SYSTEM "chapter.dtd">

<chapter>
  <header>
    <copyright>
      <year>2000</year><year>2013</year>
      <holder>Ericsson AB. All Rights Reserved.</holder>
    </copyright>
    <legalnotice>
      Licensed under the Apache License, Version 2.0 (the "License");
      you may not use this file except in compliance with the License.
      You may obtain a copy of the License at
 
          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.

    </legalnotice>

    <title>Jinterface Release Notes</title>
    <prepared>otp_appnotes</prepared>
    <docno>nil</docno>
    <date>nil</date>
    <rev>nil</rev>
    <file>notes.xml</file>
  </header>
  <p>This document describes the changes made to the Jinterface application.</p>

<section><title>Jinterface 1.5.12</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
	    handle empty .erlang.cookie without crashing and
	    OtpErlangList.clone must not return null</p>
          <p>
	    Own Id: OTP-12210</p>
        </item>
        <item>
          <p>
	    This fixes all the compilation warnings in the Java code</p>
          <p>
	    Own Id: OTP-12211</p>
        </item>
      </list>
    </section>


    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    Added an .appup file for the application.</p>
          <p>
	    Own Id: OTP-12358 Aux Id: OTP-12178 </p>
        </item>
      </list>
    </section>

</section>

<section><title>Jinterface 1.5.11</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
	    Added a <c>.app</c> file for the application.</p>
          <p>
	    Own Id: OTP-12178</p>
        </item>
      </list>
    </section>

</section>

<section><title>Jinterface 1.5.10</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
	    Array now show meaningful values in exceptions.</p>
          <p>
	    Own Id: OTP-12049</p>
        </item>
        <item>
          <p>
	    Documentation improvements.</p>
          <p>
	    Own Id: OTP-12050</p>
        </item>
        <item>
          <p>
	    Include the cause when raising a new IOException, which
	    should make the reason for the exception clearer.</p>
          <p>
	    Own Id: OTP-12075</p>
        </item>
        <item>
          <p>
	    Arrays (here: md5 and freeVars) must not be compared with
	    equals, which is broken (compares identity).</p>
          <p>
	    Own Id: OTP-12121</p>
        </item>
      </list>
    </section>

</section>

<section><title>Jinterface 1.5.9</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    Implement support for Maps</p>
          <p>
	    The API and implementation are simplistic, like for lists
	    and tuples, using arrays and without any connection to
	    java.util.Map. (Thanks to Vlad Dumitrescu)</p>
          <p>
	    Own Id: OTP-11703</p>
        </item>
      </list>
    </section>

</section>

<section><title>Jinterface 1.5.8</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
	    Fixed a bug in OtpErlangTuple constructor. Thanks to Vlad
	    Dumitrescu.</p>
          <p>
	    Own Id: OTP-10819</p>
        </item>
        <item>
          <p>
	    Fixed finding cookie file on windows. Thanks to Vlad
	    Dumitrescu</p>
          <p>
	    Own Id: OTP-10821</p>
        </item>
      </list>
    </section>


    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    Don't compress external binary format if this increases
	    the size. Thanks to Nico Kruber.</p>
          <p>
	    Own Id: OTP-10822</p>
        </item>
      </list>
    </section>

</section>

<section><title>Jinterface 1.5.7</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
	    fix reading compressed binary terms from Java (Thanks to
	    Nico Kruber)</p>
          <p>
	    Own Id: OTP-10505</p>
        </item>
        <item>
          <p>
	    OtpEpmd.lokupNames() no longer hangs when badly
	    configured (Thanks to Vlad Dumitrescu)</p>
          <p>
	    Own Id: OTP-10579</p>
        </item>
      </list>
    </section>


    <section><title>Improvements and New Features</title>
      <list>
        <item>
	    <p>Where necessary a comment stating encoding has been
	    added to Erlang files. The comment is meant to be removed
	    in Erlang/OTP R17B when UTF-8 becomes the default
	    encoding. </p>
          <p>
	    Own Id: OTP-10630</p>
        </item>
        <item>
          <p>
	    Limited support for unicode atoms in the external format
	    and in the internal representation of the vm. This is a
	    preparative feature in order to support communication
	    with future releases of Erlang/OTP that may create
	    unicode atoms.</p>
          <p>
	    Own Id: OTP-10753</p>
        </item>
      </list>
    </section>

</section>

<section><title>Jinterface 1.5.6</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
	    Correct spelling of registered (Thanks to Richard
	    Carlsson)</p>
          <p>
	    Own Id: OTP-9925</p>
        </item>
        <item>
          <p>
	    Java 1.5 has a bug where detecting codepoint offsets in
	    strings that are created by String.substring() gives
	    wrong results. The new implementation uses a different
	    method, avoinding the issue. (Thanks to Vlad Dumitrescu)</p>
          <p>
	    Own Id: OTP-9927</p>
        </item>
        <item>
          <p>
	    Improve error message when creating a too long
	    OtpErlangAtom. Also print the value that we tried to use
	    for the atom. (Thanks to Vlad Dumitrescu)</p>
          <p>
	    Own Id: OTP-9928</p>
        </item>
      </list>
    </section>

</section>

<section><title>Jinterface 1.5.5</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
	    JInterface: improve OtpOutputStream buffer allocation</p>
          <p>
	    Previously, the buffer was increased linearly by 2048
	    bytes. I now propose to use an exponential increase
	    function (similar to Javas ArrayList, e.g. always at
	    least +50%). This significantly increases performance of
	    e.g. doRPC for large parameters. (Thanks to Nico Kruber)</p>
          <p>
	    Own Id: OTP-9806</p>
        </item>
      </list>
    </section>

</section>

<section><title>Jinterface 1.5.4</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
	    Some malformed distribution messages could cause VM to
	    crash, this is now corrected.</p>
          <p>
	    Own Id: OTP-8993</p>
        </item>
      </list>
    </section>

</section>

<section><title>Jinterface 1.5.3.2</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    The OtpMbox class did not have a hash() method, which it
	    should have because it overrides equals().</p>
          <p>
	    Own Id: OTP-8854</p>
        </item>
      </list>
    </section>

</section>

<section><title>Jinterface 1.5.3.1</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    An pom.xml file is now generated. (Thanks to Gabor
	    Liptak.)</p>
          <p>
	    Own Id: OTP-8841</p>
        </item>
      </list>
    </section>

</section>

<section><title>Jinterface 1.5.3</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
	    <p>The documentation is now possible to build in an open
	    source environment after a number of bugs are fixed and
	    some features are added in the documentation build
	    process. </p>
	    <p>- The arity calculation is updated.</p>
	    <p>- The module prefix used in the function names for
	    bif's are removed in the generated links so the links
	    will look like
	    "http://www.erlang.org/doc/man/erlang.html#append_element-2"
	    instead of
	    "http://www.erlang.org/doc/man/erlang.html#erlang:append_element-2".</p>
	    <p>- Enhanced the menu positioning in the html
	    documentation when a new page is loaded.</p>
	    <p>- A number of corrections in the generation of man
	    pages (thanks to Sergei Golovan)</p>
	    <p>- The legal notice is taken from the xml book file so
	    OTP's build process can be used for non OTP
	    applications.</p>
          <p>
	    Own Id: OTP-8343</p>
        </item>
      </list>
    </section>

</section>

<section><title>Jinterface 1.5.2</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    The documentation is now built with open source tools
	    (xsltproc and fop) that exists on most platforms. One
	    visible change is that the frames are removed.</p>
          <p>
	    Own Id: OTP-8201</p>
        </item>
      </list>
    </section>

</section>

<section><title>Jinterface 1.5.1</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
	    Many Erlang classes, e.g. OtpErlangRef, was missing an
	    implementation of the hashCode() method, making it futile
	    to put them in hash structures such as HashMap. Bug and
	    patch provided by Paul Guyot. We extended the patch to
	    all classes and improved (?) on the hash algorithm.</p>
          <p>
	    Own Id: OTP-7899</p>
        </item>
      </list>
    </section>


    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    jinterface uses the new environment variable
	    ERL_EPMD_PORT the same way that erl, epmd and
	    erl_interface do since R13A.</p>
          <p>
	    Own Id: OTP-7885</p>
        </item>
      </list>
    </section>

</section>

<section><title>Jinterface 1.5</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
          <p>
	    A number of fixes and improvements from the ErlIDE group;
	    Vlad Dumitrescu and Jakob Cederlund: JDK 1.5 is now a
	    minimal requirement for building Jinterface. New method:
	    OtpEpmd.lookupNames. OtpErlangList is now iterable.
	    Non-proper lists are now allowed - you have to test if a
	    list is proper or not. Non-proper lists can also be
	    created. New methods: isProper, getHead, getTail and
	    getNthTail. The get tail methods creates a sublist object
	    that re-uses the original list. OtpErlangPid is now
	    Comparable. Empty atoms can now be constructed, a missing
	    feature pointed out by Sebastien Boisgerault on
	    erlang-questions.</p>
          <p>
	    *** POTENTIAL INCOMPATIBILITY ***</p>
          <p>
	    Own Id: OTP-7832</p>
        </item>
      </list>
    </section>

</section>

<section><title>Jinterface 1.4.2</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
	    A bug when Jinterface did not detect remote node
	    disconnects has been corrected.</p>
          <p>
	    Own Id: OTP-7624</p>
        </item>
      </list>
    </section>

</section>

<section><title>Jinterface 1.4.1</title>

    <section><title>Fixed Bugs and Malfunctions</title>
      <list>
        <item>
          <p>
	    Jinterface has been fixed to use the loopback interface
	    when connecting to the Erlang Port Mapper Daemon - epmd.
	    This facilitates firewall configuration and saves
	    resources.</p>
          <p>
	    Own Id: OTP-7103</p>
        </item>
        <item>
	    <p>Jinterface now refuses to connect to another node that
	    does not agree on the other node's name. This has been a
	    problem in that a connection was set up, but not used on
	    a following send, which caused a second erroneous
	    connection attempt to fail since the other (Erlang) node
	    rejects a connection due to name disagreement.</p>
	    <p>Problem reported and dissected by Alexander Lamb</p>
          <p>
	    Own Id: OTP-7330</p>
        </item>
      </list>
    </section>

</section>

<section><title>Jinterface 1.4</title>

    <section><title>Improvements and New Features</title>
      <list>
        <item>
	    <p>Jinterface has been updated to handle compressed
	    terms, bitstring, new (IEEE) floats and bignums. This has
	    caused a few incompatibilities.</p>
	    <p>com.ericsson.otp.erlang.OtpOutputStream now extends
	    java.io.ByteArrayOutputStream, previously
	    java.lang.Object, and hence the method size() now return
	    the number of bytes in the stream as dictated by the new
	    parent class and not the buffer length as before. The new
	    method length() returns what the old size() did return.
	    The method count() is deprecated as it returns the same
	    as the new size().</p>
	    <p>com.ericsson.otp.erlang.OtpErlangLong now can handle
	    larger values than 64-bit. Previously when larger than
	    64-bit integers were sent to a Jinterface node, it caused
	    an com.ericsson.otp.erlang.OtpDecodeException. Now the
	    integer is accepted, but the return value of longValue()
	    is silently truncated, as opposed to the return value of
	    intValue() that now and previously raises an
	    com.ericsson.otp.erlang.OtpRangeException for
	    unrepresentable values. The new methods isLong() and
	    isULong() can be used to determine if the value fits in a
	    long.</p>
          <p>
	    *** POTENTIAL INCOMPATIBILITY ***</p>
          <p>
	    Own Id: OTP-6809</p>
        </item>
      </list>
    </section>

</section>

  <section>
    <title>Jinterface 1.3</title>

    <section>
      <title>Fixed Bugs and Malfunctions</title>
      <list type="bulleted">
        <item>
          <p><c>OtpMbox.receive()</c> and <c>OtpMbox.receive(long timeout)</c> can now throw
            <c>OtpErlangDecodeException</c> if the received message
            can not be decoded. <c>null</c> is now only returned from
            <c>OtpMbox.receive(long timeout)</c> if a timeout occurs.
            <c>OtpMbox.receive()</c> will never return <c>null</c>.</p>
          <p>*** POTENTIAL INCOMPATIBILITY ***</p>
          <p>Own Id: OTP-3932 Aux Id: seq5196 </p>
        </item>
        <item>
          <p>Strings longer than 65535 bytes were encoded wrong by
            jinterface.</p>
          <p>Own Id: OTP-4883 Aux Id: OTP-4865 </p>
        </item>
        <item>
          <p>Misc bugfixes: </p>
          <list type="bulleted">
            <item>
              <p>A node pinging itself does no
                longer cause the java program to hang.</p>
              <p></p>
            </item>
            <item>
              <p><c>OtpMbox.close()</c> uses exit reason
                <c>'normal'</c> (atom) instead of <c>"normal"</c>
                (string).</p>
              <p></p>
            </item>
            <item>
              <p>Added <c>OtpNode.closeMbox(OtpMbox mbox, OtpErlangObject reason)</c>.</p>
              <p></p>
            </item>
            <item>
              <p>Added <c>OtpMbox.exit(OtpErlangObject reason)</c>
                and <c>OtpMbox.exit(String reason)</c>.</p>
              <p></p>
            </item>
            <item>
              <p>Added <c>OtpMbox.exit(OtpErlangPid to, OtpErlangObject reason)</c>.</p>
              <p></p>
            </item>
            <item>
              <p><c>OtpMbox.exit(OtpErlangPid to, String reason)</c>
                is now equivalent to <c>OtpMbox.exit(to, new OtpErlangAtom(reason))</c>.</p>
              <p></p>
            </item>
            <item>Exit signals from an Erlang node can now contain
             any erlang term as reason, not only atoms. </item>
          </list>
          <p>Own Id: OTP-5088</p>
        </item>
        <item>
          <p>For java versions 1.3.1 or later, <c>localStatus</c> was
            not sent to registered status handler when
            <c>OtpNode.close()</c> was called. This is now corrected.</p>
          <p>Own Id: OTP-5169</p>
        </item>
      </list>
    </section>

    <section>
      <title>Improvements and New Features</title>
      <list type="bulleted">
        <item>
          <p>Process identifiers and port identifiers have been
            made more unique. Previously 18 bits were used as id in
            the internal representation of process and port
            identifiers. Now 28 bits are used. </p>
          <p>The maximum
            limit on the number of concurrently existing processes
            due to the representation of pids has been increased to
            268435456 processes. The same is true for ports. This
            limit will at least on a 32-bit architecture be
            impossible to reach due to memory shortage. </p>
          <p><em>NOTE:</em> By default, the <c>ERTS</c>, and the
            <c>erl_interface</c>, <c>ei</c>, and <c>jinterface</c>
            libraries are now only guaranteed to be compatible with
            other Erlang/OTP components from the same release. It is
            possible to set each component in compatibility mode of
            an earlier release, though. See the documentation for
            respective component on how to set it in compatibility
            mode. </p>
          <p>*** POTENTIAL INCOMPATIBILITY ***</p>
          <p>Own Id: OTP-4968 Aux Id: OTP-4196 </p>
        </item>
      </list>
    </section>
  </section>

  <section>
    <title>Jinterface 1.2.1.2</title>

    <section>
      <title>Fixed Bugs and Malfunctions</title>
      <list type="bulleted">
        <item>
          <p>Output of Java long was truncated to 32 bits. IDL long
            long and unsigned long long could not be used in a struct
            for the Java backend. All unsigned integer types for the
            Java backend had broken marshalling for large values.
            These bugs has now been fixed.</p>
          <p>Own Id: OTP-4763 Aux Id: seq8024 </p>
        </item>
      </list>
    </section>
  </section>
</chapter>