| 1 |
NAME |
| 2 |
Net::FCP - http://freenet.sf.net client protocol |
| 3 |
|
| 4 |
SYNOPSIS |
| 5 |
use Net::FCP; |
| 6 |
|
| 7 |
my $fcp = new Net::FCP; |
| 8 |
|
| 9 |
my $ni = $fcp->txn_node_info->result; |
| 10 |
my $ni = $fcp->node_info; |
| 11 |
|
| 12 |
DESCRIPTION |
| 13 |
See <http://freenet.sourceforge.net/index.php?page=fcp> for a |
| 14 |
description of what the messages do. I am too lazy to document all this |
| 15 |
here. |
| 16 |
|
| 17 |
WARNING |
| 18 |
This module is alpha. While it probably won't destroy (much :) of your |
| 19 |
data, it currently falls short of what it should provide (intelligent |
| 20 |
uri following, splitfile downloads, healing...) |
| 21 |
|
| 22 |
IMPORT TAGS |
| 23 |
Nothing much can be "imported" from this module right now. There are, |
| 24 |
however, certain "import tags" that can be used to select the event |
| 25 |
model to be used. |
| 26 |
|
| 27 |
Event models are implemented as modules under the "Net::FCP::Event::xyz" |
| 28 |
class, where "xyz" is the event model to use. The default is "Event" (or |
| 29 |
later "Auto"). |
| 30 |
|
| 31 |
The import tag to use is named "event=xyz", e.g. "event=Event", |
| 32 |
"event=Glib" etc. |
| 33 |
|
| 34 |
You should specify the event module to use only in the main program. |
| 35 |
|
| 36 |
THE Net::FCP CLASS |
| 37 |
$meta = Net::FCP::parse_metadata $string |
| 38 |
Parse a metadata string and return it. |
| 39 |
|
| 40 |
The metadata will be a hashref with key "version" (containing the |
| 41 |
mandatory version header entries). |
| 42 |
|
| 43 |
All other headers are represented by arrayrefs (they can be |
| 44 |
repeated). |
| 45 |
|
| 46 |
Since this is confusing, here is a rather verbose example of a |
| 47 |
parsed manifest: |
| 48 |
|
| 49 |
( |
| 50 |
version => { revision => 1 }, |
| 51 |
document => [ |
| 52 |
{ |
| 53 |
"info.format" => "image/jpeg", |
| 54 |
name => "background.jpg", |
| 55 |
"redirect.target" => "freenet:CHK\@ZcagI,ra726bSw" |
| 56 |
}, |
| 57 |
{ |
| 58 |
"info.format" => "text/html", |
| 59 |
name => ".next", |
| 60 |
"redirect.target" => "freenet:SSK\@ilUPAgM/TFEE/3" |
| 61 |
}, |
| 62 |
{ |
| 63 |
"info.format" => "text/html", |
| 64 |
"redirect.target" => "freenet:CHK\@8M8Po8ucwI,8xA" |
| 65 |
} |
| 66 |
] |
| 67 |
) |
| 68 |
|
| 69 |
$fcp = new Net::FCP [host => $host][, port => $port] |
| 70 |
Create a new virtual FCP connection to the given host and port |
| 71 |
(default 127.0.0.1:8481, or the environment variables "FREDHOST" and |
| 72 |
"FREDPORT"). |
| 73 |
|
| 74 |
Connections are virtual because no persistent physical connection is |
| 75 |
established. However, the existance of the node is checked by |
| 76 |
executing a "ClientHello" transaction. |
| 77 |
|
| 78 |
$txn = $fcp->txn(type => attr => val,...) |
| 79 |
The low-level interface to transactions. Don't use it. |
| 80 |
|
| 81 |
$txn = $fcp->txn_client_hello |
| 82 |
$nodehello = $fcp->client_hello |
| 83 |
Executes a ClientHello request and returns it's results. |
| 84 |
|
| 85 |
{ |
| 86 |
max_file_size => "5f5e100", |
| 87 |
node => "Fred,0.6,1.46,7050" |
| 88 |
protocol => "1.2", |
| 89 |
} |
| 90 |
|
| 91 |
$txn = $fcp->txn_client_info |
| 92 |
$nodeinfo = $fcp->client_info |
| 93 |
Executes a ClientInfo request and returns it's results. |
| 94 |
|
| 95 |
{ |
| 96 |
active_jobs => "1f", |
| 97 |
allocated_memory => "bde0000", |
| 98 |
architecture => "i386", |
| 99 |
available_threads => 17, |
| 100 |
datastore_free => "5ce03400", |
| 101 |
datastore_max => "2540be400", |
| 102 |
datastore_used => "1f72bb000", |
| 103 |
estimated_load => 52, |
| 104 |
free_memory => "5cc0148", |
| 105 |
is_transient => "false", |
| 106 |
java_name => "Java HotSpot(_T_M) Server VM", |
| 107 |
java_vendor => "http://www.blackdown.org/", |
| 108 |
java_version => "Blackdown-1.4.1-01", |
| 109 |
least_recent_timestamp => "f41538b878", |
| 110 |
max_file_size => "5f5e100", |
| 111 |
most_recent_timestamp => "f77e2cc520" |
| 112 |
node_address => "1.2.3.4", |
| 113 |
node_port => 369, |
| 114 |
operating_system => "Linux", |
| 115 |
operating_system_version => "2.4.20", |
| 116 |
routing_time => "a5", |
| 117 |
} |
| 118 |
|
| 119 |
$txn = $fcp->txn_generate_chk ($metadata, $data) |
| 120 |
$uri = $fcp->generate_chk ($metadata, $data) |
| 121 |
Creates a new CHK, given the metadata and data. UNTESTED. |
| 122 |
|
| 123 |
$txn = $fcp->txn_generate_svk_pair |
| 124 |
($public, $private) = @{ $fcp->generate_svk_pair } |
| 125 |
Creates a new SVK pair. Returns an arrayref. |
| 126 |
|
| 127 |
[ |
| 128 |
"hKs0-WDQA4pVZyMPKNFsK1zapWY", |
| 129 |
"ZnmvMITaTXBMFGl4~jrjuyWxOWg" |
| 130 |
] |
| 131 |
|
| 132 |
$txn = $fcp->txn_insert_private_key ($private) |
| 133 |
$uri = $fcp->insert_private_key ($private) |
| 134 |
Inserts a private key. $private can be either an insert URI (must |
| 135 |
start with freenet:SSK@) or a raw private key (i.e. the private |
| 136 |
value you get back from "generate_svk_pair"). |
| 137 |
|
| 138 |
Returns the public key. |
| 139 |
|
| 140 |
UNTESTED. |
| 141 |
|
| 142 |
$txn = $fcp->txn_get_size ($uri) |
| 143 |
$length = $fcp->get_size ($uri) |
| 144 |
Finds and returns the size (rounded up to the nearest power of two) |
| 145 |
of the given document. |
| 146 |
|
| 147 |
UNTESTED. |
| 148 |
|
| 149 |
$txn = $fcp->txn_client_get ($uri [, $htl = 15 [, $removelocal = 0]]) |
| 150 |
($metadata, $data) = @{ $fcp->client_get ($uri, $htl, $removelocal) |
| 151 |
Fetches a (small, as it should fit into memory) file from freenet. |
| 152 |
$meta is the metadata (as returned by "parse_metadata" or "undef"). |
| 153 |
|
| 154 |
Due to the overhead, a better method to download big files should be |
| 155 |
used. |
| 156 |
|
| 157 |
my ($meta, $data) = @{ |
| 158 |
$fcp->client_get ( |
| 159 |
"freenet:CHK@hdXaxkwZ9rA8-SidT0AN-bniQlgPAwI,XdCDmBuGsd-ulqbLnZ8v~w" |
| 160 |
) |
| 161 |
}; |
| 162 |
|
| 163 |
MISSING: ClientPut |
| 164 |
|
| 165 |
THE Net::FCP::Txn CLASS |
| 166 |
All requests (or transactions) are executed in a asynchroneous way (LIE: |
| 167 |
uploads are blocking). For each request, a "Net::FCP::Txn" object is |
| 168 |
created (worse: a tcp connection is created, too). |
| 169 |
|
| 170 |
For each request there is actually a different subclass (and it's |
| 171 |
possible to subclass these, although of course not documented). |
| 172 |
|
| 173 |
The most interesting method is "result". |
| 174 |
|
| 175 |
new arg => val,... |
| 176 |
Creates a new "Net::FCP::Txn" object. Not normally used. |
| 177 |
|
| 178 |
$userdata = $txn->userdata ([$userdata]) |
| 179 |
Get and/or set user-specific data. This is useful in progress |
| 180 |
callbacks. |
| 181 |
|
| 182 |
$result = $txn->result |
| 183 |
Waits until a result is available and then returns it. |
| 184 |
|
| 185 |
This waiting is (depending on your event model) not very efficient, |
| 186 |
as it is done outside the "mainloop". |
| 187 |
|
| 188 |
SEE ALSO |
| 189 |
<http://freenet.sf.net>. |
| 190 |
|
| 191 |
BUGS |
| 192 |
AUTHOR |
| 193 |
Marc Lehmann <pcg@goof.com> |
| 194 |
http://www.goof.com/pcg/marc/ |
| 195 |
|
