Mercurial > vim

comparison runtime/doc/channel.txt @ 8246:f16bfe02cef1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907 Author: Bram Moolenaar <Bram@vim.org> Date: Thu Feb 25 00:00:01 2016 +0100 Updated runtime files.
author Christian Brabandt <cb@256bit.org>
date Thu, 25 Feb 2016 00:15:06 +0100
parents e77efd7a7dad
children 108d30ed34ba
comparison
equal deleted inserted replaced
8245:f8e9e537340c 8246:f16bfe02cef1
1 *channel.txt* For Vim version 7.4. Last change: 2016 Feb 21 1 *channel.txt* For Vim version 7.4. Last change: 2016 Feb 23
2 2
3 3
4 VIM REFERENCE MANUAL by Bram Moolenaar 4 VIM REFERENCE MANUAL by Bram Moolenaar
5 5
6 6
158 "close-cb" A function that is called when the channel gets closed, other 158 "close-cb" A function that is called when the channel gets closed, other
159 than by calling ch_close(). It should be defined like this: > 159 than by calling ch_close(). It should be defined like this: >
160 func MyCloseHandler(channel) 160 func MyCloseHandler(channel)
161 < *waittime* 161 < *waittime*
162 "waittime" The time to wait for the connection to be made in 162 "waittime" The time to wait for the connection to be made in
163 milliseconds. The default is zero, don't wait, which is 163 milliseconds. A negative number waits forever.
164 useful if the server is supposed to be running already. A 164
165 negative number waits forever. 165 The default is zero, don't wait, which is useful if a local
166 server is supposed to be running already. On Unix Vim
167 actually uses a 1 msec timeout, that is required on many
168 systems. Use a larger value for a remote server, e.g. 10
169 msec at least.
166 170
167 "timeout" The time to wait for a request when blocking, E.g. when using 171 "timeout" The time to wait for a request when blocking, E.g. when using
168 ch_sendexpr(). In milliseconds. The default is 2000 (2 172 ch_sendexpr(). In milliseconds. The default is 2000 (2
169 seconds). 173 seconds).
170 *out-timeout* *err-timeout* 174 *out-timeout* *err-timeout*
251 255
252 Then channel handler will then get {response} converted to Vim types. If the 256 Then channel handler will then get {response} converted to Vim types. If the
253 channel does not have a handler the message is dropped. 257 channel does not have a handler the message is dropped.
254 258
255 On read error or ch_close(), when using a socket, the string "DETACH" is sent, 259 On read error or ch_close(), when using a socket, the string "DETACH" is sent,
256 if still possible. The channel will then be inactive. 260 if still possible. The channel will then be inactive. For a JSON and JS mode
261 channel quotes are used around DETACH, otherwise there are no quotes.
257 262
258 It is also possible to use ch_sendraw() on a JSON or JS channel. The caller 263 It is also possible to use ch_sendraw() on a JSON or JS channel. The caller
259 is then completely responsible for correct encoding and decoding. 264 is then completely responsible for correct encoding and decoding.
260 265
261 ============================================================================== 266 ==============================================================================