[ViewVC] Diff of: cvs/AnyEvent-FCP/FCP.pm

Comparing AnyEvent-FCP/FCP.pm (file contents):
Revision 1.21 by root, Sun Jun 12 01:48:05 2016 UTC vs.
Revision 1.28 by root, Thu Sep 9 00:49:06 2021 UTC

 =head1 DESCRIPTION
 This module implements the freenet client protocol version 2.0, as used by
 freenet 0.7. See L<Net::FCP> for the earlier freenet 0.5 version.
-See L<http://wiki.freenetproject.org/FreenetFCPSpec2Point0> for a
+See L<https://wiki.freenetproject.org/FCP> for a description of what the
-description of what the messages do.
+messages do.
 The module uses L<AnyEvent> to find a suitable event module.
 Only very little is implemented, ask if you need more, and look at the
 example program later in this section.
 =item on_error => $callback->($fcp, $message)
 Invoked on any (fatal) errors, such as unexpected connection close. The
 callback receives the FCP object and a textual error message.
-=item on_failure => $callback->($fcp, $type, $backtrace, $args, $error)
+=item on_failure => $callback->($fcp, $type, $args, $backtrace, $error)
 Invoked when an FCP request fails that didn't have a failure callback. See
 L<FCP REQUESTS> for details.
 =back
 }
 sub fatal {
    my ($self, $msg) = @_;
-   $self->{hdl}->shutdown;
+   $self->{hdl}->push_shutdown if $self->{hdl};
    delete $self->{kw};
    if ($self->{on_error}) {
       $self->{on_error}->($self, $msg);
    } else {
-      die $msg;
+      die "AnyEvent::FCP($self->{host}:$self->{port}): $msg";
    }
 }
 sub identifier {
    $_[0]{prefix} . ++$_[0]{idseq}
       $self->{id}{$id} = delete $kv{id_cb};
    }
    my $msg = (touc $type) . "\012"
              . join "", map +(touc $_) . "=$kv{$_}\012", keys %kv;
-      sub id {
-         my ($self) = @_;
-      }
    if (defined $data) {
       $msg .= "DataLength=" . (length $data) . "\012"
             . "Data\012$data";
    } else {
 Also comes in this underscore variant:
    $fcp->get_plugin_info_ ($name, $detailed, $cb);
-You can thinbk of the underscore as a kind of continuation indicator - the
+You can think of the underscore as a kind of continuation indicator - the
 normal function waits and returns with the data, the C<_> indicates that
 you pass the continuation yourself, and the continuation will be invoked
 with the results.
 This callback/continuation argument (C<$cb>) can come in three forms itself:
 call site.
 This is a popular choice, but it makes handling errors hard - make sure
 you never generate protocol errors!
-If an C<on_failure> hook exists, it will be invoked with the FCP object,
+In the failure case, if an C<on_failure> hook exists, it will be invoked
-the request type (the name of the method), a (textual) backtrace as
+with the FCP object, the request type (the name of the method, an arrayref
-generated by C<Carp::longmess>, and arrayref containing the arguments from
+containing the arguments from the original request invocation, a (textual)
-the original request invocation and the error object from the server, in
+backtrace as generated by C<Carp::longmess>, and the error object from the
-this order, e.g.:
+server, in this order, e.g.:
    on_failure => sub {
-      my ($fcp, $request_type, $backtrace, $orig_args, $error_object) = @_;
+      my ($fcp, $request_type, $orig_args, $backtrace, $error_object) = @_;
-      warn "FCP failure ($type), $error_object->{code_description} ($error_object->{extra_description})$backtrace";
+      warn "FCP failure ($type @$args), $error_object->{code_description} ($error_object->{extra_description})$backtrace";
       exit 1;
    },
 =item A condvar (as returned by e.g. C<< AnyEvent->condvar >>)
    });
 };
 =item $status = $fcp->remove_request ($identifier[, $global])
-Remove the request with the given isdentifier. Returns true if successful,
+Remove the request with the given identifier. Returns true if successful,
 false on error.
 =cut
 _txn remove_request => sub {
 C<$want_read> and C<$want_write> should be set to a true value when you
 want to read (get) files or write (put) files, respectively.
 On error, an exception is thrown. Otherwise, C<$can_read> and
-C<$can_write> indicate whether you can reaqd or write to freenet via the
+C<$can_write> indicate whether you can read or write to freenet via the
 directory.
 =cut
 _txn test_dda => sub {
 on every change, which will be called as C<< $cb->($fcp, $kv, $type) >>, where C<$type>
 is the type of the original message triggering the change,
 To fill this cache with the global queue and keep it updated,
 call C<watch_global> to subscribe to updates, followed by
-C<list_persistent_requests_sync>.
+C<list_persistent_requests>.
-   $fcp->watch_global_sync_; # do not wait
+   $fcp->watch_global_; # do not wait
    $fcp->list_persistent_requests; # wait
 To get a better idea of what is stored in the cache, here is an example of
 what might be stored in C<< $fcp->{req}{"Frost-gpl.txt"} >>:
             if 0.1 > rand;
       }
    }
    # see if the dummy plugin is loaded, to ensure all previous requests have finished.
-   $fcp->get_plugin_info_sync ("dummy");
+   $fcp->get_plugin_info ("dummy");
 =head1 SEE ALSO
 L<http://wiki.freenetproject.org/FreenetFCPSpec2Point0>, L<Net::FCP>.

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing AnyEvent-FCP/FCP.pm (file contents): Revision 1.21 by root, Sun Jun 12 01:48:05 2016 UTC vs. Revision 1.28 by root, Thu Sep 9 00:49:06 2021 UTC

Diff Legend

Comparing AnyEvent-FCP/FCP.pm (file contents):
Revision 1.21 by root, Sun Jun 12 01:48:05 2016 UTC vs.
Revision 1.28 by root, Thu Sep 9 00:49:06 2021 UTC