ScreenWatch
The handle watch_screen passes to its block. It holds the entry screen, the polling interval and the total deadline. It is valid only inside the block. Every wait on it counts against the entry read taken when the block opened, so a second wait for the same text returns at once.
Source and package
- Qualified name
-
LibTmux .Screen Watch - Module
- LibTmux
- Package
- LibTmux
- Source
- src/screen_wait.jl
- Lib
Tmux .ScreenWatch( server::LibTmux , pane::Lib.Server Tmux , interval::Float64, timeout::Float64, started::UInt64, cancel, entry::String, entry.Pane Ref _alternate ::Bool, entry_state ::Symbol, open::Bool, timer::Union{Nothing, Timer}, )LibTmux .ScreenWatch( server, pane, interval, timeout, started, cancel, entry, entry_alternate , entry_state , open, timer, ) -
Description#
ScreenWatchMethods#
Lib
Tmux .ScreenWatch( server::LibTmux , pane::Lib.Server Tmux , interval::Float64, timeout::Float64, started::UInt64, cancel, entry::String, entry.Pane Ref _alternate ::Bool, entry_state ::Symbol, open::Bool, timer::Union{Nothing, Timer}, )[source]#Lib
Tmux .ScreenWatch( server, pane, interval, timeout, started, cancel, entry, entry_alternate , entry_state , open, timer, )[source]#- Parameters
-
-
server(LibTmux ) # for.Server ScreenWatch(server, pane, interval, timeout, started, cancel, entry, entry_alternate, entry_state, open, timer) [overload 1] -
pane(LibTmux ) # for.Pane Ref ScreenWatch(server, pane, interval, timeout, started, cancel, entry, entry_alternate, entry_state, open, timer) [overload 1] -
interval(Float64) # forScreenWatch(server, pane, interval, timeout, started, cancel, entry, entry_alternate, entry_state, open, timer) [overload 1] -
timeout(Float64) # forScreenWatch(server, pane, interval, timeout, started, cancel, entry, entry_alternate, entry_state, open, timer) [overload 1] -
started(UInt64) # forScreenWatch(server, pane, interval, timeout, started, cancel, entry, entry_alternate, entry_state, open, timer) [overload 1] -
entry(String) # forScreenWatch(server, pane, interval, timeout, started, cancel, entry, entry_alternate, entry_state, open, timer) [overload 1] -
entry_alternate(Bool) # forScreenWatch(server, pane, interval, timeout, started, cancel, entry, entry_alternate, entry_state, open, timer) [overload 1] -
entry_state(Symbol) # forScreenWatch(server, pane, interval, timeout, started, cancel, entry, entry_alternate, entry_state, open, timer) [overload 1] -
open(Bool) # forScreenWatch(server, pane, interval, timeout, started, cancel, entry, entry_alternate, entry_state, open, timer) [overload 1] -
timer(Union{Nothing, Base.Timer }) # forScreenWatch(server, pane, interval, timeout, started, cancel, entry, entry_alternate, entry_state, open, timer) [overload 1] -
server(Any) # forScreenWatch(server, pane, interval, timeout, started, cancel, entry, entry_alternate, entry_state, open, timer) [overload 2] -
pane(Any) # forScreenWatch(server, pane, interval, timeout, started, cancel, entry, entry_alternate, entry_state, open, timer) [overload 2] -
interval(Any) # forScreenWatch(server, pane, interval, timeout, started, cancel, entry, entry_alternate, entry_state, open, timer) [overload 2] -
timeout(Any) # forScreenWatch(server, pane, interval, timeout, started, cancel, entry, entry_alternate, entry_state, open, timer) [overload 2] -
started(Any) # forScreenWatch(server, pane, interval, timeout, started, cancel, entry, entry_alternate, entry_state, open, timer) [overload 2] -
entry(Any) # forScreenWatch(server, pane, interval, timeout, started, cancel, entry, entry_alternate, entry_state, open, timer) [overload 2] -
entry_alternate(Any) # forScreenWatch(server, pane, interval, timeout, started, cancel, entry, entry_alternate, entry_state, open, timer) [overload 2] -
entry_state(Any) # forScreenWatch(server, pane, interval, timeout, started, cancel, entry, entry_alternate, entry_state, open, timer) [overload 2] -
open(Any) # forScreenWatch(server, pane, interval, timeout, started, cancel, entry, entry_alternate, entry_state, open, timer) [overload 2] -
timer(Any) # forScreenWatch(server, pane, interval, timeout, started, cancel, entry, entry_alternate, entry_state, open, timer) [overload 2]
-
Fields11#
Common operations1#
Other members10#
- entry: String property
- entry_alternate: Bool property
- entry_state: Symbol property
- interval: Float64 property
- open: Bool property
- pane: Lib
Tmux property.Pane Ref - server: Lib
Tmux property.Server - started: UInt64 property
- timeout: Float64 property
- timer: Union{Nothing, Base
.Timer } property