| … | |
… | |
| 3 | AnyEvent::Porttracker - Porttracker/PortIQ API client interface. |
3 | AnyEvent::Porttracker - Porttracker/PortIQ API client interface. |
| 4 | |
4 | |
| 5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
| 6 | |
6 | |
| 7 | use AnyEvent::Porttracker; |
7 | use AnyEvent::Porttracker; |
|
|
8 | |
|
|
9 | my $api = new AnyEvent::Porttracker |
|
|
10 | host => "10.0.0.1", |
|
|
11 | user => "admin", |
|
|
12 | pass => "31331", |
|
|
13 | tls => 1, |
|
|
14 | ; |
|
|
15 | |
|
|
16 | # Example 1 |
|
|
17 | # a simple request: ping the server |
|
|
18 | |
|
|
19 | $api->req ("ping", sub { |
|
|
20 | my ($api, $ok, $timestamp, $pid) = @_; |
|
|
21 | ... |
|
|
22 | }); |
|
|
23 | |
|
|
24 | # Example 2 |
|
|
25 | # find all realms, start a discovery on all of them |
|
|
26 | # and wait until all discovery processes have finished |
|
|
27 | |
|
|
28 | my $cv = AE::cv; |
|
|
29 | |
|
|
30 | $cv->begin; |
|
|
31 | # find all realms |
|
|
32 | $api->req (realm_info => ["gid", "name"], sub { |
|
|
33 | my ($api, @realms) = @_; |
|
|
34 | |
|
|
35 | # start discovery on all realms |
|
|
36 | for my $realm (@realms) { |
|
|
37 | my ($gid, $name) = @$realm; |
|
|
38 | |
|
|
39 | $cv->begin; |
|
|
40 | $api->req (realm_discover => $realm->[0], sub { |
|
|
41 | warn "discovery for realm '$realm->[1]' finished\n"; |
|
|
42 | $cv->end; |
|
|
43 | }); |
|
|
44 | } |
|
|
45 | |
|
|
46 | $cv->end; |
|
|
47 | }); |
|
|
48 | |
|
|
49 | $cv->recv; |
|
|
50 | |
|
|
51 | # Example 3 |
|
|
52 | # subscribe to realm_poll_stop events and report each occurance |
|
|
53 | |
|
|
54 | $api->req (subscribe => "realm_poll_stop", sub {}); |
|
|
55 | $api->on (realm_poll_stop_event => sub { |
|
|
56 | my ($api, $gid) = @_; |
|
|
57 | warn "this just in: poll for realm <$gid> finished.\n"; |
|
|
58 | }); |
| 8 | |
59 | |
| 9 | =head1 DESCRIPTION |
60 | =head1 DESCRIPTION |
| 10 | |
61 | |
| 11 | Porttracker (L<http://www.porttracker.com/>) is a product that (among |
62 | Porttracker (L<http://www.porttracker.com/>) is a product that (among |
| 12 | other things) scans switches and routers in a network and gives a coherent |
63 | other things) scans switches and routers in a network and gives a coherent |
| … | |
… | |
| 108 | verify => 1, verify_peername => [1, 1, 1] >> or whatever verification mode |
159 | verify => 1, verify_peername => [1, 1, 1] >> or whatever verification mode |
| 109 | you wish to use. |
160 | you wish to use. |
| 110 | |
161 | |
| 111 | =item tls_ctx => $tls_ctx |
162 | =item tls_ctx => $tls_ctx |
| 112 | |
163 | |
| 113 | The L<AnyEvent::TLS> object to use. |
164 | The L<AnyEvent::TLS> object to use. See C<tls>, above. |
| 114 | |
|
|
| 115 | #TODO# |
|
|
| 116 | |
165 | |
| 117 | =item on_XYZ => $coderef |
166 | =item on_XYZ => $coderef |
| 118 | |
167 | |
| 119 | You can specify event callbacks either by subclassing and overriding the |
168 | You can specify event callbacks either by subclassing and overriding the |
| 120 | respective methods or by specifying coderefs as key-value pairs when |
169 | respective methods or by specifying coderefs as key-value pairs when |
| 121 | constructing the object. |
170 | constructing the object. You add or remove event handlers at any time with |
|
|
171 | the C<event> method. |
| 122 | |
172 | |
| 123 | =back |
173 | =back |
| 124 | |
174 | |
| 125 | =cut |
175 | =cut |
| 126 | |
176 | |
| … | |
… | |
| 249 | =cut |
299 | =cut |
| 250 | |
300 | |
| 251 | sub req { |
301 | sub req { |
| 252 | my $cb = pop; |
302 | my $cb = pop; |
| 253 | push @_, sub { |
303 | push @_, sub { |
| 254 | shift |
304 | splice @_, 1, 1 |
| 255 | or $_[0]->error ($_[1]); |
305 | or $_[0]->error ($_[1]); |
| 256 | |
306 | |
| 257 | &$cb |
307 | &$cb |
| 258 | }; |
308 | }; |
| 259 | |
309 | |
| … | |
… | |
| 272 | |
322 | |
| 273 | sub req_failok { |
323 | sub req_failok { |
| 274 | $_[0]{queue} |
324 | $_[0]{queue} |
| 275 | ? push @{ $_[0]{queue} }, [@_] |
325 | ? push @{ $_[0]{queue} }, [@_] |
| 276 | : &_req |
326 | : &_req |
|
|
327 | } |
|
|
328 | |
|
|
329 | =item $api->on (XYZ => $callback) |
|
|
330 | |
|
|
331 | Overwrites any currently registered handler for C<on_XYZ> or |
|
|
332 | installs a new one. Or, when C<$callback> is undef, unregisters any |
|
|
333 | currently-registered handler. |
|
|
334 | |
|
|
335 | Example: replace/set the handler for C<on_discover_stop_event>. |
|
|
336 | |
|
|
337 | $api->on (discover_stop_event => sub { |
|
|
338 | my ($api, $gid) = @_; |
|
|
339 | ... |
|
|
340 | }); |
|
|
341 | |
|
|
342 | =cut |
|
|
343 | |
|
|
344 | sub on { |
|
|
345 | my $self = shift; |
|
|
346 | |
|
|
347 | while (@_) { |
|
|
348 | my ($event, $cb) = splice @_, 0, 2; |
|
|
349 | $event =~ s/^on_//; |
|
|
350 | |
|
|
351 | $self->{"on_$event"} = $cb; |
|
|
352 | } |
| 277 | } |
353 | } |
| 278 | |
354 | |
| 279 | sub on_start_tls_notify { |
355 | sub on_start_tls_notify { |
| 280 | my ($self) = @_; |
356 | my ($self) = @_; |
| 281 | |
357 | |
| … | |
… | |
| 379 | |
455 | |
| 380 | $msg =~ s/\n$//; |
456 | $msg =~ s/\n$//; |
| 381 | $self->error ("login failed: $msg"); |
457 | $self->error ("login failed: $msg"); |
| 382 | } |
458 | } |
| 383 | |
459 | |
|
|
460 | sub on_event_notify { |
|
|
461 | my ($self, $event, @args) = @_; |
|
|
462 | |
|
|
463 | call $self, "on_${event}_event", @args; |
|
|
464 | } |
|
|
465 | |
| 384 | =back |
466 | =back |
| 385 | |
467 | |
| 386 | =head2 EVENTS |
468 | =head1 EVENTS |
| 387 | |
469 | |
| 388 | AnyEvent::Porttracker conenctions are fully event-driven, and naturally |
470 | AnyEvent::Porttracker conenctions are fully event-driven, and naturally |
| 389 | there are a number of events that can occur. All these events have a name |
471 | there are a number of events that can occur. All these events have a name |
| 390 | starting with C<on_> (example: C<on_login_failure>). |
472 | starting with C<on_> (example: C<on_login_failure>). |
| 391 | |
473 | |
| … | |
… | |
| 460 | |
542 | |
| 461 | Called when the server wants to start TLS negotiation. This is used |
543 | Called when the server wants to start TLS negotiation. This is used |
| 462 | internally and - while it is possible to override it - should not be |
544 | internally and - while it is possible to override it - should not be |
| 463 | overriden. |
545 | overriden. |
| 464 | |
546 | |
|
|
547 | =item on_event_notify $api, $eventname, @args |
|
|
548 | |
|
|
549 | Called when the server broadcasts an event the API object is subscribed |
|
|
550 | to. The default implementation (which should not be overridden) simply |
|
|
551 | re-issues an "on_eventname_event" event with the @args. |
|
|
552 | |
| 465 | =item on_XYZ_notify $api, ... |
553 | =item on_XYZ_notify $api, ... |
| 466 | |
554 | |
| 467 | In general, any protocol notification will result in an event of the form |
555 | In general, any protocol notification will result in an event of the form |
| 468 | C<on_NOTIFICATION_notify>. |
556 | C<on_NOTIFICATION_notify>. |
| 469 | |
557 | |
|
|
558 | =item on_XYZ_event $api, ... |
|
|
559 | |
|
|
560 | Called when the server broadcasts the named (XYZ) event. |
|
|
561 | |
| 470 | =back |
562 | =back |
| 471 | |
563 | |
| 472 | =head1 SEE ALSO |
564 | =head1 SEE ALSO |
| 473 | |
565 | |
| 474 | L<AnyEvent>, L<http://www.porttracker.com/>, L<http://www.infoblox.com/en/products/portiq.html>. |
566 | L<AnyEvent>, L<http://www.porttracker.com/>, L<http://www.infoblox.com/en/products/portiq.html>. |
