actory 0.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +4 -0
- data/Gemfile +6 -0
- data/LICENSE +202 -0
- data/README.md +361 -0
- data/actory.gemspec +25 -0
- data/bin/actory-receiver +22 -0
- data/config/global.yml +2 -0
- data/config/receiver.yml.example +8 -0
- data/config/sender.yml.example +14 -0
- data/example/fibonacci.rb +28 -0
- data/example/fibonacci_parallel_in_processes.rb +39 -0
- data/example/fibonacci_parallel_in_threads.rb +39 -0
- data/example/fibonacci_single.rb +39 -0
- data/example/lib/benchmark.rb +11 -0
- data/example/pi.rb +28 -0
- data/example/pi_parallel_in_processes.rb +39 -0
- data/example/pi_parallel_in_threads.rb +39 -0
- data/example/pi_single.rb +39 -0
- data/example/prime.rb +28 -0
- data/example/prime_parallel_in_processes.rb +39 -0
- data/example/prime_parallel_in_threads.rb +39 -0
- data/example/prime_single.rb +39 -0
- data/lib/actory.rb +66 -0
- data/lib/actory/error.rb +7 -0
- data/lib/actory/errors/generator.rb +13 -0
- data/lib/actory/receiver.rb +17 -0
- data/lib/actory/receiver/event_handler.rb +17 -0
- data/lib/actory/receiver/plugin/auth.rb +15 -0
- data/lib/actory/receiver/plugin/example_fibonacci.rb +17 -0
- data/lib/actory/receiver/plugin/example_pi.rb +20 -0
- data/lib/actory/receiver/plugin/example_prime.rb +18 -0
- data/lib/actory/receiver/plugin/processor_count.rb +15 -0
- data/lib/actory/receiver/plugin/reload.rb +16 -0
- data/lib/actory/receiver/plugin/system_info.rb +31 -0
- data/lib/actory/receiver/worker.rb +43 -0
- data/lib/actory/sender.rb +14 -0
- data/lib/actory/sender/dispatcher.rb +172 -0
- data/log/.keep +0 -0
- metadata +195 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: f849624dcbf73cd2426caf250797b3c337004180
|
4
|
+
data.tar.gz: 6dd0edf66c46fc3e2d918b9a2c7b777c24e6aae0
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 0417891112886283844180fcf39a4813b0de016a175501e509c07522eda80de1fbb5b054d171a5485db725eb674bafd5d87229747aa11b3521752b9eb63505ba
|
7
|
+
data.tar.gz: 981b151264135f1094bc622b7f28e0103fd17fbebb8bdf6a2731e2a4bb8691f9be949fe47d3183cabb6bb1d6cfa520a736d42f48ac989cdb5a1f758be11eec7c
|
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright {yyyy} {name of copyright owner}
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
202
|
+
|
data/README.md
ADDED
@@ -0,0 +1,361 @@
|
|
1
|
+
actory
|
2
|
+
======
|
3
|
+
|
4
|
+
Actor model like, concurrent and distributed framework for Ruby.
|
5
|
+
|
6
|
+
## Installation
|
7
|
+
|
8
|
+
`````
|
9
|
+
gem install actory
|
10
|
+
`````
|
11
|
+
|
12
|
+
## Setup
|
13
|
+
|
14
|
+
`````
|
15
|
+
path_to_actory="/PATH/TO/GEMS/actory-0.0.1"
|
16
|
+
export PATH=$PATH:$path_to_actory/bin
|
17
|
+
`````
|
18
|
+
|
19
|
+
* /PATH/TO/GEMS above means the path to the directory of gem files. e.g. $HOME/.rvm/gems/ruby-2.0.0-p247@global/gems
|
20
|
+
|
21
|
+
### System-wide setup with the root permission
|
22
|
+
|
23
|
+
`````
|
24
|
+
sudo mkdir -p /etc/actory
|
25
|
+
sudo cp -p $path_to_actory/config/receiver.yml.example /etc/actory
|
26
|
+
sudo cp -p $path_to_actory/config/sender.yml.example /etc/actory
|
27
|
+
`````
|
28
|
+
|
29
|
+
### System-wide setup under the RubyGems
|
30
|
+
|
31
|
+
`````
|
32
|
+
cd $path_to_actory/config
|
33
|
+
cp receiver.yml.example receiver.yml
|
34
|
+
cp sender.yml.example sender.yml
|
35
|
+
sed -i '' "s/\/etc\/actory/\.\.\/\.\.\/\.\.\/config/g" global.yml
|
36
|
+
`````
|
37
|
+
|
38
|
+
### Setup inside of each indivisual project
|
39
|
+
|
40
|
+
`````
|
41
|
+
echo "gem actory" >> Gemfile
|
42
|
+
bundle install --path vendor/bundle
|
43
|
+
cp ./vendor/bundle
|
44
|
+
path_to_actory="vendor/bundle/ruby/2.0.0/gems/actory-0.0.1"
|
45
|
+
cp $path_to_actory/config/receiver.yml.example $path_to_actory/config/receiver.yml
|
46
|
+
cp $path_to_actory/config/sender.yml.example $path_to_actory/config/sender.yml
|
47
|
+
sed -i '' "s/\/etc\/actory/\.\.\/\.\.\/\.\.\/config/g" $path_to_actory/config/global.yml
|
48
|
+
`````
|
49
|
+
|
50
|
+
|
51
|
+
## Architecture
|
52
|
+
|
53
|
+
* Actor model like message passing API
|
54
|
+
* Dynamically loaded plugins
|
55
|
+
* High concurrency
|
56
|
+
* Low overheads
|
57
|
+
|
58
|
+
### System-wide
|
59
|
+
|
60
|
+
#### Sending a message to each receiver to make it deal with the message.
|
61
|
+
|
62
|
+
`````
|
63
|
+
+--------+
|
64
|
+
|user app|
|
65
|
+
+--------+
|
66
|
+
| message(method, [args]) # [args].size # => i
|
67
|
+
v
|
68
|
+
+------------------+
|
69
|
+
|Sender::Dispatcher|
|
70
|
+
+------------------+
|
71
|
+
| execute
|
72
|
+
| +----------------+ msgpack-rpc +----------------------+ method(arg[0]) +----------------+
|
73
|
+
+-->|sub-process #1/n|------------>|Receiver::EventHandler|--------------->|Receiver::Plugin|
|
74
|
+
| +----------------+ +----------------------+ execute +----------------+
|
75
|
+
| +----------------+ +----------------------+ method(arg[1]) +----------------+
|
76
|
+
+-->|sub-process #2/n|------------>|Receiver::EventHandler|--------------->|Receiver::Plugin|
|
77
|
+
| +----------------+ +----------------------+ : +----------------+
|
78
|
+
| : : execute :
|
79
|
+
| +----------------+ +----------------------+ method(arg[i]) +----------------+
|
80
|
+
`-->|sub-process #n/n|------------>|Receiver::EventHandler|--------------->|Receiver::Plugin|
|
81
|
+
+----------------+ +----------------------+ +----------------+
|
82
|
+
`````
|
83
|
+
|
84
|
+
#### Receiving each returned value at once.
|
85
|
+
|
86
|
+
`````
|
87
|
+
+--------+
|
88
|
+
|user app|
|
89
|
+
+--------+
|
90
|
+
^ a hash value in {"host:port" => [return_value(s), ...], ... }
|
91
|
+
|
|
92
|
+
+------------------+
|
93
|
+
|Sender::Dispatcher|
|
94
|
+
+------------------+
|
95
|
+
^ return
|
96
|
+
| +----------------+ msgpack-rpc +----------------------+ value(s) +----------------+
|
97
|
+
+---|sub-process #1/n|<------------|Receiver::EventHandler|<-------------|Receiver::Plugin|
|
98
|
+
| +----------------+ +----------------------+ +----------------+
|
99
|
+
| +----------------+ +----------------------+ +----------------+
|
100
|
+
+---|sub-process #2/n|<------------|Receiver::EventHandler|<-------------|Receiver::Plugin|
|
101
|
+
| +----------------+ +----------------------+ +----------------+
|
102
|
+
| : : :
|
103
|
+
| +----------------+ +----------------------+ +----------------+
|
104
|
+
`---|sub-process #n/n|<------------|Receiver::EventHandler|<-------------|Receiver::Plugin|
|
105
|
+
+----------------+ +----------------------+ +----------------+
|
106
|
+
`````
|
107
|
+
|
108
|
+
#### Jobs can be assigned flexibly.
|
109
|
+
|
110
|
+
`````
|
111
|
+
+--------+
|
112
|
+
|user app|
|
113
|
+
+--------+
|
114
|
+
| message(method, [args]) # [args].size # => i; i > n # => true
|
115
|
+
v
|
116
|
+
+------------------+
|
117
|
+
|Sender::Dispatcher|
|
118
|
+
+------------------+
|
119
|
+
| execute
|
120
|
+
| +----------------+ msgpack-rpc +----------------------+ method(arg[0]) +----------------+
|
121
|
+
+-->|sub-process #1/n|------------>|Receiver::EventHandler|----------------->|Receiver::Plugin|
|
122
|
+
| | | +----------------------+ execute +----------------+
|
123
|
+
| | | +----------------------+ method(arg[i]) +----------------+
|
124
|
+
+-->| |------------>|Receiver::EventHandler|----------------->|Receiver::Plugin|
|
125
|
+
| +----------------+ +----------------------+ execute +----------------+
|
126
|
+
| +----------------+ +----------------------+ method(arg[1]) +----------------+
|
127
|
+
+-->|sub-process #2/n|------------>|Receiver::EventHandler|----------------->|Receiver::Plugin|
|
128
|
+
| +----------------+ +----------------------+ : +----------------+
|
129
|
+
| : : execute :
|
130
|
+
| +----------------+ +----------------------+ method(arg[i-1]) +----------------+
|
131
|
+
`-->|sub-process #n/n|------------>|Receiver::EventHandler|----------------->|Receiver::Plugin|
|
132
|
+
+----------------+ +----------------------+ +----------------+
|
133
|
+
`````
|
134
|
+
|
135
|
+
`````
|
136
|
+
+--------+
|
137
|
+
|user app|
|
138
|
+
+--------+
|
139
|
+
| message(method, [args]) # [args].size # => i; n > i # => true
|
140
|
+
v
|
141
|
+
+------------------+
|
142
|
+
|Sender::Dispatcher|
|
143
|
+
+------------------+
|
144
|
+
| execute
|
145
|
+
| +----------------+ msgpack-rpc +----------------------+ method(arg[0]) +----------------+
|
146
|
+
+-->|sub-process #1/n|------------>|Receiver::EventHandler|--------------->|Receiver::Plugin|
|
147
|
+
| +----------------+ +----------------------+ execute +----------------+
|
148
|
+
| +----------------+ +----------------------+ method(arg[i]) +----------------+
|
149
|
+
`-->|sub-process #2/n|------------>|Receiver::EventHandler|--------------->|Receiver::Plugin|
|
150
|
+
+----------------+ +----------------------+ +----------------+
|
151
|
+
: : :
|
152
|
+
+----------------+ +----------------------+ +----------------+
|
153
|
+
|sub-process #n/n| |Receiver::EventHandler| |Receiver::Plugin|
|
154
|
+
+----------------+ +----------------------+ +----------------+
|
155
|
+
`````
|
156
|
+
|
157
|
+
`````
|
158
|
+
+--------+
|
159
|
+
|user app|
|
160
|
+
+--------+
|
161
|
+
| message(method, [args]) # [args].size # => 1
|
162
|
+
v
|
163
|
+
+------------------+
|
164
|
+
|Sender::Dispatcher|
|
165
|
+
+------------------+
|
166
|
+
| execute
|
167
|
+
| +----------------+ msgpack-rpc +----------------------+ method(arg[0]) +----------------+
|
168
|
+
`-->|sub-process #1/n|------------>|Receiver::EventHandler|--------------->|Receiver::Plugin|
|
169
|
+
+----------------+ +----------------------+ +----------------+
|
170
|
+
+----------------+ +----------------------+ +----------------+
|
171
|
+
|sub-process #2/n| |Receiver::EventHandler| |Receiver::Plugin|
|
172
|
+
+----------------+ +----------------------+ +----------------+
|
173
|
+
: : :
|
174
|
+
+----------------+ +----------------------+ +----------------+
|
175
|
+
|sub-process #n/n| |Receiver::EventHandler| |Receiver::Plugin|
|
176
|
+
+----------------+ +----------------------+ +----------------+
|
177
|
+
`````
|
178
|
+
|
179
|
+
### Receiver
|
180
|
+
|
181
|
+
`````
|
182
|
+
+--------------------------------------------------------------------------+
|
183
|
+
| a receiver |
|
184
|
+
| |
|
185
|
+
| +--------+ |
|
186
|
+
| | Worker | |
|
187
|
+
| +--------+ |
|
188
|
+
| | +-------------+ |
|
189
|
+
| | spawn when started | CPU | |
|
190
|
+
| | +-------------------------+ | +---------+ | +-----------------+ |
|
191
|
+
| +-->|Msgpack::RPC::Server #1/n|-->| |core #1/n|--->|EventHandler #1/n| |
|
192
|
+
| | +-------------------------+ | +---------+ | +-----------------+ |
|
193
|
+
| | +-------------------------+ | +---------+ | +-----------------+ |
|
194
|
+
| +-->|Msgpack::RPC::Server #2/n|-->| |core #2/n|--->|EventHandler #2/n| |
|
195
|
+
| | +-------------------------+ | +---------+ | +-----------------+ |
|
196
|
+
| | : | : | : |
|
197
|
+
| | +-------------------------+ | +---------+ | +-----------------+ |
|
198
|
+
| `-->|Magpack::RPC::Server #n/n|-->| |core #n/n|--->|EventHandler #n/n| |
|
199
|
+
| +-------------------------+ | +---------+ | +-----------------+ |
|
200
|
+
| | | |
|
201
|
+
| +-------------+ |
|
202
|
+
| |
|
203
|
+
+--------------------------------------------------------------------------+
|
204
|
+
`````
|
205
|
+
|
206
|
+
### Sender
|
207
|
+
|
208
|
+
`````
|
209
|
+
+-----------------------------------------------------+ +-----------------------------+
|
210
|
+
| a sender | | receiver(s) |
|
211
|
+
| | | |
|
212
|
+
| +------------+ | | |
|
213
|
+
| | Dispatcher | | | |
|
214
|
+
| +------------+ | | |
|
215
|
+
| | +-------------+ | | |
|
216
|
+
| | spawn when instantized | CPU | | | |
|
217
|
+
| | +-------------------------+ | +---------+ | | | +-------------------------+ |
|
218
|
+
| +-->|Msgpack::RPC::Client #1/n|-->| |core #1/n|------->|Msgpack::RPC::Server #1/m| |
|
219
|
+
| | +-------------------------+ | +---------+ | | | +-------------------------+ |
|
220
|
+
| | +-------------------------+ | +---------+ | | | +-------------------------+ |
|
221
|
+
| +-->|Msgpack::RPC::Client #2/n|-->| |core #2/n|------->|Msgpack::RPC::Server #2/m| |
|
222
|
+
| | +-------------------------+ | +---------+ | | | +-------------------------+ |
|
223
|
+
| | : | : | | | : |
|
224
|
+
| | +-------------------------+ | +---------+ | | | +-------------------------+ |
|
225
|
+
| `-->|Magpack::RPC::Client #n/n|-->| |core #n/n|------->|Msgpack::RPC::Server #m/m| |
|
226
|
+
| +-------------------------+ | +---------+ | | | +-------------------------+ |
|
227
|
+
| | | | | |
|
228
|
+
| +-------------+ | | |
|
229
|
+
| | | |
|
230
|
+
+-----------------------------------------------------+ +-----------------------------+
|
231
|
+
`````
|
232
|
+
|
233
|
+
## Configuration
|
234
|
+
|
235
|
+
### config/receiver.yml
|
236
|
+
|
237
|
+
* protocol
|
238
|
+
* "tcp" or "udp"
|
239
|
+
* address
|
240
|
+
* Binding IP Address.
|
241
|
+
* port
|
242
|
+
* Port number to begin increment.
|
243
|
+
* shared_key
|
244
|
+
* A pre-shared key string to establish connections with a sender.
|
245
|
+
* log
|
246
|
+
* type
|
247
|
+
* The type of the log. "stdout", "file" or "both".
|
248
|
+
* level
|
249
|
+
* A log level. "fatal", "error", "warn", "info" or "debug".
|
250
|
+
* target
|
251
|
+
* The log file path, used when the "type" is specified as "file" or "both".
|
252
|
+
|
253
|
+
### config/sender.yml
|
254
|
+
|
255
|
+
* actors
|
256
|
+
* A list of actors. The format is "host_name_or_ip_address:port".
|
257
|
+
* policy
|
258
|
+
* The policy to select actors and assign a message to them. "even", "random" or "safe-random".
|
259
|
+
* timeout
|
260
|
+
* Connection timeout value for msgpack-rpc.
|
261
|
+
* get_interval
|
262
|
+
* An interval to retry the get method for msgpack-rpc.
|
263
|
+
* auth
|
264
|
+
* shared_key
|
265
|
+
* A pre-shared key string to establish connections with each receiver.
|
266
|
+
* timeout
|
267
|
+
* Authentication timeout with each receiver.
|
268
|
+
* show_progress
|
269
|
+
* If it is true, the sender shows you a progress bar.
|
270
|
+
* reload_receiver_plugins
|
271
|
+
* If it is true, the sender force each receiver reload plugins even in running.
|
272
|
+
* log
|
273
|
+
* type
|
274
|
+
* The type of the log. "stdout", "file" or "both".
|
275
|
+
* level
|
276
|
+
* A log level. "fatal", "error", "warn", "info" or "debug".
|
277
|
+
* target
|
278
|
+
* The log file path, used when the "type" is specified as "file" or "both".
|
279
|
+
|
280
|
+
## Usage
|
281
|
+
|
282
|
+
### Receiver
|
283
|
+
|
284
|
+
#### Foreground
|
285
|
+
|
286
|
+
`````
|
287
|
+
actory-receiver
|
288
|
+
`````
|
289
|
+
|
290
|
+
#### Background
|
291
|
+
|
292
|
+
`````
|
293
|
+
actory-receiver -d
|
294
|
+
`````
|
295
|
+
|
296
|
+
### Sender
|
297
|
+
|
298
|
+
`````ruby
|
299
|
+
require 'actory'
|
300
|
+
dispacher = Actory::Sender::Dispatcher.new
|
301
|
+
res = dispatcher.message(METHOD, ARGS)
|
302
|
+
`````
|
303
|
+
|
304
|
+
You can specify an actor or actors with an argument with actors keyword.
|
305
|
+
|
306
|
+
`````ruby
|
307
|
+
require 'actory'
|
308
|
+
dispacher = Actory::Sender::Dispatcher.new(actors: ["localhost:18800"])
|
309
|
+
res = dispatcher.message(METHOD, ARGS)
|
310
|
+
`````
|
311
|
+
|
312
|
+
`````ruby
|
313
|
+
require 'actory'
|
314
|
+
actors = ["192.168.1.1:18800", "192.168.1.2:18800", "192.168.1.3:18800"]
|
315
|
+
dispacher = Actory::Sender::Dispatcher.new(actors: actors)
|
316
|
+
res = dispatcher.message(METHOD, ARGS)
|
317
|
+
`````
|
318
|
+
|
319
|
+
## Plugin
|
320
|
+
|
321
|
+
You can create your own plugin(s) to be executed by the receiver.
|
322
|
+
|
323
|
+
`````ruby
|
324
|
+
module Actory
|
325
|
+
module Receiver
|
326
|
+
|
327
|
+
class Plugin < Base
|
328
|
+
|
329
|
+
def hello(arg)
|
330
|
+
return "Hello #{arg}."
|
331
|
+
rescue => e
|
332
|
+
msg = Actory::Errors::Generator.new.json(level: "ERROR", message: e.message, backtrace: $@)
|
333
|
+
raise StandardError, msg
|
334
|
+
end
|
335
|
+
|
336
|
+
end
|
337
|
+
|
338
|
+
end
|
339
|
+
end
|
340
|
+
`````
|
341
|
+
|
342
|
+
If you have created a plugin, put it just under the lib/actory/receiver/plugin directory. Then it will be automatically loaded even in the receiver running.
|
343
|
+
|
344
|
+
And then, you can call the method from a sender like following:
|
345
|
+
|
346
|
+
`````ruby
|
347
|
+
require 'actory'
|
348
|
+
dispacher = Actory::Sender::Dispatcher.new
|
349
|
+
res = dispatcher.message("hello", ["world", "actory"])
|
350
|
+
`````
|
351
|
+
|
352
|
+
The response in a hash will be like following:
|
353
|
+
|
354
|
+
`````ruby
|
355
|
+
p res
|
356
|
+
{"127.0.0.1:18800"=>["Hello world."], "192.168.1.1:18800"=>["Hello actory."]}
|
357
|
+
`````
|
358
|
+
|
359
|
+
## License
|
360
|
+
|
361
|
+
Apache License, Version 2.0
|