/usr/share/perl5/POE/Component/Client/Ping.pm is in libpoe-component-client-ping-perl 1.171-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | # License and documentation are after __END__.
# vim: ts=2 sw=2 expandtab
package POE::Component::Client::Ping;
use warnings;
use strict;
use Exporter;
use vars qw(@ISA @EXPORT_OK %EXPORT_TAGS);
@ISA = qw(Exporter);
@EXPORT_OK = qw(
REQ_ADDRESS REQ_TIMEOUT REQ_TIME REQ_USER_ARGS
RES_ADDRESS RES_ROUNDTRIP RES_TIME RES_TTL
);
%EXPORT_TAGS = (
const => [
qw(
REQ_ADDRESS REQ_TIMEOUT REQ_TIME REQ_USER_ARGS
RES_ADDRESS RES_ROUNDTRIP RES_TIME RES_TTL
)
]
);
use vars qw($VERSION $PKTSIZE);
$VERSION = '1.171';
$PKTSIZE = $^O eq 'linux' ? 3_000 : 100;
use Carp qw(croak);
use Symbol qw(gensym);
use Socket;
use Time::HiRes qw(time);
use POE::Session;
sub DEBUG () { 0 } # Enable more information.
sub DEBUG_SOCKET () { 0 } # Watch the socket open and close.
sub DEBUG_PBS () { 0 } # Watch ping_by_seq management.
# ping_by_seq structure offsets.
sub PBS_POSTBACK () { 0 };
sub PBS_SESSION () { 1 };
sub PBS_ADDRESS () { 2 };
sub PBS_REQUEST_TIME () { 3 };
# request_packet offsets
sub REQ_ADDRESS () { 0 };
sub REQ_TIMEOUT () { 1 };
sub REQ_TIME () { 2 };
sub REQ_USER_ARGS () { 3 };
# response_packet offsets
sub RES_ADDRESS () { 0 };
sub RES_ROUNDTRIP () { 1 };
sub RES_TIME () { 2 };
sub RES_TTL () { 3 };
# ICMP echo constants. Types, structures, and fields. Cribbed
# mercilessly from Net::Ping.
sub ICMP_ECHOREPLY () { 0 }
sub ICMP_ECHO () { 8 }
sub ICMP_STRUCT () { 'C2 S3 A' }
sub ICMP_SUBCODE () { 0 }
sub ICMP_FLAGS () { 0 }
sub ICMP_PORT () { 0 }
# "Static" variables which will be shared across multiple instances.
my $master_seq = 0;
# Spawn a new PoCo::Client::Ping session. This basically is a
# constructor, but it isn't named "new" because it doesn't create a
# usable object. Instead, it spawns the object off as a session.
# Randal Schwartz gave me heck about calling spawny things "new", so I
# blame him for this naming convention.
sub spawn {
my $type = shift;
croak "$type requires an even number of parameters" if @_ % 2;
my %params = @_;
# If we aren't given a socket, then we'll need privileges to create
# one ourselves.
croak "$type requires root privilege" if (
$> and ($^O ne "VMS") and
($^O ne "cygwin") and
not defined $params{Socket}
);
my $alias = delete $params{Alias};
$alias = "pinger" unless defined $alias and length $alias;
my $timeout = delete $params{Timeout};
$timeout = 1 unless defined $timeout and $timeout >= 0;
my $onereply = delete $params{OneReply};
my $socket = delete $params{Socket};
my $parallelism = delete $params{Parallelism} || -1;
my $rcvbuf = delete $params{BufferSize};
my $always_decode = delete $params{AlwaysDecodeAddress};
my $retry = delete $params{Retry};
my $payload = delete $params{Payload};
# 56 data bytes :)
$payload = 'Use POE!' x 7 unless defined $payload;
croak(
"$type doesn't know these parameters: ", join(', ', sort keys %params)
) if scalar keys %params;
POE::Session->create(
inline_states => {
_start => \&poco_ping_start,
ping => \&poco_ping_ping,
clear => \&poco_ping_clear,
got_pong => \&poco_ping_pong,
_default => \&poco_ping_default,
},
heap => {
alias => $alias,
always_decode => $always_decode,
data => $payload,
data_size => length($payload),
keep_socket => (defined $socket) || 0,
onereply => $onereply,
rcvbuf => $rcvbuf,
retry => $retry // 0,
socket_handle => $socket,
timeout => $timeout,
# Active query tracking.
ping_by_seq => { }, # keyed on sequence number
addr_to_seq => { }, # keyed on request address, then sender
# Queue to manage throttling.
parallelism => $parallelism, # how many pings can we send at once
queue => [ ], # ordered list of throttled pings
pending => { }, # data for the sequence ids of queued pings
outstanding => 0, # How many pings are we awaiting replies for
},
);
undef;
}
# Start the pinger session.
sub poco_ping_start {
$_[KERNEL]->alias_set( $_[HEAP]->{alias} );
}
# (NOT A POE EVENT HANDLER)
# Create a raw socket to send ICMP packets down.
# (optionally) mess with the size of the buffers on the socket.
sub _create_handle {
my ($kernel, $heap) = @_;
DEBUG_SOCKET and warn "opening a raw socket for icmp";
my $protocol = (getprotobyname('icmp'))[2]
or die "can't get icmp protocol by name: $!";
my $socket = gensym();
socket($socket, PF_INET, SOCK_RAW, $protocol)
or die "can't create icmp socket: $!";
$heap->{socket_handle} = $socket;
_setup_handle($kernel, $heap);
}
### NOT A POE EVENT HANDLER
sub _setup_handle {
my ($kernel, $heap) = @_;
if ($heap->{rcvbuf}) {
unless (
setsockopt(
$heap->{socket_handle}, SOL_SOCKET,
SO_RCVBUF, pack("I", $heap->{rcvbuf})
)
) {
warn("setsockopt rcvbuf size ($heap->{rcvbuf}) failed: $!");
}
}
if ($heap->{parallelism} && $heap->{parallelism} == -1) {
my $rcvbuf = getsockopt($heap->{socket_handle}, SOL_SOCKET, SO_RCVBUF);
if ($rcvbuf) {
my $size = unpack("I", $rcvbuf);
my $max_parallel = int($size / $PKTSIZE);
if ($max_parallel > 8) {
$max_parallel -= 8;
}
elsif ($max_parallel < 1) {
$max_parallel = 1;
}
$heap->{parallelism} = $max_parallel;
}
}
$kernel->select_read($heap->{socket_handle}, 'got_pong');
}
# Request a ping. This code borrows heavily from Net::Ping.
sub poco_ping_ping {
my (
$kernel, $heap, $sender,
$event, $address, $timeout, $tries_left
) = @_[
KERNEL, HEAP, SENDER,
ARG0, ARG1, ARG2, ARG3
];
$tries_left //= $heap->{retry};
DEBUG and warn "ping requested for $address ($tries_left try/tries left)\n";
_do_ping(
$kernel, $heap, $sender, $event, $address, $timeout, $tries_left, 0
);
}
sub _do_ping {
my (
$kernel, $heap, $sender, $event, $address, $timeout, $tries_left,
$is_a_retry
) = @_;
# No current pings. Open a socket, or setup the existing one.
unless (scalar(keys %{$heap->{ping_by_seq}})) {
unless (defined $heap->{socket_handle}) {
_create_handle($kernel, $heap);
}
else {
_setup_handle($kernel, $heap);
}
}
# Get the timeout, or default to the one set for the component.
$timeout = $heap->{timeout} unless defined $timeout and $timeout > 0;
$tries_left = $heap->{retry} unless defined $tries_left;
# Find an unused sequence number.
while (1) {
$master_seq = ($master_seq + 1) & 0xFFFF;
last unless exists $heap->{ping_by_seq}->{$master_seq};
}
my $checksum = 0;
# Build the message without a checksum.
my $msg = pack(
ICMP_STRUCT . $heap->{data_size},
ICMP_ECHO, ICMP_SUBCODE,
$checksum, ($$ & 0xFFFF), $master_seq, $heap->{data}
);
### Begin checksum calculation section.
# Sum up short integers in the packet.
my $shorts = int(length($msg) / 2);
foreach my $short (unpack "S$shorts", $msg) {
$checksum += $short;
}
# If there's an odd byte, add that in as well.
$checksum += ord(substr($msg, -1)) if length($msg) % 2;
# Fold the high short into the low one twice, and then complement.
$checksum = ($checksum >> 16) + ($checksum & 0xFFFF);
$checksum = ~( ($checksum >> 16) + $checksum) & 0xFFFF;
### Cease checksum calculation section.
# Rebuild the message with the checksum this time.
$msg = pack(
ICMP_STRUCT . $heap->{data_size},
ICMP_ECHO, ICMP_SUBCODE, $checksum, ($$ & 0xFFFF), $master_seq,
$heap->{data}
);
# Record information about the ping request.
my ($event_name, @user_args);
if (ref($event) eq "ARRAY") {
($event_name, @user_args) = @$event;
}
else {
$event_name = $event;
}
# Build an address to send the ping at.
# TODO - This blocks, so resolve them first.
# TODO - This assumes four-octet addresses are IPv4.
my $usable_address = $address;
if ($heap->{always_decode} || length($address) != 4) {
$usable_address = inet_aton($address);
}
# Return failure if an address was not resolvable. This simulates
# the postback behavior.
unless (defined $usable_address) {
$kernel->post(
$sender, $event_name,
[
$address, # REQ_ADDRESS
$timeout, # REQ_TIMEOUT
time(), # REQ_TIME
@user_args, # REQ_USER_ARGS
],
[
undef, # RES_ADDRESS
undef, # RES_ROUNDTRIP
time(), # RES_TIME
undef, # RES_TTL
],
);
_check_for_close($kernel, $heap);
return;
}
my $socket_address = pack_sockaddr_in(ICMP_PORT, $usable_address);
push(@{$heap->{queue}}, $master_seq);
$heap->{pending}->{$master_seq} = [
$msg, # PEND_MSG
$socket_address, # PEND_ADDR
$sender, # PEND_SENDER
$event, # PEND_EVENT
$address, # PEND_ADDR ???
$timeout, # PEND_TIMEOUT
$is_a_retry, # PEND_IS_RETRY
];
if ($tries_left and $tries_left > 1) {
$heap->{retrydata}->{$master_seq} = [
$sender, # RD_SENDER
$event, # RD_EVENT
$address, # RD_ADDRESS
$timeout, # RD_TIMEOUT
$tries_left, # RD_RETRY
];
}
_send_next_packet($kernel, $heap);
}
sub _send_next_packet {
my ($kernel, $heap) = @_;
return unless (scalar @{$heap->{queue}});
if ($heap->{parallelism} && $heap->{outstanding} >= $heap->{parallelism}) {
# We want to throttle back since we're still waiting for pings
# so, let's just leave this till later
DEBUG and warn(
"throttled since there are $heap->{outstanding} pings outstanding. " .
"queue size=" . (scalar @{$heap->{queue}}) . "\n"
);
return;
}
my $seq = shift(@{$heap->{queue}});
# May have been cleared by caller
return unless (exists $heap->{pending}->{$seq});
my $ping_info = delete $heap->{pending}->{$seq};
my (
$msg, # PEND_MSG
$socket_address, # PEND_ADDR
$sender, # PEND_SENDER
$event, # PEND_EVENT
$address, # PEND_ADDR ???
$timeout, # PEND_TIMEOUT
$is_a_retry, # PEND_IS_RETRY
) = @$ping_info;
# Send the packet. If send() fails, then we bail with an error.
my @user_args = ();
($event, @user_args) = @$event if ref($event) eq "ARRAY";
DEBUG and warn "sending packet sequence number $seq\n";
unless (send($heap->{socket_handle}, $msg, ICMP_FLAGS, $socket_address)) {
$kernel->post(
$sender, $event,
[ $address, # REQ_ADDRESS
$timeout, # REQ_TIMEOUT
time(), # REQ_TIME
@user_args, # REQ_USER_ARGS
],
[ undef, # RES_ADDRESS
undef, # RES_ROUNDTRIP
time(), # RES_TIME
undef, # RES_TTL
],
);
_check_for_close($kernel, $heap);
return;
}
# Record the message's length. This is constant, but we do it here
# anyway. It's also used to flag when we start requesting replies.
$heap->{message_length} = length($msg);
$heap->{outstanding}++;
# Set a timeout based on the sequence number.
$kernel->delay( $seq => $timeout );
DEBUG_PBS and warn "recording ping_by_seq($seq)";
if ($is_a_retry) {
# If retries, set the request time to the new/actual request time.
# Inserted by Ralph Schmitt 2009-09-12.
$heap->{ping_by_seq}->{$seq}->[PBS_REQUEST_TIME] = time();
}
else {
$heap->{ping_by_seq}->{$seq} = [
# PBS_POSTBACK
$sender->postback(
$event,
$address, # REQ_ADDRESS
$timeout, # REQ_TIMEOUT
time(), # REQ_TIME
@user_args, # REQ_USER_ARGS
),
"$sender", # PBS_SESSION (stringified to weaken reference)
$address, # PBS_ADDRESS
time() # PBS_REQUEST_TIME
];
}
# Duplicate pings? Forcibly time out the previous one.
if (exists $heap->{addr_to_seq}->{$sender}->{$address}) {
DEBUG and warn "Duplicate ping. Canceling $address";
my $now = time();
my $ping_info = _end_ping_by_requester_and_address(
$kernel, $heap, $sender, $address
);
$ping_info->[PBS_POSTBACK]->( undef, undef, $now, undef );
}
$heap->{addr_to_seq}->{$sender}->{$address} = $seq;
}
# Clear a ping postback by address. The sender+address pair are a
# unique ID into the pinger's data.
sub poco_ping_clear {
my ($kernel, $heap, $sender, $address) = @_[KERNEL, HEAP, SENDER, ARG0];
# Is the sender still waiting for anything?
return unless exists $heap->{addr_to_seq}->{$sender};
# Try to clear a single ping if an address was specified.
if (defined $address) {
_end_ping_by_requester_and_address($kernel, $heap, $sender, $address);
}
# No address was specified. Clear all the pings for this session.
else {
_end_pings_by_requester($kernel, $heap, $sender);
}
_check_for_close($kernel, $heap);
}
# (NOT A POE EVENT HANDLER)
# Check to see if no more pings are waiting. Close the socket if so.
sub _check_for_close {
my ($kernel, $heap) = @_;
return unless exists $heap->{socket_handle};
return if scalar keys %{$heap->{ping_by_seq}};
DEBUG_SOCKET and warn "stopping raw socket watcher";
$kernel->select_read( $heap->{socket_handle} );
return if $heap->{keep_socket};
DEBUG_SOCKET and warn "closing raw socket";
delete $heap->{socket_handle};
}
# (NOT A POE EVENT HANDLER)
# Clean up after we're done with a ping.
# Remove it from all tracking hashes.
# Determine if the socket should be unthrottled or shut down.
sub _end_ping_by_sequence {
my ($kernel, $heap, $seq) = @_;
# Delete the ping information. Cache a copy for other cleanup.
DEBUG_PBS and warn "removing ping by sequence ($seq)";
my $ping_info = delete $heap->{ping_by_seq}->{$seq};
return unless $ping_info;
# Stop its associated timeout.
$kernel->delay($seq);
# Stop mapping the session+address to this sequence number.
my $pbs_session = $ping_info->[PBS_SESSION];
delete $heap->{addr_to_seq}->{$pbs_session}->{$ping_info->[PBS_ADDRESS]};
# Stop tracking the session if that was its last address.
delete $heap->{addr_to_seq}->{$pbs_session} unless (
scalar(keys %{$heap->{addr_to_seq}->{$pbs_session}})
);
$heap->{outstanding}--;
return $ping_info;
}
sub _end_ping_by_requester_and_address {
my ($kernel, $heap, $sender, $address) = @_;
return unless exists $heap->{addr_to_seq}->{$sender};
my $addr_to_seq_rec = $heap->{addr_to_seq}->{$sender};
my $seq = delete $addr_to_seq_rec->{$address};
unless ($seq) {
# TODO - Why?
delete $heap->{pending}->{$sender}->{$address};
return;
}
# Stop tracking the sender if that was the last address.
delete $heap->{addr_to_seq}->{$sender} unless scalar(
keys %{$heap->{addr_to_seq}->{$sender}}
);
# Discard the postback for the discarded sequence number.
DEBUG_PBS and warn "removing ping_by_seq($seq)";
my $ping_info = delete $heap->{ping_by_seq}->{$seq};
$kernel->delay($seq);
$heap->{outstanding}--;
return $ping_info;
}
sub _end_pings_by_requester {
my ($kernel, $heap, $sender) = @_;
return unless exists $heap->{addr_to_seq}->{$sender};
my $addr_to_seq_rec = delete $heap->{addr_to_seq}->{$sender};
# Discard cross references.
foreach my $seq (values %$addr_to_seq_rec) {
DEBUG_PBS and warn "removing ping_by_seq($seq)";
delete $heap->{ping_by_seq}->{$seq};
$kernel->delay($seq);
$heap->{outstanding}--;
}
return;
}
# Something has arrived. Try to match it against something being
# waited for.
sub poco_ping_pong {
my ($kernel, $heap, $socket) = @_[KERNEL, HEAP, ARG0];
# Record the receive time for possible use later.
my $now = time();
# Receive a message on the ICMP port.
my $recv_message = '';
my $from_saddr = recv($socket, $recv_message, 1500, ICMP_FLAGS);
return unless $from_saddr;
# We haven't yet sent a message, so don't bother with whatever we've
# received.
return unless defined $heap->{message_length};
# Unpack the packet's sender address.
my ($from_port, $from_ip) = unpack_sockaddr_in($from_saddr);
# Get the response packet's time to live.
my ($ihl, $from_ttl) = unpack('C1@7C1', $recv_message);
$ihl &= 0x0F;
# Unpack the packet itself.
my (
$from_type, $from_subcode,
$from_checksum, $from_pid, $from_seq, $from_message
) = unpack(
'@'.$ihl*4 . ICMP_STRUCT.$heap->{data_size}, $recv_message
);
DEBUG and do {
warn ",----- packet from ", inet_ntoa($from_ip), ", port $from_port\n";
warn "| type = $from_type / subtype = $from_subcode\n";
warn "| checksum = $from_checksum, pid = $from_pid, seq = $from_seq\n";
warn "| message: $from_message\n";
warn "`------------------------------------------------------------\n";
};
# Not an ICMP echo reply. Move along.
return unless $from_type == ICMP_ECHOREPLY;
DEBUG and warn "it's an ICMP echo reply";
# Not from this process. Move along.
return unless $from_pid == ($$ & 0xFFFF);
DEBUG and warn "it's from the current process";
# Not waiting for a response with that sequence number. Move along.
return unless exists $heap->{ping_by_seq}->{$from_seq};
DEBUG and warn "it's one we're waiting for ($from_seq)";
# This is the response we're looking for. Calculate the round trip
# time, and map it to a postback.
my $trip_time = $now - $heap->{ping_by_seq}->{$from_seq}->[PBS_REQUEST_TIME];
$heap->{ping_by_seq}->{$from_seq}->[PBS_POSTBACK]->(
inet_ntoa($from_ip), $trip_time, $now, $from_ttl
);
# It's a single-reply ping. Clean up after it.
if ($heap->{onereply}) {
_end_ping_by_sequence($kernel, $heap, $from_seq);
_send_next_packet($kernel, $heap);
_check_for_close($kernel, $heap);
}
}
# Default's used to catch ping timeouts, which are named after the
# packed socket addresses being pinged. We always send the timeout so
# the other session knows that a ping period has ended.
sub poco_ping_default {
my ($kernel, $heap, $seq) = @_[KERNEL, HEAP, ARG0];
# Record the receive time for possible use later.
my $now = time();
# Are we waiting for this sequence number? We should be!
unless (exists $heap->{ping_by_seq}->{$seq}) {
warn "this shouldn't technically be displayed ($seq)" if (
DEBUG and $seq =~ /^\d+$/
);
return;
}
my $ping_info = _end_ping_by_sequence($kernel, $heap, $seq);
my $retryinfo = delete $heap->{retrydata}->{$seq};
if ($retryinfo) {
my ($sender, $event, $address, $timeout, $remaining) = @{$retryinfo};
DEBUG and warn("retrying ping for $address (", $remaining - 1, ")\n");
_do_ping($kernel, $heap, $sender, $event, $address, $remaining - 1, 1);
return;
}
# Post a timer tick back to the session. This marks the end of
# the request/response transaction.
$ping_info->[PBS_POSTBACK]->( undef, undef, $now, undef );
_send_next_packet($kernel, $heap);
_check_for_close($kernel, $heap);
return;
}
1;
__END__
=head1 NAME
POE::Component::Client::Ping - a non-blocking ICMP ping client
=head1 SYNOPSIS
use POE qw(Component::Client::Ping);
POE::Component::Client::Ping->spawn(
Alias => "pingthing", # defaults to "pinger"
Timeout => 10, # defaults to 1 second
Retry => 3, # defaults to 1 attempt
OneReply => 1, # defaults to disabled
Parallelism => 64, # defaults to autodetect
BufferSize => 65536, # defaults to undef
AlwaysDecodeAddress => 1, # defaults to 0
);
sub some_event_handler {
$kernel->post(
"pingthing", # Post the request to the "pingthing" component.
"ping", # Ask it to "ping" an address.
"pong", # Have it post an answer as a "pong" event.
$address, # This is the address we want to ping.
$timeout, # Optional timeout. It overrides the default.
$retry, # Optional retries. It overrides the default.
);
}
# This is the sub which is called when the session receives a "pong"
# event. It handles responses from the Ping component.
sub got_pong {
my ($request, $response) = @_[ARG0, ARG1];
my ($req_address, $req_timeout, $req_time) = @$request;
my ($resp_address, $roundtrip_time, $resp_time, $resp_ttl) = @$response;
# The response address is defined if this is a response.
if (defined $resp_address) {
printf(
"ping to %-15.15s at %10d. pong from %-15.15s in %6.3f s\n",
$req_address, $req_time,
$resp_address, $roundtrip_time,
);
return;
}
# Otherwise the timeout period has ended.
printf(
"ping to %-15.15s is done.\n", $req_address,
);
}
or
use POE::Component::Client::Ping ":const";
# Post an array ref as the callback to get data back to you
$kernel->post("pinger", "ping", [ "pong", $user_data ]);
# use the REQ_USER_ARGS constant to get to your data
sub got_pong {
my ($request, $response) = @_[ARG0, ARG1];
my $user_data = $request->[REQ_USER_ARGS];
...;
}
=head1 DESCRIPTION
POE::Component::Client::Ping is non-blocking ICMP ping client. It
lets several other sessions ping through it in parallel, and it lets
them continue doing other things while they wait for responses.
Ping client components are not proper objects. Instead of being
created, as most objects are, they are "spawned" as separate sessions.
To avoid confusion (and hopefully not cause other confusion), they
must be spawned with a C<spawn> method, not created anew with a C<new>
one.
PoCo::Client::Ping's C<spawn> method takes a few named parameters:
=over 2
=item Alias => $session_alias
C<Alias> sets the component's alias. It is the target of post()
calls. See the synopsis. The alias defaults to "pinger".
=item Socket => $raw_socket
C<Socket> allows developers to open an existing raw socket rather
than letting the component attempt opening one itself. If omitted,
the component will create its own raw socket.
This is useful for people who would rather not perform a security
audit on POE, since it allows them to create a raw socket in their own
code and then run POE at reduced privileges.
=item Timeout => $ping_timeout
C<Timeout> sets the default amount of time (in seconds) a Ping
component will wait for a single ICMP echo reply before retrying. It
is 1 by default. It is possible and meaningful to set the timeout to
a fractional number of seconds.
This default timeout is only used for ping requests that don't include
their own timeouts.
=item Retry => $ping_attempts
C<Retry> sets the default number of attempts a ping will be sent
before it should be considered failed. It is 1 by default.
=item OneReply => 0|1
Set C<OneReply> to prevent the Ping component from waiting the full
timeout period for replies. Normally the ICMP protocol allows for
multiple replies to a single request, so it's proper to wait for late
responses. This option disables the wait, ending the ping transaction
at the first response. Any subsequent responses will be silently
ignored.
C<OneReply> is disabled by default, and a single successful request
will generate at least two responses. The first response is a
successful ICMP ECHO REPLY event. The second is an undefined response
event, signifying that the timeout period has ended.
A ping request will generate exactly one reply when C<OneReply> is
enabled. This reply will represent either the first ICMP ECHO REPLY
to arrive or that the timeout period has ended.
=item Parallelism => $limit
Parallelism sets POE::Component::Client::Ping's maximum number of
simultaneous ICMP requests. Higher numbers speed up the processing of
large host lists, up to the point where the operating system or
network becomes oversaturated and begin to drop packets.
The difference can be dramatic. A tuned Parallelism can enable
responses down to 1ms, depending on the network, although it will take
longer to get through the hosts list.
Pinging 762 hosts at Parallelism=64
Starting to ping hosts.
Pinged 10.0.0.25 - Response from 10.0.0.25 in 0.002s
Pinged 10.0.0.200 - Response from 10.0.0.200 in 0.003s
Pinged 10.0.0.201 - Response from 10.0.0.201 in 0.001s
real 1m1.923s
user 0m2.584s
sys 0m0.207s
Responses will take significantly longer with an untuned Parallelism,
but the total run time will be quicker.
Pinging 762 hosts at Parallelism=500
Starting to ping hosts.
Pinged 10.0.0.25 - Response from 10.0.0.25 in 3.375s
Pinged 10.0.0.200 - Response from 10.0.0.200 in 1.258s
Pinged 10.0.0.201 - Response from 10.0.0.201 in 2.040s
real 0m13.410s
user 0m6.390s
sys 0m0.290s
Excessively high parallelism values may saturate the OS or network,
resulting in few or no responses.
Pinging 762 hosts at Parallelism=1000
Starting to ping hosts.
real 0m20.520s
user 0m7.896s
sys 0m0.297s
By default, POE::Component::Client::Ping will guess at an optimal
Parallelism value based on the raw socket receive buffer size and the
operating system's nominal ICMP packet size. The latter figure is
3000 octets for Linux and 100 octets for other systems. ICMP packets
are generally under 90 bytes, but operating systems may use
alternative numbers when calculating buffer capacities. The component
tries to mimic calculations observed in the wild.
When in doubt, experiment with different Parallelism values and use
the one that works best.
=item BufferSize => $bytes
If set, then the size of the receive buffer of the raw socket will be
modified to the given value. The default size of the receive buffer is
operating system dependent. If the buffer cannot be set to the given
value, a warning will be generated but the system will continue
working. Note that if the buffer is set too small and too many ping
replies arrive at the same time, then the operating system may discard
the ping replies and mistakenly cause this component to believe the
ping to have timed out. In this case, you will typically see discards
being noted in the counters displayed by 'netstat -s'.
Increased BufferSize values can expand the practical limit for
Parallelism.
=item AlwaysDecodeAddress => 0|1
If set, then any input addresses will always be looked up,
even if the hostname happens to be only 4 characters in size.
Ideally, you should be passing addresses in to the system to
avoid slow hostname lookups, but if you must use hostnames
and there is a possibility that you might have short
hostnames, then you should set this.
=item Payload => $bytes
Sets the ICMP payload (data bytes). Otherwise the component generates
56 data bytes internally. Note that some firewalls will discard ICMP
packets with nonstandard payload sizes.
=back
Sessions communicate asynchronously with the Client::Ping component.
They post ping requests to it, and they receive pong events back.
Requests are posted to the component's "ping" handler. They include
the name of an event to post back, an address to ping, and an optional
amount of time to wait for responses. The address may be a numeric
dotted quad, a packed inet_aton address, or a host name. Host names
are not recommended: they must be looked up for every ping request,
and DNS lookups can be very slow. The optional timeout overrides the
one set when C<spawn> is called.
Ping responses come with two array references:
my ($request, $response) = @_[ARG0, ARG1];
C<$request> contains information about the original request:
my (
$req_address, $req_timeout, $req_time, $req_user_args,
) = @$request;
=over 2
=item C<$req_address>
This is the original request address. It matches the address posted
along with the original "ping" request.
It is useful along with C<$req_user_args> for pairing requests with
their corresponding responses.
=item C<$req_timeout>
This is the original request timeout. It's either the one passed with
the "ping" request or the default timeout set with C<spawn>.
=item C<$req_time>
This is the time that the "ping" event was received by the Ping
component. It is a real number based on the current system's time()
epoch.
=item C<$req_user_args>
This is a scalar containing arbitrary data that can be sent along with
a request. It's often used to provide continuity between requests and
their responses. C<$req_user_args> may contain a reference to some
larger data structure.
To use it, replace the response event with an array reference in the
original request. The array reference should contain two items: the
actual response event and a scalar with the context data the program
needs back. See the SYNOPSIS for an example.
=back
C<$response> contains information about the ICMP ping response. There
may be multiple responses for a single request.
my ($response_address, $roundtrip_time, $reply_time, $reply_ttl) =
@$response;
=over 2
=item C<$response_address>
This is the address that responded to the ICMP echo request. It may
be different than C<$request_address>, especially if the request was
sent to a broadcast address.
C<$response_address> will be undefined if C<$request_timeout> seconds
have elapsed. This marks the end of responses for a given request.
Programs can assume that no more responses will be sent for the
request address. They may use this marker to initiate another ping
request.
=item C<$roundtrip_time>
This is the number of seconds that elapsed between the ICMP echo
request's transmission and its corresponding response's receipt. It's
a real number. This is purely the trip time and does *not* include any
time spent queueing if the system's parallelism limit caused the ping
transmission to be delayed.
=item C<$reply_time>
This is the time when the ICMP echo response was received. It is a
real number based on the current system's time() epoch.
=item C<$reply_ttl>
This is the ttl for the echo response packet we received.
=back
If the ":const" tagset is imported the following constants will be
exported:
REQ_ADDRESS, REQ_TIMEOUT, REQ_TIME REQ_USER_ARGS,
RES_ADDRESS, RES_ROUNDTRIP, RES_TIME, RES_TTL
=head1 SEE ALSO
This component's ICMP ping code was lifted from Net::Ping, which is an
excellent module when you only need to ping one host at a time.
See POE, of course, which includes a lot of documentation about how
POE works.
Also see the test program, t/01_ping.t, in the component's
distribution.
=head1 BUG TRACKER
https://rt.cpan.org/Dist/Display.html?Queue=POE-Component-Client-Ping
=head1 REPOSITORY
http://github.com/rcaputo/poe-component-client-ping/
=head1 OTHER RESOURCES
http://search.cpan.org/dist/POE-Component-Client-Ping/
=head1 AUTHOR & COPYRIGHTS
POE::Component::Client::Ping is Copyright 1999-2009 by Rocco Caputo.
All rights are reserved. POE::Component::Client::Ping is free
software; you may redistribute it and/or modify it under the same
terms as Perl itself.
You can learn more about POE at http://poe.perl.org/
=cut
|