Skip to content

Latest commit

 

History

History

README.md

JReactive Documentation

Complete documentation for the JReactive library.

📚 Core Documentation

Comprehensive guide to the specialized reactive types:

  • Single: Exactly one element or error
  • Maybe: Zero or one element
  • Completable: Only completion or error

Learn when to use each type and see practical examples.


🔥 Advanced Topics

Hot Observables and multicasting with Subjects:

  • PublishSubject: Multicast to current subscribers
  • BehaviorSubject: Emits last value to new subscribers
  • ReplaySubject: Replays N previous values
  • AsyncSubject: Emits only the last value on completion

Overview of all specialized reactive types including:

  • Conversion methods between types
  • Performance characteristics
  • Best practices and use cases

Important considerations when working with ConnectableObservable:

  • Threading limitations
  • Known issues
  • Workarounds and solutions

⚡ Performance & Benchmarks

Complete benchmarking setup and methodology:

  • JMH configuration
  • Benchmark categories
  • How to run benchmarks

Comparative performance results vs RxJava:

  • Creation operators
  • Transformation operators
  • Filtering and combination operators
  • Performance analysis and conclusions

Performance comparison for Single, Maybe, and Completable:

  • Creation benchmarks
  • Transformation benchmarks
  • Error handling performance

🚀 Quick Links


📖 Documentation Index

docs/
├── README.md (this file)
├── SINGLE_MAYBE_COMPLETABLE.md    # Specialized types guide
├── SUBJECTS.md                     # Subjects implementation
├── SPECIALIZED_TYPES.md            # Specialized types summary
├── CONNECTABLE_LIMITATIONS.md      # Known limitations
└── benchmarks/
    ├── BENCHMARKS.md               # Benchmark methodology
    ├── RESULTS.md                  # Benchmark results
    └── SPECIALIZED_TYPES_RESULTS.md # Specialized types results

Need help? Check the main README or open an issue.