view release on metacpan or  search on metacpan

README  view on Meta::CPAN

       my $peers = $lp_cv->recv;
       my $reqs  = $pr_cv->recv;

DESCRIPTION
    This module implements the freenet client protocol version 2.0, as used
    by freenet 0.7. See Net::FCP for the earlier freenet 0.5 version.

    See <http://wiki.freenetproject.org/FreenetFCPSpec2Point0> for a
    description of what the messages do.

    The module uses 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.

  EXAMPLE
    This example fetches the download list and sets the priority of all
    files with "a" in their name to "emergency":

       use AnyEvent::FCP;

       my $fcp = new AnyEvent::FCP;

       $fcp->watch_global (1, 0);
       my $req = $fcp->list_persistent_requests;

    TODO for my $req (values %$req) { if ($req->{filename} =~ /a/) {
    $fcp->modify_persistent_request (1, $req->{identifier}, undef, 0); } }

  IMPORT TAGS
    Nothing much can be "imported" from this module right now.

THE AnyEvent::FCP CLASS
    $fcp = new AnyEvent::FCP key => value...;
        Create a new FCP connection to the given host and port (default
        127.0.0.1:9481, or the environment variables "FREDHOST" and
        "FREDPORT").

        If no "name" was specified, then AnyEvent::FCP will generate a
        (hopefully) unique client name for you.

        The following keys can be specified (they are all optional):

        name => $string
            A unique name to identify this client. If none is specified, a
            randomly generated name will be used.

        host => $hostname
            The hostname or IP address of the freenet node. Default is
            $ENV{FREDHOST} or 127.0.0.1.

        port => $portnumber
            The port number of the FCP port. Default is $ENV{FREDPORT} or
            9481.

        timeout => $seconds
            The timeout, in seconds, after which a connection error is
            assumed when there is no activity. Default is 7200, i.e. two
            hours.

        keepalive => $seconds
            The interval, in seconds, at which keepalive messages will be
            sent. Default is 540, i.e. nine minutes.

            These keepalive messages are useful both to detect that a
            connection is no longer working and to keep any (home) routers
            from expiring their masquerading entry.

        on_eof => $callback->($fcp)
            Invoked when the underlying AnyEvent::Handle signals EOF,
            currently regardless of whether the EOF was expected or not.

        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.

        on_failure => $callback->($fcp, $type, $backtrace, $args, $error)
            Invoked when an FCP request fails that didn't have a failure
            callback. See "FCP REQUESTS" for details.

  FCP REQUESTS
    The following methods implement various requests. Most of them map
    directory to the FCP message of the same name. The added benefit of
    these over sending requests yourself is that they handle the necessary
    serialisation, protocol quirks, and replies.

    All of them exist in two versions, the variant shown in this manpage,
    and a variant with an extra "_" at the end, and an extra $cb argument.
    The version as shown is *synchronous* - it will wait for any replies,
    and either return the reply, or croak with an error. The underscore
    variant returns immediately and invokes one or more callbacks or
    condvars later.

    For example, the call

       $info = $fcp->get_plugin_info ($name, $detailed);

    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 normal function waits and returns with the data, the "_" indicates
    that you pass the continuation yourself, and the continuation will be
    invoked with the results.

    This callback/continuation argument ($cb) can come in three forms
    itself:

    A code reference (or rather anything not matching some other
    alternative)
        This code reference will be invoked with the result on success. On
        an error, it will invoke the "on_failure" callback of the FCP
        object, or, if none was defined, will die (in the event loop) with a
        backtrace of the call site.

        This is a popular choice, but it makes handling errors hard - make
        sure you never generate protocol errors!

        If an "on_failure" hook exists, it will be invoked with the FCP
        object, the request type (the name of the method), a (textual)
        backtrace as generated by "Carp::longmess", and arrayref containing
        the arguments from the original request invocation and the error
        object from the server, in this order, e.g.: