Metadata-Version: 2.1
Name: cy-rwlock
Version: 1.3
Summary: UNKNOWN
Home-page: https://github.com/cy-arduino/cy_rwlock
Author: ChihYing_Lin
Author-email: 
License: LGPL
Description: # RwLock: Reader-Writer lock
        
        ## Release Note
        1. V1.2: 
            1. fix version convert issue in setup.py
        1. V1.1: 
            1. Reduce test time
            1. Refactoring
        1. V1.0: first release
        
        ## Introduction
        We can simply protect a shared resource by a lock. But the performance is not
        good because each reader should run one-by-one.
        
        A Reader-Writer lock can improve the performance by let readers running 
        simultaneously.
        
        By the way, a writer should wait until all readers done.
        In a frequently read situation, a new reader after the writer can also increase
        the read count, let read count never decrease to 0. 
        This will starve writer.
        
        RwLock:
        1. Let readers running simultaneously.
        1. Exclude "multiple readers" and each writer.
        1. provide a flag "write_first" to prevent starve writer.
        
        ## Install
        1. `pip install cy_rwlock`
        1. download latest from https://pypi.org/project/cy_rwlock/#files
        
        
        ## Unittest
        * run `scripts\run.bat`
        
        
        ## Deploy
        - run `scripts\deploy.bat`
        
        
        ## TODO
        * autogen pypi project description
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
