diff options
author | Jorge Canizales <jcanizales@google.com> | 2015-08-07 23:10:49 -0700 |
---|---|---|
committer | Jorge Canizales <jcanizales@google.com> | 2015-08-07 23:10:49 -0700 |
commit | 67ce098ccf6c7d5b64a85523af1c96e04e46312a (patch) | |
tree | 04353738b62fd4ff349b2f624b245566c3f7b9ae /src/objective-c/RxLibrary/GRXBufferedPipe.h | |
parent | c678c30cf19d47961f04e5782b7890d3b289b7f0 (diff) |
Clarify thread-safety expectations of GRXWriters
Diffstat (limited to 'src/objective-c/RxLibrary/GRXBufferedPipe.h')
-rw-r--r-- | src/objective-c/RxLibrary/GRXBufferedPipe.h | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/src/objective-c/RxLibrary/GRXBufferedPipe.h b/src/objective-c/RxLibrary/GRXBufferedPipe.h index b6296e1ed7..ca94ce275f 100644 --- a/src/objective-c/RxLibrary/GRXBufferedPipe.h +++ b/src/objective-c/RxLibrary/GRXBufferedPipe.h @@ -36,13 +36,11 @@ #import "GRXWriteable.h" #import "GRXWriter.h" -// A buffered pipe is a Writeable that also acts as a Writer (to whichever other writeable is passed -// to -startWithWriteable:). +// A buffered pipe is a Writer that also acts as a Writeable. // Once it is started, whatever values are written into it (via -writeValue:) will be propagated // immediately, unless flow control prevents it. // If it is throttled and keeps receiving values, as well as if it receives values before being -// started, it will buffer them and propagate them in order as soon as its state becomes -// GRXWriterStateStarted. +// started, it will buffer them and propagate them in order as soon as its state becomes Started. // If it receives an error (via -writesFinishedWithError:), it will drop any buffered values and // propagate the error immediately. // @@ -51,6 +49,9 @@ // pipe will keep buffering all data written to it, your application could run out of memory and // crash. If you want to react to flow control signals to prevent that, instead of using this class // you can implement an object that conforms to GRXWriter. +// +// Thread-safety: +// The methods of an object of this class should not be called concurrently from different threads. @interface GRXBufferedPipe : GRXWriter<GRXWriteable> // Convenience constructor. |