Document query timeout configurations

This commit is contained in:
Takafumi Arakaki 2012-06-21 00:38:15 +02:00
parent 0bf69e5e7b
commit 1b7edc7aa1
3 changed files with 26 additions and 3 deletions

View file

@ -254,6 +254,8 @@ Notebook list
.. el:variable:: ein:url-or-port
.. el:variable:: ein:default-url-or-port
.. el:variable:: ein:notebook-querty-timeout-open
.. el:variable:: ein:notebook-querty-timeout-save
.. el:variable:: ein:scratch-notebook-name-template
Notebook

View file

@ -119,13 +119,19 @@ yet. So be careful when using EIN functions. They may change."
;; timeouts separately:
(defcustom ein:notebook-querty-timeout-open (* 60 1000) ; 1 min
"Query timeout for opening notebook."
"Query timeout for opening notebook.
If you cannot open large notebook because of timeout error, try
to increase this value. For global setting and more information,
see `ein:query-timeout'."
:type '(choice (integer :tag "Timeout [ms]" 5000)
(const :tag "No timeout" nil))
:group 'ein)
(defcustom ein:notebook-querty-timeout-save (* 10 1000) ; 10 sec
"Query timeout for saving notebook."
"Query timeout for saving notebook.
Similar to `ein:notebook-querty-timeout-open', but for saving
notebook. For global setting and more information, see
`ein:query-timeout'."
:type '(choice (integer :tag "Timeout [ms]" 5000)
(const :tag "No timeout" nil))
:group 'ein)

View file

@ -47,7 +47,22 @@
;;; Variables
(defcustom ein:query-timeout 1000
"Default query timeout for HTTP access in millisecond."
"Default query timeout for HTTP access in millisecond.
Setting this to `nil' means no timeout.
If you do the same operation before the timeout, old operation
will be canceled \(see also `ein:query-singleton-ajax').
.. note:: This value exists because it looks like `url-retrieve'
occasionally fails to finish \(start?) querying. To let user
notice that their operation is not finished, timeout is
important. It also prevent opening a lot of useless process
buffers. If you know how to fix the problem with `url-retrieve',
please let me know or send pull request at github!
\(Related bug report in Emacs bug tracker:
http://debbugs.gnu.org/cgi/bugreport.cgi?bug=11469)"
:type '(choice (integer :tag "Timeout [ms]" 5000)
(const :tag "No timeout" nil))
:group 'ein)