aboutsummaryrefslogtreecommitdiff
path: root/java/README.txt
diff options
context:
space:
mode:
authorDave Hawkey <dhawkey@google.com>2014-03-20 10:55:41 -0600
committerDave Hawkey <dhawkey@google.com>2014-04-10 08:21:44 -0600
commit598087ef53c22ae3fd22f87d20d00bea2c16e949 (patch)
tree1501b441be329d4d550cf2601f1a8c65537d3b43 /java/README.txt
parentdc2ab875690f8061ba1a712872133120792e4746 (diff)
downloadprotobuf-598087ef53c22ae3fd22f87d20d00bea2c16e949.tar.gz
protobuf-598087ef53c22ae3fd22f87d20d00bea2c16e949.tar.bz2
protobuf-598087ef53c22ae3fd22f87d20d00bea2c16e949.zip
Don't reset cachedSize to 0 in getSerializedSize
This avoids a race-condition when cachedSize is momentarily set to 0 for non-empty messages if multiple threads call getSerializedSize (e.g. during serialization). This is a retry of https://android-review.googlesource.com/#/c/88570/. getSerializedSize() has been kept non-final so that messages generated with a previous version of the compiler will not break. Change-Id: I8d8154a10938cde579ae19c55eae55b1e70e0bda
Diffstat (limited to 'java/README.txt')
-rw-r--r--java/README.txt9
1 files changed, 9 insertions, 0 deletions
diff --git a/java/README.txt b/java/README.txt
index 13865f6d..f958d147 100644
--- a/java/README.txt
+++ b/java/README.txt
@@ -437,6 +437,15 @@ and the runtime overhead. An overview of Nano features:
MessageNano.
- The 'bytes' type translates to the Java type byte[].
+The generated messages are not thread-safe for writes, but may be
+used simultaneously from multiple threads in a read-only manner.
+In other words, an appropriate synchronization mechanism (such as
+a ReadWriteLock) must be used to ensure that a message, its
+ancestors, and descendants are not accessed by any other threads
+while the message is being modified. Field reads, getter methods,
+toByteArray(...), writeTo(...), getCachedSize(), and
+getSerializedSize() are all considered read-only operations.
+
IMPORTANT: If you have fields with defaults and opt out of accessors
How fields with defaults are serialized has changed. Because we don't