shotgrid_api_ruby 0.2.0.4 → 0.2.0.6
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/test_and_publish.yml +3 -3
- data/.github/workflows/test_only.yml +7 -5
- data/.ruby-version +1 -1
- data/CHANGELOG.md +54 -2
- data/Gemfile +12 -0
- data/Gemfile.lock +108 -93
- data/bin/prettirun +1 -1
- data/docs/ShotgridApiRuby/Auth/Validator.html +4 -4
- data/docs/ShotgridApiRuby/Auth.html +4 -4
- data/docs/ShotgridApiRuby/Client.html +4 -4
- data/docs/ShotgridApiRuby/Entities/Params/TooComplexFiltersError.html +4 -4
- data/docs/ShotgridApiRuby/Entities/Params.html +41 -41
- data/docs/ShotgridApiRuby/Entities/Schema.html +4 -4
- data/docs/ShotgridApiRuby/Entities/Summarize/Summary.html +8 -8
- data/docs/ShotgridApiRuby/Entities/Summarize.html +9 -9
- data/docs/ShotgridApiRuby/Entities.html +27 -27
- data/docs/ShotgridApiRuby/Entity.html +12 -12
- data/docs/ShotgridApiRuby/Preferences.html +4 -4
- data/docs/ShotgridApiRuby/ServerInfo.html +4 -4
- data/docs/ShotgridApiRuby/ShotgridCallError.html +4 -4
- data/docs/ShotgridApiRuby/Types.html +4 -4
- data/docs/ShotgridApiRuby.html +5 -5
- data/docs/_index.html +5 -5
- data/docs/file.README.html +4 -4
- data/docs/frames.html +1 -1
- data/docs/index.html +4 -4
- data/docs/top-level-namespace.html +4 -4
- data/lib/shotgrid_api_ruby/entities/params.rb +15 -18
- data/lib/shotgrid_api_ruby/entities/summarize.rb +4 -4
- data/lib/shotgrid_api_ruby/entities.rb +23 -23
- data/lib/shotgrid_api_ruby/version.rb +1 -1
- data/shotgrid_api_ruby.gemspec +3 -12
- data/sorbet/rbi/gems/activesupport@7.0.4.2.rbi +18676 -0
- data/sorbet/rbi/gems/ast@2.4.2.rbi +533 -3
- data/sorbet/rbi/gems/backport@1.2.0.rbi +518 -4
- data/sorbet/rbi/gems/benchmark@0.2.1.rbi +588 -0
- data/sorbet/rbi/gems/bundler-audit@0.9.1.rbi +308 -0
- data/sorbet/rbi/gems/byebug@11.1.3.rbi +2065 -28
- data/sorbet/rbi/gems/childprocess@4.1.0.rbi +397 -4
- data/sorbet/rbi/gems/coderay@1.1.3.rbi +2425 -4
- data/sorbet/rbi/gems/concurrent-ruby@1.2.0.rbi +11570 -0
- data/sorbet/rbi/gems/diff-lcs@1.5.0.rbi +1083 -0
- data/sorbet/rbi/gems/docile@1.4.0.rbi +335 -13
- data/sorbet/rbi/gems/dotenv@2.8.1.rbi +234 -0
- data/sorbet/rbi/gems/e2mmap@0.1.0.rbi +4 -4
- data/sorbet/rbi/gems/faker@3.1.0.rbi +13380 -0
- data/sorbet/rbi/gems/faraday-em_http@1.0.0.rbi +167 -11
- data/sorbet/rbi/gems/faraday-em_synchrony@1.0.0.rbi +94 -11
- data/sorbet/rbi/gems/faraday-excon@1.1.0.rbi +105 -11
- data/sorbet/rbi/gems/faraday-httpclient@1.0.1.rbi +118 -11
- data/sorbet/rbi/gems/faraday-multipart@1.0.4.rbi +273 -0
- data/sorbet/rbi/gems/faraday-net_http@1.0.1.rbi +106 -11
- data/sorbet/rbi/gems/faraday-net_http_persistent@1.2.0.rbi +92 -11
- data/sorbet/rbi/gems/faraday-patron@1.0.0.rbi +97 -11
- data/sorbet/rbi/gems/faraday-rack@1.0.0.rbi +106 -11
- data/sorbet/rbi/gems/faraday-retry@1.0.3.rbi +227 -0
- data/sorbet/rbi/gems/faraday@1.10.3.rbi +2743 -0
- data/sorbet/rbi/gems/ffi@1.15.5.rbi +8 -0
- data/sorbet/rbi/gems/formatador@1.1.0.rbi +8 -0
- data/sorbet/rbi/gems/guard-compat@1.2.1.rbi +62 -4
- data/sorbet/rbi/gems/guard-rspec@4.7.3.rbi +558 -4
- data/sorbet/rbi/gems/guard@2.18.0.rbi +4 -4
- data/sorbet/rbi/gems/haml@6.1.1.rbi +1588 -0
- data/sorbet/rbi/gems/i18n@1.12.0.rbi +2296 -0
- data/sorbet/rbi/gems/iniparse@1.5.0.rbi +893 -4
- data/sorbet/rbi/gems/jaro_winkler@1.5.4.rbi +15 -4
- data/sorbet/rbi/gems/json@2.6.3.rbi +1533 -0
- data/sorbet/rbi/gems/kramdown-parser-gfm@1.1.0.rbi +129 -4
- data/sorbet/rbi/gems/kramdown@2.4.0.rbi +3271 -0
- data/sorbet/rbi/gems/listen@3.8.0.rbi +1181 -0
- data/sorbet/rbi/gems/lumberjack@1.2.8.rbi +4 -4
- data/sorbet/rbi/gems/method_source@1.0.0.rbi +202 -2
- data/sorbet/rbi/gems/minitest@5.17.0.rbi +1457 -0
- data/sorbet/rbi/gems/multipart-post@2.3.0.rbi +233 -0
- data/sorbet/rbi/gems/nenv@0.3.0.rbi +4 -4
- data/sorbet/rbi/gems/netrc@0.11.0.rbi +158 -0
- data/sorbet/rbi/gems/nokogiri@1.14.0.rbi +7250 -0
- data/sorbet/rbi/gems/notiffany@0.1.3.rbi +4 -4
- data/sorbet/rbi/gems/overcommit@0.60.0.rbi +2399 -0
- data/sorbet/rbi/gems/parallel@1.22.1.rbi +277 -0
- data/sorbet/rbi/gems/parser@3.2.0.0.rbi +6964 -0
- data/sorbet/rbi/gems/prettier@3.2.2.rbi +22 -0
- data/sorbet/rbi/gems/prettier_print@1.2.0.rbi +8 -0
- data/sorbet/rbi/gems/pry-byebug@3.10.1.rbi +1171 -0
- data/sorbet/rbi/gems/pry@0.14.2.rbi +10081 -0
- data/sorbet/rbi/gems/racc@1.6.2.rbi +154 -0
- data/sorbet/rbi/gems/rainbow@3.1.1.rbi +408 -0
- data/sorbet/rbi/gems/rake@13.0.6.rbi +2248 -13
- data/sorbet/rbi/gems/rb-fsevent@0.11.2.rbi +8 -0
- data/sorbet/rbi/gems/rb-inotify@0.10.1.rbi +4 -4
- data/sorbet/rbi/gems/rbi@0.0.16.rbi +3008 -0
- data/sorbet/rbi/gems/rbs@2.8.4.rbi +8 -0
- data/sorbet/rbi/gems/regexp_parser@2.6.2.rbi +3481 -0
- data/sorbet/rbi/gems/reverse_markdown@2.1.1.rbi +389 -0
- data/sorbet/rbi/gems/rexml@3.2.5.rbi +4048 -3
- data/sorbet/rbi/gems/rspec-core@3.12.0.rbi +10809 -0
- data/sorbet/rbi/gems/rspec-expectations@3.12.2.rbi +8109 -0
- data/sorbet/rbi/gems/rspec-mocks@3.12.3.rbi +5308 -0
- data/sorbet/rbi/gems/rspec-support@3.12.0.rbi +1620 -0
- data/sorbet/rbi/gems/rspec@3.12.0.rbi +91 -0
- data/sorbet/rbi/gems/rspec_in_context@1.1.0.3.rbi +387 -15
- data/sorbet/rbi/gems/rubocop-ast@1.24.1.rbi +7019 -0
- data/sorbet/rbi/gems/rubocop-faker@1.1.0.rbi +102 -4
- data/sorbet/rbi/gems/rubocop-performance@1.15.2.rbi +3021 -0
- data/sorbet/rbi/gems/rubocop-sorbet@0.6.11.rbi +990 -0
- data/sorbet/rbi/gems/rubocop@1.44.1.rbi +54394 -0
- data/sorbet/rbi/gems/ruby-progressbar@1.11.0.rbi +1235 -4
- data/sorbet/rbi/gems/ruby2_keywords@0.0.5.rbi +4 -4
- data/sorbet/rbi/gems/shellany@0.0.1.rbi +4 -4
- data/sorbet/rbi/gems/simplecov-html@0.12.3.rbi +135 -5
- data/sorbet/rbi/gems/simplecov@0.22.0.rbi +2148 -0
- data/sorbet/rbi/gems/simplecov_json_formatter@0.1.4.rbi +8 -0
- data/sorbet/rbi/gems/solargraph@0.48.0.rbi +9146 -0
- data/sorbet/rbi/gems/spoom@1.1.15.rbi +2383 -0
- data/sorbet/rbi/gems/syntax_tree-haml@3.0.0.rbi +8 -0
- data/sorbet/rbi/gems/syntax_tree-rbs@0.5.1.rbi +8 -0
- data/sorbet/rbi/gems/syntax_tree@5.2.0.rbi +8 -0
- data/sorbet/rbi/gems/tapioca@0.10.5.rbi +3226 -0
- data/sorbet/rbi/gems/temple@0.10.0.rbi +1722 -0
- data/sorbet/rbi/gems/thor@1.2.1.rbi +3956 -0
- data/sorbet/rbi/gems/tilt@2.0.11.rbi +745 -0
- data/sorbet/rbi/gems/timecop@0.9.6.rbi +368 -0
- data/sorbet/rbi/gems/tzinfo@2.0.5.rbi +5914 -0
- data/sorbet/rbi/gems/unicode-display_width@2.4.2.rbi +65 -0
- data/sorbet/rbi/gems/unparser@0.6.7.rbi +4524 -0
- data/sorbet/rbi/gems/vcr@6.1.0.rbi +3020 -0
- data/sorbet/rbi/gems/webrick@1.7.0.rbi +2555 -0
- data/sorbet/rbi/gems/yard-sorbet@0.8.0.rbi +441 -0
- data/sorbet/rbi/gems/yard@0.9.28.rbi +17863 -0
- data/sorbet/rbi/gems/zeitwerk@2.6.6.rbi +950 -0
- data/yarn.lock +3 -3
- metadata +71 -190
- data/sorbet/rbi/gems/activesupport@6.1.4.1.rbi +0 -3770
- data/sorbet/rbi/gems/benchmark@0.1.1.rbi +0 -65
- data/sorbet/rbi/gems/bundler-audit@0.8.0.rbi +0 -8
- data/sorbet/rbi/gems/colorize@0.8.1.rbi +0 -39
- data/sorbet/rbi/gems/commander@4.6.0.rbi +0 -8
- data/sorbet/rbi/gems/concurrent-ruby@1.1.9.rbi +0 -2403
- data/sorbet/rbi/gems/diff-lcs@1.4.4.rbi +0 -8
- data/sorbet/rbi/gems/dotenv@2.7.6.rbi +0 -88
- data/sorbet/rbi/gems/faker@2.19.0.rbi +0 -2513
- data/sorbet/rbi/gems/faraday@1.7.0.rbi +0 -783
- data/sorbet/rbi/gems/ffi@1.15.3.rbi +0 -8
- data/sorbet/rbi/gems/formatador@0.3.0.rbi +0 -8
- data/sorbet/rbi/gems/haml@5.2.2.rbi +0 -8
- data/sorbet/rbi/gems/highline@2.0.3.rbi +0 -8
- data/sorbet/rbi/gems/i18n@1.8.10.rbi +0 -584
- data/sorbet/rbi/gems/kramdown@2.3.1.rbi +0 -8
- data/sorbet/rbi/gems/listen@3.7.0.rbi +0 -476
- data/sorbet/rbi/gems/minitest@5.14.4.rbi +0 -344
- data/sorbet/rbi/gems/multipart-post@2.1.1.rbi +0 -69
- data/sorbet/rbi/gems/nokogiri@1.12.3.rbi +0 -8
- data/sorbet/rbi/gems/overcommit@0.58.0.rbi +0 -8
- data/sorbet/rbi/gems/parallel@1.20.1.rbi +0 -8
- data/sorbet/rbi/gems/parlour@6.0.1.rbi +0 -1610
- data/sorbet/rbi/gems/parser@3.0.2.0.rbi +0 -1731
- data/sorbet/rbi/gems/prettier@1.6.1.rbi +0 -8
- data/sorbet/rbi/gems/pry-byebug@3.9.0.rbi +0 -461
- data/sorbet/rbi/gems/pry@0.13.1.rbi +0 -2553
- data/sorbet/rbi/gems/racc@1.5.2.rbi +0 -47
- data/sorbet/rbi/gems/rainbow@3.0.0.rbi +0 -153
- data/sorbet/rbi/gems/rb-fsevent@0.11.0.rbi +0 -8
- data/sorbet/rbi/gems/regexp_parser@2.1.1.rbi +0 -8
- data/sorbet/rbi/gems/reverse_markdown@2.0.0.rbi +0 -8
- data/sorbet/rbi/gems/rspec-core@3.10.1.rbi +0 -2500
- data/sorbet/rbi/gems/rspec-expectations@3.10.1.rbi +0 -1574
- data/sorbet/rbi/gems/rspec-mocks@3.10.2.rbi +0 -1462
- data/sorbet/rbi/gems/rspec-support@3.10.2.rbi +0 -510
- data/sorbet/rbi/gems/rspec@3.10.0.rbi +0 -39
- data/sorbet/rbi/gems/rubocop-ast@1.11.0.rbi +0 -8
- data/sorbet/rbi/gems/rubocop-performance@1.11.5.rbi +0 -8
- data/sorbet/rbi/gems/rubocop-sorbet@0.6.2.rbi +0 -8
- data/sorbet/rbi/gems/rubocop@1.20.0.rbi +0 -8
- data/sorbet/rbi/gems/simplecov@0.21.2.rbi +0 -577
- data/sorbet/rbi/gems/simplecov_json_formatter@0.1.3.rbi +0 -8
- data/sorbet/rbi/gems/solargraph@0.43.0.rbi +0 -8
- data/sorbet/rbi/gems/spoom@1.1.2.rbi +0 -1204
- data/sorbet/rbi/gems/tapioca@0.4.25.rbi +0 -1239
- data/sorbet/rbi/gems/temple@0.8.2.rbi +0 -8
- data/sorbet/rbi/gems/thor@1.1.0.rbi +0 -838
- data/sorbet/rbi/gems/tilt@2.0.10.rbi +0 -8
- data/sorbet/rbi/gems/timecop@0.9.4.rbi +0 -82
- data/sorbet/rbi/gems/tzinfo@2.0.4.rbi +0 -857
- data/sorbet/rbi/gems/unicode-display_width@2.0.0.rbi +0 -8
- data/sorbet/rbi/gems/unparser@0.6.0.rbi +0 -8
- data/sorbet/rbi/gems/vcr@6.0.0.rbi +0 -782
- data/sorbet/rbi/gems/yard-sorbet@0.5.3.rbi +0 -8
- data/sorbet/rbi/gems/yard@0.9.26.rbi +0 -8
- data/sorbet/rbi/gems/zeitwerk@2.4.2.rbi +0 -173
@@ -1,8 +1,522 @@
|
|
1
|
+
# typed: true
|
2
|
+
|
1
3
|
# DO NOT EDIT MANUALLY
|
2
4
|
# This is an autogenerated file for types exported from the `backport` gem.
|
3
|
-
# Please instead update this file by running `bin/tapioca
|
5
|
+
# Please instead update this file by running `bin/tapioca gem backport`.
|
4
6
|
|
5
|
-
#
|
7
|
+
# An event-driven IO library.
|
8
|
+
#
|
9
|
+
# source://backport//lib/backport/version.rb#1
|
10
|
+
module Backport
|
11
|
+
class << self
|
12
|
+
# @return [Logger]
|
13
|
+
#
|
14
|
+
# source://backport//lib/backport.rb#75
|
15
|
+
def logger; end
|
16
|
+
|
17
|
+
# Prepare an interval server to run in Backport.
|
18
|
+
#
|
19
|
+
# @param period [Float] Seconds between intervals
|
20
|
+
# @return [void]
|
21
|
+
#
|
22
|
+
# source://backport//lib/backport.rb#35
|
23
|
+
def prepare_interval(period, &block); end
|
24
|
+
|
25
|
+
# Prepare a STDIO server to run in Backport.
|
26
|
+
#
|
27
|
+
# @param adapter [Adapter]
|
28
|
+
# @return [void]
|
29
|
+
#
|
30
|
+
# source://backport//lib/backport.rb#17
|
31
|
+
def prepare_stdio_server(adapter: T.unsafe(nil)); end
|
32
|
+
|
33
|
+
# Prepare a TCP server to run in Backport.
|
34
|
+
#
|
35
|
+
# @param host [String]
|
36
|
+
# @param port [Integer]
|
37
|
+
# @param adapter [Adapter]
|
38
|
+
# @return [void]
|
39
|
+
#
|
40
|
+
# source://backport//lib/backport.rb#27
|
41
|
+
def prepare_tcp_server(host: T.unsafe(nil), port: T.unsafe(nil), adapter: T.unsafe(nil)); end
|
42
|
+
|
43
|
+
# Run the Backport machine. The provided block will be executed before the
|
44
|
+
# machine starts. Program execution is blocked until the machine stops.
|
45
|
+
#
|
46
|
+
# @example Print "tick" once per second
|
47
|
+
# Backport.run do
|
48
|
+
# Backport.prepare_interval 1 do
|
49
|
+
# puts "tick"
|
50
|
+
# end
|
51
|
+
# end
|
52
|
+
# @return [void]
|
53
|
+
#
|
54
|
+
# source://backport//lib/backport.rb#50
|
55
|
+
def run(&block); end
|
56
|
+
|
57
|
+
# Stop all running Backport machines.
|
58
|
+
#
|
59
|
+
# For more accurate control, consider stopping the machine
|
60
|
+
# from the self reference in Machine#run, e.g.:
|
61
|
+
#
|
62
|
+
# ```
|
63
|
+
# Backport.run do |machine|
|
64
|
+
# # ...
|
65
|
+
# machine.stop
|
66
|
+
# end
|
67
|
+
# ```
|
68
|
+
#
|
69
|
+
# @return [void]
|
70
|
+
#
|
71
|
+
# source://backport//lib/backport.rb#70
|
72
|
+
def stop; end
|
73
|
+
|
74
|
+
private
|
75
|
+
|
76
|
+
# @return [Array<Machine>]
|
77
|
+
#
|
78
|
+
# source://backport//lib/backport.rb#82
|
79
|
+
def machines; end
|
80
|
+
end
|
81
|
+
end
|
82
|
+
|
83
|
+
# The application interface between Backport servers and clients.
|
84
|
+
#
|
85
|
+
# source://backport//lib/backport/adapter.rb#4
|
86
|
+
class Backport::Adapter
|
87
|
+
# @param output [IO]
|
88
|
+
# @param remote [Hash{Symbol => String, Integer}]
|
89
|
+
# @return [Adapter] a new instance of Adapter
|
90
|
+
#
|
91
|
+
# source://backport//lib/backport/adapter.rb#7
|
92
|
+
def initialize(output, remote = T.unsafe(nil)); end
|
93
|
+
|
94
|
+
# Close the client connection.
|
95
|
+
#
|
96
|
+
# @note The adapter sets #closed? to true and runs the #closing callback.
|
97
|
+
# The server is responsible for implementation details like closing the
|
98
|
+
# client's socket.
|
99
|
+
# @return [void]
|
100
|
+
#
|
101
|
+
# source://backport//lib/backport/adapter.rb#80
|
102
|
+
def close; end
|
103
|
+
|
104
|
+
# @return [Boolean]
|
105
|
+
#
|
106
|
+
# source://backport//lib/backport/adapter.rb#69
|
107
|
+
def closed?; end
|
108
|
+
|
109
|
+
# A callback triggered when a client connection is closing. Subclasses
|
110
|
+
# and/or modules should override this method to provide their own
|
111
|
+
# functionality.
|
112
|
+
#
|
113
|
+
# @return [void]
|
114
|
+
#
|
115
|
+
# source://backport//lib/backport/adapter.rb#41
|
116
|
+
def closing; end
|
117
|
+
|
118
|
+
# A callback triggered when a client connection is opening. Subclasses
|
119
|
+
# and/or modules should override this method to provide their own
|
120
|
+
# functionality.
|
121
|
+
#
|
122
|
+
# @return [void]
|
123
|
+
#
|
124
|
+
# source://backport//lib/backport/adapter.rb#34
|
125
|
+
def opening; end
|
126
|
+
|
127
|
+
# A callback triggered when the server receives data from the client.
|
128
|
+
# Subclasses and/or modules should override this method to provide their
|
129
|
+
# own functionality.
|
130
|
+
#
|
131
|
+
# @param data [String]
|
132
|
+
# @return [void]
|
133
|
+
#
|
134
|
+
# source://backport//lib/backport/adapter.rb#49
|
135
|
+
def receiving(data); end
|
136
|
+
|
137
|
+
# A hash of information about the client connection. The data can vary
|
138
|
+
# based on the transport, e.g., :hostname and :address for TCP connections
|
139
|
+
# or :filename for file streams.
|
140
|
+
#
|
141
|
+
# @return [Hash{Symbol => String, Integer}]
|
142
|
+
#
|
143
|
+
# source://backport//lib/backport/adapter.rb#25
|
144
|
+
def remote; end
|
145
|
+
|
146
|
+
# Send data to the client.
|
147
|
+
#
|
148
|
+
# @param data [String]
|
149
|
+
# @return [void]
|
150
|
+
#
|
151
|
+
# source://backport//lib/backport/adapter.rb#55
|
152
|
+
def write(data); end
|
153
|
+
|
154
|
+
# Send a line of data to the client.
|
155
|
+
#
|
156
|
+
# @param data [String]
|
157
|
+
# @return [void]
|
158
|
+
#
|
159
|
+
# source://backport//lib/backport/adapter.rb#64
|
160
|
+
def write_line(data); end
|
161
|
+
end
|
162
|
+
|
163
|
+
# A client connected to a connectable Backport server.
|
164
|
+
#
|
165
|
+
# source://backport//lib/backport/client.rb#6
|
166
|
+
class Backport::Client
|
167
|
+
include ::Observable
|
168
|
+
|
169
|
+
# @param input [IO]
|
170
|
+
# @param output [IO]
|
171
|
+
# @param adapter [Class, Module]
|
172
|
+
# @param remote [Hash]
|
173
|
+
# @return [Client] a new instance of Client
|
174
|
+
#
|
175
|
+
# source://backport//lib/backport/client.rb#16
|
176
|
+
def initialize(input, output, adapter, remote = T.unsafe(nil)); end
|
177
|
+
|
178
|
+
# @return [Adapter]
|
179
|
+
#
|
180
|
+
# source://backport//lib/backport/client.rb#10
|
181
|
+
def adapter; end
|
182
|
+
|
183
|
+
# Start running the client. This method will start the thread that reads
|
184
|
+
# client input from IO.
|
185
|
+
#
|
186
|
+
# @deprecated Prefer #start to #run for non-blocking client/server methods
|
187
|
+
# @return [void]
|
188
|
+
#
|
189
|
+
# source://backport//lib/backport/client.rb#50
|
190
|
+
def run; end
|
191
|
+
|
192
|
+
# Start running the client. This method will start the thread that reads
|
193
|
+
# client input from IO.
|
194
|
+
#
|
195
|
+
# @return [void]
|
196
|
+
#
|
197
|
+
# source://backport//lib/backport/client.rb#50
|
198
|
+
def start; end
|
199
|
+
|
200
|
+
# Close the client connection.
|
201
|
+
#
|
202
|
+
# callback. The server is responsible for implementation details like
|
203
|
+
# closing the client's socket.
|
204
|
+
#
|
205
|
+
# @note The client sets #stopped? to true and runs the adapter's #closing
|
206
|
+
# @return [void]
|
207
|
+
#
|
208
|
+
# source://backport//lib/backport/client.rb#38
|
209
|
+
def stop; end
|
210
|
+
|
211
|
+
# True if the client is stopped.
|
212
|
+
#
|
213
|
+
# @return [Boolean]
|
214
|
+
#
|
215
|
+
# source://backport//lib/backport/client.rb#27
|
216
|
+
def stopped?; end
|
217
|
+
|
218
|
+
# Handle a tick from the server. This method will check for client input
|
219
|
+
# and update the adapter accordingly, or stop the client if the adapter is
|
220
|
+
# closed.
|
221
|
+
#
|
222
|
+
# @return [void]
|
223
|
+
#
|
224
|
+
# source://backport//lib/backport/client.rb#64
|
225
|
+
def tick; end
|
226
|
+
|
227
|
+
private
|
228
|
+
|
229
|
+
# @param mod_cls [Module, Class] The Adapter module or class
|
230
|
+
# @param remote [Hash] Remote client data
|
231
|
+
# @return [Adapter]
|
232
|
+
#
|
233
|
+
# source://backport//lib/backport/client.rb#86
|
234
|
+
def make_adapter(mod_cls, remote); end
|
235
|
+
|
236
|
+
# @return [Mutex]
|
237
|
+
#
|
238
|
+
# source://backport//lib/backport/client.rb#98
|
239
|
+
def mutex; end
|
240
|
+
|
241
|
+
# Read the client input. Return nil if the input buffer is empty.
|
242
|
+
#
|
243
|
+
# @return [String, nil]
|
244
|
+
#
|
245
|
+
# source://backport//lib/backport/client.rb#74
|
246
|
+
def read; end
|
247
|
+
|
248
|
+
# Read input from the client.
|
249
|
+
#
|
250
|
+
# @return [void]
|
251
|
+
#
|
252
|
+
# source://backport//lib/backport/client.rb#112
|
253
|
+
def read_input; end
|
254
|
+
|
255
|
+
# Start the thread that checks the input IO for client data.
|
256
|
+
#
|
257
|
+
# @return [void]
|
258
|
+
#
|
259
|
+
# source://backport//lib/backport/client.rb#103
|
260
|
+
def run_input_thread; end
|
261
|
+
end
|
262
|
+
|
263
|
+
# The Backport server controller.
|
264
|
+
#
|
265
|
+
# source://backport//lib/backport/machine.rb#4
|
266
|
+
class Backport::Machine
|
267
|
+
# @return [Machine] a new instance of Machine
|
268
|
+
#
|
269
|
+
# source://backport//lib/backport/machine.rb#5
|
270
|
+
def initialize; end
|
271
|
+
|
272
|
+
# Add a server to the machine. The server will be started when the machine
|
273
|
+
# starts. If the machine is already running, the server will be started
|
274
|
+
# immediately.
|
275
|
+
#
|
276
|
+
# @param server [Server::Base]
|
277
|
+
# @return [void]
|
278
|
+
#
|
279
|
+
# source://backport//lib/backport/machine.rb#45
|
280
|
+
def prepare(server); end
|
281
|
+
|
282
|
+
# Run the machine. If a block is provided, it gets executed before the
|
283
|
+
# maching starts its main loop. The main loop blocks program execution
|
284
|
+
# until the machine is stopped.
|
285
|
+
#
|
286
|
+
# @return [void]
|
287
|
+
# @yieldparam [self]
|
288
|
+
#
|
289
|
+
# source://backport//lib/backport/machine.rb#16
|
290
|
+
def run; end
|
291
|
+
|
292
|
+
# @return [Array<Server::Base>]
|
293
|
+
#
|
294
|
+
# source://backport//lib/backport/machine.rb#52
|
295
|
+
def servers; end
|
296
|
+
|
297
|
+
# Stop the machine.
|
298
|
+
#
|
299
|
+
# @return [void]
|
300
|
+
#
|
301
|
+
# source://backport//lib/backport/machine.rb#27
|
302
|
+
def stop; end
|
303
|
+
|
304
|
+
# True if the machine is stopped.
|
305
|
+
#
|
306
|
+
# @return [Boolean]
|
307
|
+
#
|
308
|
+
# source://backport//lib/backport/machine.rb#35
|
309
|
+
def stopped?; end
|
310
|
+
|
311
|
+
# @param server [Server::Base]
|
312
|
+
# @return [void]
|
313
|
+
#
|
314
|
+
# source://backport//lib/backport/machine.rb#58
|
315
|
+
def update(server); end
|
316
|
+
|
317
|
+
private
|
318
|
+
|
319
|
+
# @return [Mutex]
|
320
|
+
#
|
321
|
+
# source://backport//lib/backport/machine.rb#70
|
322
|
+
def mutex; end
|
323
|
+
|
324
|
+
# Start the thread that updates servers via the #tick method.
|
325
|
+
#
|
326
|
+
# @return [void]
|
327
|
+
#
|
328
|
+
# source://backport//lib/backport/machine.rb#75
|
329
|
+
def run_server_thread; end
|
330
|
+
end
|
331
|
+
|
332
|
+
# Classes and modules for Backport servers.
|
333
|
+
#
|
334
|
+
# source://backport//lib/backport/server.rb#4
|
335
|
+
module Backport::Server; end
|
336
|
+
|
337
|
+
# An extendable server class that provides basic start/stop functionality
|
338
|
+
# and common callbacks.
|
339
|
+
#
|
340
|
+
# source://backport//lib/backport/server/base.rb#8
|
341
|
+
class Backport::Server::Base
|
342
|
+
include ::Observable
|
343
|
+
|
344
|
+
# Start the server.
|
345
|
+
#
|
346
|
+
# @return [void]
|
347
|
+
#
|
348
|
+
# source://backport//lib/backport/server/base.rb#14
|
349
|
+
def start; end
|
350
|
+
|
351
|
+
# @return [Boolean]
|
352
|
+
#
|
353
|
+
# source://backport//lib/backport/server/base.rb#31
|
354
|
+
def started?; end
|
355
|
+
|
356
|
+
# A callback triggered when a Machine starts running or the server is
|
357
|
+
# added to a running machine. Subclasses should override this method to
|
358
|
+
# provide their own functionality.
|
359
|
+
#
|
360
|
+
# @return [void]
|
361
|
+
#
|
362
|
+
# source://backport//lib/backport/server/base.rb#44
|
363
|
+
def starting; end
|
364
|
+
|
365
|
+
# Stop the server.
|
366
|
+
#
|
367
|
+
# @return [void]
|
368
|
+
#
|
369
|
+
# source://backport//lib/backport/server/base.rb#23
|
370
|
+
def stop; end
|
371
|
+
|
372
|
+
# @return [Boolean]
|
373
|
+
#
|
374
|
+
# source://backport//lib/backport/server/base.rb#35
|
375
|
+
def stopped?; end
|
376
|
+
|
377
|
+
# A callback triggered when the server is stopping. Subclasses should
|
378
|
+
# override this method to provide their own functionality.
|
379
|
+
#
|
380
|
+
# @return [void]
|
381
|
+
#
|
382
|
+
# source://backport//lib/backport/server/base.rb#50
|
383
|
+
def stopping; end
|
384
|
+
|
385
|
+
# A callback triggered from the main loop of a running Machine.
|
386
|
+
# Subclasses should override this method to provide their own
|
387
|
+
# functionality.
|
388
|
+
#
|
389
|
+
# @return [void]
|
390
|
+
#
|
391
|
+
# source://backport//lib/backport/server/base.rb#57
|
392
|
+
def tick; end
|
393
|
+
end
|
394
|
+
|
395
|
+
# A mixin for Backport servers that communicate with clients.
|
396
|
+
#
|
397
|
+
# Connectable servers check clients for incoming data on each tick.
|
398
|
+
#
|
399
|
+
# source://backport//lib/backport/server/connectable.rb#7
|
400
|
+
module Backport::Server::Connectable
|
401
|
+
# @return [Array<Client>]
|
402
|
+
#
|
403
|
+
# source://backport//lib/backport/server/connectable.rb#19
|
404
|
+
def clients; end
|
405
|
+
|
406
|
+
# @return [void]
|
407
|
+
#
|
408
|
+
# source://backport//lib/backport/server/connectable.rb#9
|
409
|
+
def starting; end
|
410
|
+
|
411
|
+
# @return [void]
|
412
|
+
#
|
413
|
+
# source://backport//lib/backport/server/connectable.rb#14
|
414
|
+
def stopping; end
|
415
|
+
|
416
|
+
private
|
417
|
+
|
418
|
+
# @return [Mutex]
|
419
|
+
#
|
420
|
+
# source://backport//lib/backport/server/connectable.rb#26
|
421
|
+
def mutex; end
|
422
|
+
end
|
423
|
+
|
424
|
+
# A Backport periodical interval server.
|
425
|
+
#
|
426
|
+
# source://backport//lib/backport/server/interval.rb#5
|
427
|
+
class Backport::Server::Interval < ::Backport::Server::Base
|
428
|
+
# @param period [Float] The interval time in seconds.
|
429
|
+
# @param block [Proc] The proc to run on each interval.
|
430
|
+
# @return [Interval] a new instance of Interval
|
431
|
+
# @yieldparam [Interval]
|
432
|
+
#
|
433
|
+
# source://backport//lib/backport/server/interval.rb#9
|
434
|
+
def initialize(period, &block); end
|
435
|
+
|
436
|
+
# source://backport//lib/backport/server/interval.rb#16
|
437
|
+
def starting; end
|
438
|
+
|
439
|
+
# source://backport//lib/backport/server/interval.rb#21
|
440
|
+
def tick; end
|
441
|
+
|
442
|
+
private
|
443
|
+
|
444
|
+
# @return [void]
|
445
|
+
#
|
446
|
+
# source://backport//lib/backport/server/interval.rb#32
|
447
|
+
def run_ready_thread; end
|
448
|
+
end
|
449
|
+
|
450
|
+
# A Backport STDIO server.
|
451
|
+
#
|
452
|
+
# source://backport//lib/backport/server/stdio.rb#5
|
453
|
+
class Backport::Server::Stdio < ::Backport::Server::Base
|
454
|
+
include ::Backport::Server::Connectable
|
455
|
+
|
456
|
+
# @param input [IO]
|
457
|
+
# @param output [IO]
|
458
|
+
# @param adapter [Module, Class]
|
459
|
+
# @return [Stdio] a new instance of Stdio
|
460
|
+
#
|
461
|
+
# source://backport//lib/backport/server/stdio.rb#11
|
462
|
+
def initialize(input: T.unsafe(nil), output: T.unsafe(nil), adapter: T.unsafe(nil)); end
|
463
|
+
|
464
|
+
# @param client [Client]
|
465
|
+
# @return [void]
|
466
|
+
#
|
467
|
+
# source://backport//lib/backport/server/stdio.rb#22
|
468
|
+
def update(client); end
|
469
|
+
end
|
470
|
+
|
471
|
+
# A Backport TCP server. It runs a thread to accept incoming connections
|
472
|
+
# and automatically stops when the socket is closed.
|
473
|
+
#
|
474
|
+
# source://backport//lib/backport/server/tcpip.rb#8
|
475
|
+
class Backport::Server::Tcpip < ::Backport::Server::Base
|
476
|
+
include ::Backport::Server::Connectable
|
477
|
+
|
478
|
+
# @param host [String]
|
479
|
+
# @param port [Integer]
|
480
|
+
# @param adapter [Module, Class]
|
481
|
+
# @param socket_class [Class]
|
482
|
+
# @return [Tcpip] a new instance of Tcpip
|
483
|
+
#
|
484
|
+
# source://backport//lib/backport/server/tcpip.rb#15
|
485
|
+
def initialize(host: T.unsafe(nil), port: T.unsafe(nil), adapter: T.unsafe(nil), socket_class: T.unsafe(nil)); end
|
486
|
+
|
487
|
+
# Accept an incoming connection using accept_nonblock. Return the
|
488
|
+
# resulting Client if a connection was accepted or nil if no connections
|
489
|
+
# are pending.
|
490
|
+
#
|
491
|
+
# @return [Client, nil]
|
492
|
+
#
|
493
|
+
# source://backport//lib/backport/server/tcpip.rb#41
|
494
|
+
def accept; end
|
495
|
+
|
496
|
+
# source://backport//lib/backport/server/tcpip.rb#21
|
497
|
+
def starting; end
|
498
|
+
|
499
|
+
# source://backport//lib/backport/server/tcpip.rb#25
|
500
|
+
def stopping; end
|
501
|
+
|
502
|
+
# @param client [Client]
|
503
|
+
# @return [void]
|
504
|
+
#
|
505
|
+
# source://backport//lib/backport/server/tcpip.rb#78
|
506
|
+
def update(client); end
|
507
|
+
|
508
|
+
private
|
509
|
+
|
510
|
+
# @return [TCPSocket]
|
511
|
+
#
|
512
|
+
# source://backport//lib/backport/server/tcpip.rb#89
|
513
|
+
def socket; end
|
514
|
+
|
515
|
+
# @return [void]
|
516
|
+
#
|
517
|
+
# source://backport//lib/backport/server/tcpip.rb#92
|
518
|
+
def start_accept_thread; end
|
519
|
+
end
|
6
520
|
|
7
|
-
#
|
8
|
-
|
521
|
+
# source://backport//lib/backport/version.rb#2
|
522
|
+
Backport::VERSION = T.let(T.unsafe(nil), String)
|