1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399
|
require 'concurrent' # TODO do not require whole concurrent gem
require 'concurrent/concern/deprecation'
require 'concurrent/edge/lock_free_stack'
# @note different name just not to collide for now
module Concurrent
module Edge
# Provides edge features, which will be added to or replace features in main gem.
#
# Contains new unified implementation of Futures and Promises which combines Features of previous `Future`,
# `Promise`, `IVar`, `Event`, `Probe`, `dataflow`, `Delay`, `TimerTask` into single framework. It uses extensively
# new synchronization layer to make all the paths lock-free with exception of blocking threads on `#wait`.
# It offers better performance and does not block threads (exception being #wait and similar methods where it's
# intended).
#
# ## Examples
# {include:file:examples/edge_futures.out.rb}
#
# @!macro edge_warning
module FutureShortcuts
# User is responsible for completing the event once by {Edge::CompletableEvent#complete}
# @return [CompletableEvent]
def event(default_executor = :io)
CompletableEventPromise.new(default_executor).future
end
# @overload future(default_executor = :io, &task)
# Constructs new Future which will be completed after block is evaluated on executor. Evaluation begins immediately.
# @return [Future]
# @overload future(default_executor = :io)
# User is responsible for completing the future once by {Edge::CompletableFuture#success} or {Edge::CompletableFuture#fail}
# @return [CompletableFuture]
def future(default_executor = :io, &task)
if task
ImmediateEventPromise.new(default_executor).future.then(&task)
else
CompletableFuturePromise.new(default_executor).future
end
end
# @return [Future] which is already completed
def completed_future(success, value, reason, default_executor = :io)
ImmediateFuturePromise.new(default_executor, success, value, reason).future
end
# @return [Future] which is already completed in success state with value
def succeeded_future(value, default_executor = :io)
completed_future true, value, nil, default_executor
end
# @return [Future] which is already completed in failed state with reason
def failed_future(reason, default_executor = :io)
completed_future false, nil, reason, default_executor
end
# @return [Event] which is already completed
def completed_event(default_executor = :io)
ImmediateEventPromise.new(default_executor).event
end
alias_method :async, :future
# Constructs new Future which will evaluate to the block after
# requested by calling `#wait`, `#value`, `#value!`, etc. on it or on any of the chained futures.
# @return [Future]
def delay(default_executor = :io, &task)
Delay.new(default_executor).future.then(&task)
end
# Schedules the block to be executed on executor in given intended_time.
# @param [Numeric, Time] intended_time Numeric => run in `intended_time` seconds. Time => eun on time.
# @return [Future]
def schedule(intended_time, default_executor = :io, &task)
ScheduledPromise.new(default_executor, intended_time).future.then(&task)
end
# Constructs new {Future} which is completed after all futures are complete. Its value is array
# of dependent future values. If there is an error it fails with the first one.
# @param [Event] futures
# @return [Future]
def zip(*futures)
ZipPromise.new(futures, :io).future
end
# Constructs new {Future} which is completed after first of the futures is complete.
# @param [Event] futures
# @return [Future]
def any(*futures)
AnyPromise.new(futures, :io).future
end
# only proof of concept
# @return [Future]
def select(*channels)
future do
Channel.select do |s|
channels.each do |ch|
s.take(ch) { |value| [value, ch] }
end
end
end
end
# post job on :fast executor
# @return [true, false]
def post!(*args, &job)
post_on(:fast, *args, &job)
end
# post job on :io executor
# @return [true, false]
def post(*args, &job)
post_on(:io, *args, &job)
end
# post job on executor
# @return [true, false]
def post_on(executor, *args, &job)
Concurrent.executor(executor).post(*args, &job)
end
# TODO add first(futures, count=count)
# TODO allow to to have a zip point for many futures and process them in batches by 10
end
extend FutureShortcuts
include FutureShortcuts
# Represents an event which will happen in future (will be completed). It has to always happen.
class Event < Synchronization::LockableObject
safe_initialization!
private(*attr_atomic(:internal_state))
public :internal_state
include Concern::Deprecation
include Concern::Logging
# @!visibility private
class State
def completed?
raise NotImplementedError
end
def to_sym
raise NotImplementedError
end
end
# @!visibility private
class Pending < State
def completed?
false
end
def to_sym
:pending
end
end
# @!visibility private
class Completed < State
def completed?
true
end
def to_sym
:completed
end
end
# @!visibility private
PENDING = Pending.new
# @!visibility private
COMPLETED = Completed.new
def initialize(promise, default_executor)
super()
@Promise = promise
@DefaultExecutor = default_executor
@Touched = AtomicBoolean.new(false)
@Callbacks = LockFreeStack.new
# TODO (pitr 12-Sep-2015): replace with AtomicFixnum, avoid aba problem
# TODO (pitr 12-Sep-2015): look at java.util.concurrent solution
@Waiters = LockFreeStack.new
self.internal_state = PENDING
end
# @return [:pending, :completed]
def state
internal_state.to_sym
end
# Is Event/Future pending?
# @return [Boolean]
def pending?(state = internal_state)
!state.completed?
end
def unscheduled?
raise 'unsupported'
end
alias_method :incomplete?, :pending?
# Has the Event been completed?
# @return [Boolean]
def completed?(state = internal_state)
state.completed?
end
alias_method :complete?, :completed?
# Wait until Event is #complete?
# @param [Numeric] timeout the maximum time in second to wait.
# @return [Event, true, false] self or true/false if timeout is used
# @!macro [attach] edge.periodical_wait
# @note a thread should wait only once! For repeated checking use faster `completed?` check.
# If thread waits periodically it will dangerously grow the waiters stack.
def wait(timeout = nil)
touch
result = wait_until_complete(timeout)
timeout ? result : self
end
# @!visibility private
def touch
# distribute touch to promise only once
@Promise.touch if @Touched.make_true
self
end
# @return [Executor] current default executor
# @see #with_default_executor
def default_executor
@DefaultExecutor
end
# @yield [success, value, reason] of the parent
def chain(executor = nil, &callback)
ChainPromise.new(self, @DefaultExecutor, executor || @DefaultExecutor, &callback).future
end
alias_method :then, :chain
def chain_completable(completable_event)
on_completion! { completable_event.complete_with COMPLETED }
end
alias_method :tangle, :chain_completable
# Zip with future producing new Future
# @return [Event]
def zip(other)
if other.is?(Future)
ZipFutureEventPromise.new(other, self, @DefaultExecutor).future
else
ZipEventEventPromise.new(self, other, @DefaultExecutor).future
end
end
alias_method :&, :zip
# Inserts delay into the chain of Futures making rest of it lazy evaluated.
# @return [Event]
def delay
ZipEventEventPromise.new(self, Delay.new(@DefaultExecutor).event, @DefaultExecutor).event
end
# # Schedules rest of the chain for execution with specified time or on specified time
# # @return [Event]
# def schedule(intended_time)
# chain do
# ZipEventEventPromise.new(self,
# ScheduledPromise.new(@DefaultExecutor, intended_time).event,
# @DefaultExecutor).event
# end.flat
# end
# Zips with selected value form the suplied channels
# @return [Future]
def then_select(*channels)
ZipFutureEventPromise(Concurrent.select(*channels), self, @DefaultExecutor).future
end
# @yield [success, value, reason] executed async on `executor` when completed
# @return self
def on_completion(executor = nil, &callback)
add_callback :pr_async_callback_on_completion, executor || @DefaultExecutor, callback
end
# @yield [success, value, reason] executed sync when completed
# @return self
def on_completion!(&callback)
add_callback :pr_callback_on_completion, callback
end
# Changes default executor for rest of the chain
# @return [Event]
def with_default_executor(executor)
EventWrapperPromise.new(self, executor).future
end
def to_s
"<##{self.class}:0x#{'%x' % (object_id << 1)} #{state.to_sym}>"
end
def inspect
"#{to_s[0..-2]} blocks:[#{blocks.map(&:to_s).join(', ')}]>"
end
def set(*args, &block)
raise 'Use CompletableEvent#complete or CompletableFuture#complete instead, ' +
'constructed by Concurrent.event or Concurrent.future respectively.'
end
# @!visibility private
def complete_with(state, raise_on_reassign = true)
if compare_and_set_internal_state(PENDING, state)
#(state)
# go to synchronized block only if there were waiting threads
synchronize { ns_broadcast } if @Waiters.clear
call_callbacks
else
Concurrent::MultipleAssignmentError.new('Event can be completed only once') if raise_on_reassign
return false
end
self
end
# @!visibility private
# just for inspection
# @return [Array<AbstractPromise>]
def blocks
@Callbacks.each_with_object([]) do |callback, promises|
promises.push(*(callback.select { |v| v.is_a? AbstractPromise }))
end
end
# @!visibility private
# just for inspection
def callbacks
@Callbacks.each.to_a
end
# @!visibility private
def add_callback(method, *args)
if completed?
call_callback method, *args
else
@Callbacks.push [method, *args]
call_callbacks if completed?
end
self
end
# @!visibility private
# only for inspection
def promise
@Promise
end
# @!visibility private
# only for inspection
def touched
@Touched.value
end
# @!visibility private
# only for debugging inspection
def waiting_threads
@Waiters.each.to_a
end
private
# @return [true, false]
def wait_until_complete(timeout)
while true
last_waiter = @Waiters.peek # waiters' state before completion
return true if completed?
# synchronize so it cannot be signaled before it waits
synchronize do
# ok only if completing thread did not start signaling
next unless @Waiters.compare_and_push last_waiter, Thread.current
return ns_wait_until(timeout) { completed? }
end
end
end
def pr_with_async(executor, *args, &block)
Concurrent.post_on(executor, *args, &block)
end
def pr_async_callback_on_completion(executor, callback)
pr_with_async(executor) { pr_callback_on_completion callback }
end
def pr_callback_on_completion(callback)
callback.call
end
def pr_callback_notify_blocked(promise)
promise.on_done self
end
def call_callback(method, *args)
self.send method, *args
end
def call_callbacks
method, *args = @Callbacks.pop
while method
call_callback method, *args
method, *args = @Callbacks.pop
end
end
end
# Represents a value which will become available in future. May fail with a reason instead.
class Future < Event
# @!visibility private
class CompletedWithResult < Completed
def result
[success?, value, reason]
end
def success?
raise NotImplementedError
end
def value
raise NotImplementedError
end
def reason
raise NotImplementedError
end
end
# @!visibility private
class Success < CompletedWithResult
def initialize(value)
@Value = value
end
def success?
true
end
def apply(block)
block.call value
end
def value
@Value
end
def reason
nil
end
def to_sym
:success
end
end
# @!visibility private
class SuccessArray < Success
def apply(block)
block.call(*value)
end
end
# @!visibility private
class Failed < CompletedWithResult
def initialize(reason)
@Reason = reason
end
def success?
false
end
def value
nil
end
def reason
@Reason
end
def to_sym
:failed
end
def apply(block)
block.call reason
end
end
# @!visibility private
class PartiallyFailed < CompletedWithResult
def initialize(value, reason)
@Value = value
@Reason = reason
super()
end
def success?
false
end
def to_sym
:failed
end
def value
@Value
end
def reason
@Reason
end
def apply(block)
block.call(*reason)
end
end
# @!method state
# @return [:pending, :success, :failed]
# Has Future been success?
# @return [Boolean]
def success?(state = internal_state)
state.completed? && state.success?
end
def fulfilled?
deprecated_method 'fulfilled?', 'success?'
success?
end
# Has Future been failed?
# @return [Boolean]
def failed?(state = internal_state)
state.completed? && !state.success?
end
def rejected?
deprecated_method 'rejected?', 'failed?'
failed?
end
# @return [Object, nil] the value of the Future when success, nil on timeout
# @!macro [attach] edge.timeout_nil
# @note If the Future can have value `nil` then it cannot be distinquished from `nil` returned on timeout.
# In this case is better to use first `wait` then `value` (or similar).
# @!macro edge.periodical_wait
def value(timeout = nil)
touch
internal_state.value if wait_until_complete timeout
end
# @return [Exception, nil] the reason of the Future's failure
# @!macro edge.timeout_nil
# @!macro edge.periodical_wait
def reason(timeout = nil)
touch
internal_state.reason if wait_until_complete timeout
end
# @return [Array(Boolean, Object, Exception), nil] triplet of success, value, reason
# @!macro edge.timeout_nil
# @!macro edge.periodical_wait
def result(timeout = nil)
touch
internal_state.result if wait_until_complete timeout
end
# Wait until Future is #complete?
# @param [Numeric] timeout the maximum time in second to wait.
# @raise reason on failure
# @return [Event, true, false] self or true/false if timeout is used
# @!macro edge.periodical_wait
def wait!(timeout = nil)
touch
result = wait_until_complete!(timeout)
timeout ? result : self
end
# Wait until Future is #complete?
# @param [Numeric] timeout the maximum time in second to wait.
# @raise reason on failure
# @return [Object, nil]
# @!macro edge.timeout_nil
# @!macro edge.periodical_wait
def value!(timeout = nil)
touch
internal_state.value if wait_until_complete! timeout
end
# @example allows failed Future to be risen
# raise Concurrent.future.fail
def exception(*args)
raise 'obligation is not failed' unless failed?
reason = internal_state.reason
if reason.is_a?(::Array)
reason.each { |e| log ERROR, 'Edge::Future', e }
Concurrent::Error.new 'multiple exceptions, inspect log'
else
reason.exception(*args)
end
end
# @yield [value] executed only on parent success
# @return [Future]
def then(executor = nil, &callback)
ThenPromise.new(self, @DefaultExecutor, executor || @DefaultExecutor, &callback).future
end
# Asks the actor with its value.
# @return [Future] new future with the response form the actor
def then_ask(actor)
self.then { |v| actor.ask(v) }.flat
end
def chain_completable(completable_future)
on_completion! { completable_future.complete_with internal_state }
end
alias_method :tangle, :chain_completable
# @yield [reason] executed only on parent failure
# @return [Future]
def rescue(executor = nil, &callback)
RescuePromise.new(self, @DefaultExecutor, executor || @DefaultExecutor, &callback).future
end
# zips with the Future in the value
# @example
# Concurrent.future { Concurrent.future { 1 } }.flat.vale # => 1
def flat(level = 1)
FlatPromise.new(self, level, @DefaultExecutor).future
end
# @return [Future] which has first completed value from futures
def any(*futures)
AnyPromise.new([self, *futures], @DefaultExecutor).future
end
# Inserts delay into the chain of Futures making rest of it lazy evaluated.
# @return [Future]
def delay
ZipFutureEventPromise.new(self, Delay.new(@DefaultExecutor).future, @DefaultExecutor).future
end
# Schedules rest of the chain for execution with specified time or on specified time
# @return [Future]
def schedule(intended_time)
chain do
ZipFutureEventPromise.new(self,
ScheduledPromise.new(@DefaultExecutor, intended_time).event,
@DefaultExecutor).future
end.flat
end
# Zips with selected value form the suplied channels
# @return [Future]
def then_select(*channels)
ZipPromise.new([self, Concurrent.select(*channels)], @DefaultExecutor).future
end
# Changes default executor for rest of the chain
# @return [Future]
def with_default_executor(executor)
FutureWrapperPromise.new(self, executor).future
end
# Zip with future producing new Future
# @return [Future]
def zip(other)
if other.is_a?(Future)
ZipFutureFuturePromise.new(self, other, @DefaultExecutor).future
else
ZipFutureEventPromise.new(self, other, @DefaultExecutor).future
end
end
alias_method :&, :zip
alias_method :|, :any
# @note may block
# @note only proof of concept
def then_put(channel)
on_success(:io) { |value| channel.put value }
end
# @yield [value] executed async on `executor` when success
# @return self
def on_success(executor = nil, &callback)
add_callback :pr_async_callback_on_success, executor || @DefaultExecutor, callback
end
# @yield [reason] executed async on `executor` when failed?
# @return self
def on_failure(executor = nil, &callback)
add_callback :pr_async_callback_on_failure, executor || @DefaultExecutor, callback
end
# @yield [value] executed sync when success
# @return self
def on_success!(&callback)
add_callback :pr_callback_on_success, callback
end
# @yield [reason] executed sync when failed?
# @return self
def on_failure!(&callback)
add_callback :pr_callback_on_failure, callback
end
# @!visibility private
def complete_with(state, raise_on_reassign = true)
if compare_and_set_internal_state(PENDING, state)
@Waiters.clear
synchronize { ns_broadcast }
call_callbacks state
else
if raise_on_reassign
log ERROR, 'Edge::Future', reason if reason # print otherwise hidden error
raise(Concurrent::MultipleAssignmentError.new(
"Future can be completed only once. Current result is #{result}, " +
"trying to set #{state.result}"))
end
return false
end
self
end
# @!visibility private
def add_callback(method, *args)
state = internal_state
if completed?(state)
call_callback method, state, *args
else
@Callbacks.push [method, *args]
state = internal_state
# take back if it was completed in the meanwhile
call_callbacks state if completed?(state)
end
self
end
# @!visibility private
def apply(block)
internal_state.apply block
end
private
def wait_until_complete!(timeout = nil)
result = wait_until_complete(timeout)
raise self if failed?
result
end
def call_callbacks(state)
method, *args = @Callbacks.pop
while method
call_callback method, state, *args
method, *args = @Callbacks.pop
end
end
def call_callback(method, state, *args)
self.send method, state, *args
end
def pr_async_callback_on_success(state, executor, callback)
pr_with_async(executor, state, callback) do |st, cb|
pr_callback_on_success st, cb
end
end
def pr_async_callback_on_failure(state, executor, callback)
pr_with_async(executor, state, callback) do |st, cb|
pr_callback_on_failure st, cb
end
end
def pr_callback_on_success(state, callback)
state.apply callback if state.success?
end
def pr_callback_on_failure(state, callback)
state.apply callback unless state.success?
end
def pr_callback_on_completion(state, callback)
callback.call state.result
end
def pr_callback_notify_blocked(state, promise)
super(promise)
end
def pr_async_callback_on_completion(state, executor, callback)
pr_with_async(executor, state, callback) do |st, cb|
pr_callback_on_completion st, cb
end
end
end
# A Event which can be completed by user.
class CompletableEvent < Event
# Complete the Event, `raise` if already completed
def complete(raise_on_reassign = true)
complete_with COMPLETED, raise_on_reassign
end
def hide_completable
EventWrapperPromise.new(self, @DefaultExecutor).event
end
end
# A Future which can be completed by user.
class CompletableFuture < Future
# Complete the future with triplet od `success`, `value`, `reason`
# `raise` if already completed
# return [self]
def complete(success, value, reason, raise_on_reassign = true)
complete_with(success ? Success.new(value) : Failed.new(reason), raise_on_reassign)
end
# Complete the future with value
# return [self]
def success(value)
promise.success(value)
end
# Try to complete the future with value
# return [self]
def try_success(value)
promise.try_success(value)
end
# Fail the future with reason
# return [self]
def fail(reason = StandardError.new)
promise.fail(reason)
end
# Try to fail the future with reason
# return [self]
def try_fail(reason = StandardError.new)
promise.try_fail(reason)
end
# Evaluate the future to value if there is an exception the future fails with it
# return [self]
def evaluate_to(*args, &block)
promise.evaluate_to(*args, block)
end
# Evaluate the future to value if there is an exception the future fails with it
# @raise the exception
# return [self]
def evaluate_to!(*args, &block)
promise.evaluate_to!(*args, block)
end
def hide_completable
FutureWrapperPromise.new(self, @DefaultExecutor).future
end
end
# @abstract
# @!visibility private
class AbstractPromise < Synchronization::Object
safe_initialization!
include Concern::Logging
def initialize(future)
super()
@Future = future
end
def future
@Future
end
alias_method :event, :future
def default_executor
future.default_executor
end
def state
future.state
end
def touch
end
def to_s
"<##{self.class}:0x#{'%x' % (object_id << 1)} #{state}>"
end
def inspect
to_s
end
private
def complete_with(new_state, raise_on_reassign = true)
@Future.complete_with(new_state, raise_on_reassign)
end
# @return [Future]
def evaluate_to(*args, block)
complete_with Future::Success.new(block.call(*args))
rescue StandardError => error
complete_with Future::Failed.new(error)
rescue Exception => error
log(ERROR, 'Edge::Future', error)
complete_with Future::Failed.new(error)
end
end
# @!visibility private
class CompletableEventPromise < AbstractPromise
def initialize(default_executor)
super CompletableEvent.new(self, default_executor)
end
end
# @!visibility private
class CompletableFuturePromise < AbstractPromise
def initialize(default_executor)
super CompletableFuture.new(self, default_executor)
end
# Set the `Future` to a value and wake or notify all threads waiting on it.
#
# @param [Object] value the value to store in the `Future`
# @raise [Concurrent::MultipleAssignmentError] if the `Future` has already been set or otherwise completed
# @return [Future]
def success(value)
complete_with Future::Success.new(value)
end
def try_success(value)
!!complete_with(Future::Success.new(value), false)
end
# Set the `Future` to failed due to some error and wake or notify all threads waiting on it.
#
# @param [Object] reason for the failure
# @raise [Concurrent::MultipleAssignmentError] if the `Future` has already been set or otherwise completed
# @return [Future]
def fail(reason = StandardError.new)
complete_with Future::Failed.new(reason)
end
def try_fail(reason = StandardError.new)
!!complete_with(Future::Failed.new(reason), false)
end
public :evaluate_to
# @return [Future]
def evaluate_to!(*args, block)
evaluate_to(*args, block).wait!
end
end
# @abstract
# @!visibility private
class InnerPromise < AbstractPromise
end
# @abstract
# @!visibility private
class BlockedPromise < InnerPromise
def initialize(future, blocked_by_futures, countdown)
initialize_blocked_by(blocked_by_futures)
@Countdown = AtomicFixnum.new countdown
super(future)
@BlockedBy.each { |f| f.add_callback :pr_callback_notify_blocked, self }
end
# @api private
def on_done(future)
countdown = process_on_done(future)
completable = completable?(countdown)
if completable
on_completable(future)
# futures could be deleted from blocked_by one by one here, but that would be too expensive,
# it's done once when all are done to free the reference
clear_blocked_by!
end
end
def touch
blocked_by.each(&:touch)
end
# !visibility private
# for inspection only
def blocked_by
@BlockedBy
end
def inspect
"#{to_s[0..-2]} blocked_by:[#{ blocked_by.map(&:to_s).join(', ')}]>"
end
private
def initialize_blocked_by(blocked_by_futures)
@BlockedBy = [blocked_by_futures].flatten
end
def clear_blocked_by!
# not synchronized because we do not care when this change propagates
@BlockedBy = []
nil
end
# @return [true,false] if completable
def completable?(countdown)
countdown.zero?
end
def process_on_done(future)
@Countdown.decrement
end
def on_completable(done_future)
raise NotImplementedError
end
end
# @abstract
# @!visibility private
class BlockedTaskPromise < BlockedPromise
def initialize(blocked_by_future, default_executor, executor, &task)
raise ArgumentError, 'no block given' unless block_given?
@Executor = executor
@Task = task
super Future.new(self, default_executor), blocked_by_future, 1
end
def executor
@Executor
end
end
# @!visibility private
class ThenPromise < BlockedTaskPromise
private
def initialize(blocked_by_future, default_executor, executor, &task)
raise ArgumentError, 'only Future can be appended with then' unless blocked_by_future.is_a? Future
super blocked_by_future, default_executor, executor, &task
end
def on_completable(done_future)
if done_future.success?
Concurrent.post_on(@Executor, done_future, @Task) do |future, task|
evaluate_to lambda { future.apply task }
end
else
complete_with done_future.internal_state
end
end
end
# @!visibility private
class RescuePromise < BlockedTaskPromise
private
def initialize(blocked_by_future, default_executor, executor, &task)
super blocked_by_future, default_executor, executor, &task
end
def on_completable(done_future)
if done_future.failed?
Concurrent.post_on(@Executor, done_future, @Task) do |future, task|
evaluate_to lambda { future.apply task }
end
else
complete_with done_future.internal_state
end
end
end
# @!visibility private
class ChainPromise < BlockedTaskPromise
private
def on_completable(done_future)
if Future === done_future
Concurrent.post_on(@Executor, done_future, @Task) { |future, task| evaluate_to(*future.result, task) }
else
Concurrent.post_on(@Executor, @Task) { |task| evaluate_to task }
end
end
end
# will be immediately completed
# @!visibility private
class ImmediateEventPromise < InnerPromise
def initialize(default_executor)
super Event.new(self, default_executor).complete_with(Event::COMPLETED)
end
end
# @!visibility private
class ImmediateFuturePromise < InnerPromise
def initialize(default_executor, success, value, reason)
super Future.new(self, default_executor).
complete_with(success ? Future::Success.new(value) : Future::Failed.new(reason))
end
end
# @!visibility private
class FlatPromise < BlockedPromise
# !visibility private
def blocked_by
@BlockedBy.each.to_a
end
private
def process_on_done(future)
countdown = super(future)
if countdown.nonzero?
internal_state = future.internal_state
unless internal_state.success?
complete_with internal_state
return countdown
end
value = internal_state.value
case value
when Future
@BlockedBy.push value
value.add_callback :pr_callback_notify_blocked, self
@Countdown.value
when Event
evaluate_to(lambda { raise TypeError, 'cannot flatten to Event' })
else
evaluate_to(lambda { raise TypeError, "returned value #{value.inspect} is not a Future" })
end
end
countdown
end
def initialize(blocked_by_future, levels, default_executor)
raise ArgumentError, 'levels has to be higher than 0' if levels < 1
super Future.new(self, default_executor), blocked_by_future, 1 + levels
end
def initialize_blocked_by(blocked_by_future)
@BlockedBy = LockFreeStack.new.push(blocked_by_future)
end
def on_completable(done_future)
complete_with done_future.internal_state
end
def clear_blocked_by!
@BlockedBy.clear
nil
end
def completable?(countdown)
!@Future.internal_state.completed? && super(countdown)
end
end
# @!visibility private
class ZipEventEventPromise < BlockedPromise
def initialize(event1, event2, default_executor)
super Event.new(self, default_executor), [event1, event2], 2
end
def on_completable(done_future)
complete_with Event::COMPLETED
end
end
# @!visibility private
class ZipFutureEventPromise < BlockedPromise
def initialize(future, event, default_executor)
@FutureResult = future
super Future.new(self, default_executor), [future, event], 2
end
def on_completable(done_future)
complete_with @FutureResult.internal_state
end
end
# @!visibility private
class ZipFutureFuturePromise < BlockedPromise
def initialize(future1, future2, default_executor)
@Future1Result = future1
@Future2Result = future2
super Future.new(self, default_executor), [future1, future2], 2
end
def on_completable(done_future)
success1, value1, reason1 = @Future1Result.result
success2, value2, reason2 = @Future2Result.result
success = success1 && success2
new_state = if success
Future::SuccessArray.new([value1, value2])
else
Future::PartiallyFailed.new([value1, value2], [reason1, reason2])
end
complete_with new_state
end
end
# @!visibility private
class EventWrapperPromise < BlockedPromise
def initialize(event, default_executor)
super Event.new(self, default_executor), event, 1
end
def on_completable(done_future)
complete_with Event::COMPLETED
end
end
# @!visibility private
class FutureWrapperPromise < BlockedPromise
def initialize(future, default_executor)
super Future.new(self, default_executor), future, 1
end
def on_completable(done_future)
complete_with done_future.internal_state
end
end
# @!visibility private
class ZipPromise < BlockedPromise
private
def initialize(blocked_by_futures, default_executor)
klass = Event
blocked_by_futures.each do |f|
if f.is_a?(Future)
if klass == Event
klass = Future
break
end
end
end
# noinspection RubyArgCount
super(klass.new(self, default_executor), blocked_by_futures, blocked_by_futures.size)
if blocked_by_futures.empty?
on_completable nil
end
end
def on_completable(done_future)
all_success = true
values = []
reasons = []
blocked_by.each do |future|
next unless future.is_a?(Future)
success, value, reason = future.result
unless success
all_success = false
end
values << value
reasons << reason
end
if all_success
if values.empty?
complete_with Event::COMPLETED
else
if values.size == 1
complete_with Future::Success.new(values.first)
else
complete_with Future::SuccessArray.new(values)
end
end
else
complete_with Future::PartiallyFailed.new(values, reasons)
end
end
end
# @!visibility private
class AnyPromise < BlockedPromise
private
def initialize(blocked_by_futures, default_executor)
blocked_by_futures.all? { |f| f.is_a? Future } or
raise ArgumentError, 'accepts only Futures not Events'
super(Future.new(self, default_executor), blocked_by_futures, blocked_by_futures.size)
end
def completable?(countdown)
true
end
def on_completable(done_future)
complete_with done_future.internal_state, false
end
end
# @!visibility private
class Delay < InnerPromise
def touch
@Future.complete_with Event::COMPLETED
end
private
def initialize(default_executor)
super Event.new(self, default_executor)
end
end
# @!visibility private
class DelayValue < InnerPromise
def touch
@Future.complete_with Future::Success.new(@Value)
end
private
def initialize(default_executor, value)
@Value = value
super Future.new(self, default_executor)
end
end
# will be evaluated to task in intended_time
# @!visibility private
class ScheduledPromise < InnerPromise
def intended_time
@IntendedTime
end
def inspect
"#{to_s[0..-2]} intended_time:[#{@IntendedTime}}>"
end
private
def initialize(default_executor, intended_time)
@IntendedTime = intended_time
in_seconds = begin
now = Time.now
schedule_time = if @IntendedTime.is_a? Time
@IntendedTime
else
now + @IntendedTime
end
[0, schedule_time.to_f - now.to_f].max
end
super Event.new(self, default_executor)
Concurrent.global_timer_set.post(in_seconds) do
@Future.complete_with Event::COMPLETED
end
end
end
end
extend Edge::FutureShortcuts
include Edge::FutureShortcuts
end
|