vim: runtime/doc/channel.txt comparison

comparison runtime/doc/channel.txt @ 17831:4ab97fdf7ff7 v8.1.1912

patch 8.1.1912: more functions can be used as methods Commit: https://github.com/vim/vim/commit/570497ac409ad448574bb6210cb9c6e573483759 Author: Bram Moolenaar <Bram@vim.org> Date: Thu Aug 22 22:55:13 2019 +0200 patch 8.1.1912: more functions can be used as methods Problem: More functions can be used as methods. Solution: Make channel and job functions usable as a method.

author	Bram Moolenaar <Bram@vim.org>
date	Thu, 22 Aug 2019 23:00:03 +0200
parents	2704c4e3e20a
children	8ac85adee561

comparison

equal deleted inserted replaced

-:e8805fbb60a3
+:4ab97fdf7ff7
-*channel.txt*      For Vim version 8.1.  Last change: 2019 Jul 28
+*channel.txt*      For Vim version 8.1.  Last change: 2019 Aug 22
 		  VIM REFERENCE MANUAL	  by Bram Moolenaar
 		e.g. from a timer.
 		Note that messages are dropped when the channel does not have
 		a callback.  Add a close callback to avoid that.
+		Can also be used as a |method|: >
+			GetChannel()->ch_canread()
 ch_close({handle})						*ch_close()*
 		Close {handle}.  See |channel-close|.
 		{handle} can be a Channel or a Job that has a Channel.
 		A close callback is not invoked.
+		Can also be used as a |method|: >
+			GetChannel()->ch_close()
 ch_close_in({handle})						*ch_close_in()*
 		Close the "in" part of {handle}.  See |channel-close-in|.
 		{handle} can be a Channel or a Job that has a Channel.
 		A close callback is not invoked.
+		Can also be used as a |method|: >
+			GetChannel()->ch_close_in()
 ch_evalexpr({handle}, {expr} [, {options}])			*ch_evalexpr()*
 		Send {expr} over {handle}.  The {expr} is encoded
 		according to the type of channel.  The function cannot be used
 		ch_evalexpr() waits for a response and returns the decoded
 		expression.  When there is an error or timeout it returns an
 		empty string.
+		Can also be used as a |method|: >
+			GetChannel()->ch_evalexpr(expr)
 ch_evalraw({handle}, {string} [, {options}])		*ch_evalraw()*
 		Send {string} over {handle}.
 		{handle} can be a Channel or a Job that has a Channel.
 		Note that Vim does not know when the text received on a raw
 		channel is complete, it may only return the first part and you
 		need to use |ch_readraw()| to fetch the rest.
 		See |channel-use|.
+		Can also be used as a |method|: >
+			GetChannel()->ch_evalraw(rawstring)
 ch_getbufnr({handle}, {what})				 *ch_getbufnr()*
 		Get the buffer number that {handle} is using for {what}.
 		{handle} can be a Channel or a Job that has a Channel.
 		{what} can be "err" for stderr, "out" for stdout or empty for
 		socket output.
 		Returns -1 when there is no buffer.
+		Can also be used as a |method|: >
+			GetChannel()->ch_getbufnr(what)
 ch_getjob({channel})						*ch_getjob()*
 		Get the Job associated with {channel}.
 		If there is no job calling |job_status()| on the returned Job
 		will result in "fail".
+		Can also be used as a |method|: >
+			GetChannel()->ch_getjob()
 ch_info({handle})						*ch_info()*
 		Returns a Dictionary with information about {handle}.  The
 		items are:
 		   "in_status"	  "open" or "closed"
 		   "in_mode"	  "NL", "RAW", "JSON" or "JS"
 		   "in_io"	  "null", "pipe", "file" or "buffer"
 		   "in_timeout"	  timeout in msec
+		Can also be used as a |method|: >
+			GetChannel()->ch_info()
 ch_log({msg} [, {handle}])					*ch_log()*
 		Write {msg} in the channel log file, if it was opened with
 		|ch_logfile()|.
 		When {handle} is passed the channel number is used for the
 		message.
 		{handle} can be a Channel or a Job that has a Channel.  The
 		Channel must be open for the channel number to be used.
+		Can also be used as a |method|: >
+			'did something'->ch_log()
 ch_logfile({fname} [, {mode}])					*ch_logfile()*
 		Start logging channel activity to {fname}.
 		When {fname} is an empty string: stop logging.
 		This function is not available in the |sandbox|.
 		NOTE: the channel communication is stored in the file, be
 		aware that this may contain confidential and privacy sensitive
 		information, e.g. a password you type in a terminal window.
+		Can also be used as a |method|: >
+			'logfile'->ch_logfile('w')
 ch_open({address} [, {options}])				*ch_open()*
 		Open a channel to {address}.  See |channel|.
 		Returns a Channel.  Use |ch_status()| to check for failure.
 		{address} has the form "hostname:port", e.g.,
 		"localhost:8765".
 		If {options} is given it must be a |Dictionary|.
 		See |channel-open-options|.
