Add warning about the perils of buffering without bounds

pull/1647/head
Jorge Canizales 10 years ago
parent 421f6c9488
commit 63e4091dbc
  1. 6
      src/objective-c/RxLibrary/GRXBufferedPipe.h

@ -45,6 +45,12 @@
// GRXWriterStateStarted.
// If it receives an error (via -didFinishWithError:), it will drop any buffered values and
// propagate the error immediately.
//
// Beware that a pipe of this type can't prevent receiving more values when it is paused (for
// example if used to write data to a congested network connection). Because in such situations the
// 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.
@interface GRXBufferedPipe : NSObject<GRXWriteable, GRXWriter>
// Convenience constructor.

Loading…
Cancel
Save