瀏覽代碼

add persistent backlog readme

Daniel Gruno 5 年之前
父節點
當前提交
797685d4b9
共有 1 個文件被更改,包括 9 次插入0 次删除
  1. 9 0
      README.md

+ 9 - 0
README.md

@@ -18,6 +18,7 @@
   * [Retrieving private events](#retrieving-private-events)
   * [Retrieving private events](#retrieving-private-events)
   * [LDAP-based ACL](#ldap-based-acl)
   * [LDAP-based ACL](#ldap-based-acl)
 - [Working with Amazon SQS](#working-with-amazon-sqs)
 - [Working with Amazon SQS](#working-with-amazon-sqs)
+- [Persistent backlogs](#persistent-backlogs)
 - [License](#license)
 - [License](#license)
 
 
 <!-- tocstop -->
 <!-- tocstop -->
@@ -211,5 +212,13 @@ For more information on how to configure SQS, please see `pypubsub.yaml`.
 SQS support assumes that the AWS CLI has been set up, and the user has AWS configured 
 SQS support assumes that the AWS CLI has been set up, and the user has AWS configured 
 in their .aws directory before startup.
 in their .aws directory before startup.
 
 
+
+## Persistent backlogs
+PyPubSub supports using a filesystem-based backlog file for persistent storage of the 
+backlog through restarts. To enable this feature, uncomment the backlog configuration 
+in the pypubsub.yaml config file. This will store up to whatever the max backlog 
+queue size is every 10 seconds assuming the backlog has changed. On restart, the 
+backlog file will be read in and added to the in-memory backlog.
+
 ## License
 ## License
 PyPubSub is licensed under the Apache License v/2.
 PyPubSub is licensed under the Apache License v/2.