+		Can also be used as a |method|: >
+			GetAddress()->ch_open()
 ch_read({handle} [, {options}])					*ch_read()*
 		Read from {handle} and return the received message.
 		{handle} can be a Channel or a Job that has a Channel.
 		For a NL channel this waits for a NL to arrive, except when
 		there is nothing more to read (channel was closed).
 		See |channel-more|.
+		Can also be used as a |method|: >
+			GetChannel()->ch_read()
 ch_readblob({handle} [, {options}])			*ch_readblob()*
 		Like ch_read() but reads binary data and returns a |Blob|.
 		See |channel-more|.
+		Can also be used as a |method|: >
+			GetChannel()->ch_readblob()
 ch_readraw({handle} [, {options}])			*ch_readraw()*
 		Like ch_read() but for a JS and JSON channel does not decode
 		the message.  For a NL channel it does not block waiting for
 		the NL to arrive, but otherwise works like ch_read().
 		See |channel-more|.
+		Can also be used as a |method|: >
+			GetChannel()->ch_readraw()
 ch_sendexpr({handle}, {expr} [, {options}])			*ch_sendexpr()*
 		Send {expr} over {handle}.  The {expr} is encoded
 		according to the type of channel.  The function cannot be used
 		with a raw channel.
 		See |channel-use|.				*E912*
 		{handle} can be a Channel or a Job that has a Channel.
+		Can also be used as a |method|: >
+			GetChannel()->ch_sendexpr(expr)
 ch_sendraw({handle}, {expr} [, {options}])		*ch_sendraw()*
 		Send |String| or |Blob| {expr} over {handle}.
 		Works like |ch_sendexpr()|, but does not encode the request or
 		correct contents.  Also does not add a newline for a channel
 		in NL mode, the caller must do that.  The NL in the response
 		is removed.
 		See |channel-use|.
+		Can also be used as a |method|: >
+			GetChannel()->ch_sendraw(rawexpr)
 ch_setoptions({handle}, {options})			*ch_setoptions()*
 		Set options on {handle}:
 			"callback"	the channel callback
 			"timeout"	default read timeout in msec
 		Note that changing the mode may cause queued messages to be
 		lost.
 		These options cannot be changed:
 			"waittime"	only applies to |ch_open()|
+		Can also be used as a |method|: >
+			GetChannel()->ch_setoptions(options)
 ch_status({handle} [, {options}])				*ch_status()*
 		Return the status of {handle}:
 			"fail"		failed to open the channel
 		If {options} is given it can contain a "part" entry to specify
 		the part of the channel to return the status for: "out" or
 		"err".  For example, to get the error status: >
 			ch_status(job, {"part": "err"})
 <
+		Can also be used as a |method|: >
+			GetChannel()->ch_status()
 ==============================================================================
 9. Starting a job with a channel			*job-start* *job*
 To start a job and open a channel for stdin/stdout/stderr: >
 job_getchannel({job})					 *job_getchannel()*
 		Get the channel handle that {job} is using.
 		To check if the job has no channel: >
 			if string(job_getchannel()) == 'channel fail'
 <
+		Can also be used as a |method|: >
+			GetJob()->job_getchannel()
 job_info([{job}])					*job_info()*
 		Returns a Dictionary with information about {job}:
 		   "status"	what |job_status()| returns
 		   "channel"	what |job_getchannel()| returns
 				Values are "winpty" or "conpty".
 				See 'termwintype'.
 		Without any arguments, returns a List with all Job objects.
+		Can also be used as a |method|: >
+			GetJob()->job_info()
 job_setoptions({job}, {options})			*job_setoptions()*
 		Change options for {job}.  Supported are:
 		   "stoponexit"	|job-stoponexit|
 		   "exit_cb"	|job-exit_cb|
+		Can also be used as a |method|: >
+			GetJob()->job_setoptions(options)
 job_start({command} [, {options}])			*job_start()*
 		Start a job and return a Job object.  Unlike |system()| and
 		|:!cmd| this does not wait for the job to finish.
 	let s:myjob = job_start('my-command')
 <
 		{options} must be a Dictionary.  It can contain many optional
 		items, see |job-options|.
+		Can also be used as a |method|: >
+			BuildCommand()->job_start()
 job_status({job})					*job_status()* *E916*
 		Returns a String with the status of {job}:
 			"run"	job is running
 			"fail"	job failed to start
 		If an exit callback was set with the "exit_cb" option and the
 		job is now detected to be "dead" the callback will be invoked.
 		For more information see |job_info()|.
+		Can also be used as a |method|: >
+			GetJob()->job_status()
 job_stop({job} [, {how}])					*job_stop()*
 		Stop the {job}.  This can also be used to signal the job.
 		sent.  This is to avoid to stop the wrong job (esp. on Unix,
 		where process numbers are recycled).
 		When using "kill" Vim will assume the job will die and close
 		the channel.
+		Can also be used as a |method|: >
+			GetJob()->job_stop()
 ==============================================================================
 12. Job options						*job-options*

Mercurial > vim

comparison runtime/doc/channel.txt @ 17831:4ab97fdf7ff7 v8.1.1912