Revision [3667]

Last edited on 2010-02-06 19:16:16 by MatthewToseland [extra inserts]
Additions:
ExtraInsertsSingleBlock
Integer >= 0
Insert single blocks (not blocks above splitfiles, and not blocks in splitfiles) additional times. Testing has shown that a value of 2 (3 inserts total) can dramatically improve data persistence. We are still trying to figure out why. This defaults to 0 for single blocks because many FCP apps want to insert stuff quickly.
ExtraInsertsSplitfileHeaderBlock
Integer >=0
2
Insert blocks above splitfiles additional times. E.g. the CHK at the top of a splitfile, the CHK you actually fetch, is a single block. The splitfile itself has redundancy but the top block doesn't. So we insert it multiple times (3 by default) to improve the number of nodes it gets stored on. Tests show this dramatically improves data persistence, we are still trying to figure out why.

Revision [3664]

Edited on 2010-02-06 17:22:43 by MatthewToseland [move]

No differences.

Revision [3663]

Edited on 2010-02-06 17:22:03 by MatthewToseland [ForkOnCacheable]
Additions:
ForkOnCacheable
Depends on node version
Override insert behaviour: If true, fork an insert after its HTL becomes low enough for it to be cacheable. If false, don't fork the insert at this point. Inserts are not cached while their HTL is above 15, after that they can be cached, but this can be many hops because of probabilistic decrement, hence they may go over the "ideal" nodes or "sinks" where they should have been cached while they are still not allowed to, and the insert will not go back to those nodes because it's already been there. Forking deals with this by creating a new insert, which can go back over nodes we've already been to if necessary.

Revision [3283]

Edited on 2009-08-21 20:57:04 by SaceS [add 'Codecs' parameter]
Additions:
Codecs
a comma separated list of either names or ids
The node try to compress the data with the given codec, if more then one codec is given the node try to find the best in given order
The node tells the supported codecs in the NodeHello message
That setting has been introduced in 1231.

Revision [3282]

Edited on 2009-08-21 20:55:06 by SaceS [fix link to ClientPut]
Additions:
~- If you insert only one file, consider using [[FCP2p0ClientPut ClientPut]] instead (with no filename after the /) -- this save one manifest fetch
Deletions:
~- If you insert only one file, consider using ClientPut instead (with no filename after the /) -- this save one manifest fetch

Revision [2944]

Edited on 2009-01-30 00:21:32 by DanielCheng [ClientPut v.s ClientPutComplexDir]
Additions:
~- If you insert only one file, consider using ClientPut instead (with no filename after the /) -- this save one manifest fetch

Revision [2730]

Edited on 2008-06-06 21:20:21 by MatthewToseland [link]
Additions:
See EarlyEncode
Deletions:
Whether to aggressively encode the file's data in order to produce a key earlier (way before it would be fetchable; not generally recommended but useful for testing).

Revision [2688]

Edited on 2008-04-12 21:21:03 by BombeQ [add missing attribute for disk file entries]
Additions:
Files.N.Filename
The name of the file on disk

Revision [2645]

Edited on 2008-03-13 13:34:24 by JuergenUrner [fixed whitespace in sample]
Additions:
Identifier=any
URI=any
Files.0.Name=any
Files.1.Name=any
Deletions:
Identifier=any
URI=any
Files.0.Name=any
Files.1.Name=any

Revision [2644]

Edited on 2008-03-13 13:25:00 by JuergenUrner [DefaultName and DataLength (for file items) fields where missing]
Additions:
DefaultName
string
The item to display when someone requests the Uri only (without the item name part)
Files.N.DataSize
Size of the file to upload in bytes

Revision [2641]

Edited on 2008-03-13 11:10:34 by JuergenUrner [Reworked docs for PutComplexDir]
Additions:
This is a message of the [[FreenetFCPSpec2Point0 Freenet Client Protocol 2.0]] (FCP 2.0). It is sent from a client program to the Freenet node.
Inserts one or more items under one single key.
""ClientPutComplexDir"" works like an item container, in wich you can place any number of items that can be retrieved under the same Uri. On insert items are added to the container as //"Files.0.*"// up to //"Files.N.*"//, on retrieval items can be retrieved as //"""Uri/MyItemName1"""//, //"""Uri/Subfolder/MyItemName2"""//.
Identifier=any
URI=any
Files.0.Name=any
Files.1.Name=any
[Data]%%
**Notes:**
~- item Numbers must start at zero and advance sequentially
~- data associated to data items will be read in item order from the end of the message
~- an item can not be a folder and an item at the same time. That is, as for the exsample given above, you can not pass an item named //"""Subfolder"""//
The message accepts the following fields:
""




























































































Field Possible values Mandatory? Default Description
URI
CHK@

KSK@name

SSK@privateKey/docname-1

USK@privateKey/docname/0/
 Yes The type of key to insert. When inserting an SSK key, you explicitly specifiy the version number. For a USK key, use a zero and it should automatically use the correct version number.
Identifier Arbitrary text string Yes This is just for client to be able to identify files that have been inserted.
Verbosity Bitmask. At present only bits 1 and 512 are supported. No 0 0: report when complete, 1: SimpleProgress messages, 512: send StartedCompression and FinishedCompression messages
MaxRetries Integer -1 to 999999+? No ? Number of times to retry if the first time doesn't work. -1 means retry forever.
PriorityClass Number 0 (maximum priority) to 6 (minimum priority) No 2 (Semi-interactive priority class) How to prioritise the insert.
GetCHKOnly false, true No false If set to true, it won't actually insert the data, just return the key it would generate.
If the key is USK, you may want to transform it into a SSK, to prevent the node spending time searching for an unused index.
Global true, false No false Whether the insert is visible on the global queue or not.
DontCompress true, false No Hint to node: don't try to compress the data, it's already compressed
ClientToken Arbitrary string No Sent back to client on the PersistentPut if this is a persistent request
Persistence
connection,
reboot,
forever
 No connection Whether the insert stays on the queue across new client connections, freenet restarts, or forever
TargetFilename A filename (no slashes) No Extracted from URI or Filename Filename to be appended to a CHK insert. Technically it creates a one-file manifest with this filename pointing to the file being uploaded. Ignored for all types other than CHK, since other types have human-readable filenames anyway. Empty means no filename.
EarlyEncode false, true No False Whether to aggressively encode the file's data in order to produce a key earlier (way before it would be fetchable; not generally recommended but useful for testing).
""
Followed by one or more of the following items:
""


































Data item
Field Possible values Mandatory? Description
Files.N.Name Yes Name under which the item can be retrieved under the key. May contain slashes to indicate subfolders
Files.N.UploadFrom direct Yes
Files.N.DataLength integer Yes Number of bytes of data associated to the item
Files.N.Metadata.ContentType Any MIME type No The MIME type of the data being inserted. For text, if charset is not specified, node should auto-detect it and force the auto-detected version
""
""




























File item
Field Possible values Mandatory? Description
Files.N.Name Yes Name under which the item can be retrieved under the key. May contain slashes to indicate subfolders
Files.N.UploadFrom disk Yes
Files.N.Metadata.ContentType Any MIME type No The MIME type of the data being inserted. For text, if charset is not specified, node should auto-detect it and force the auto-detected version
""
""



























Redirect item
Field Possible values Mandatory? Description
Files.N.Name Yes Name under which the item can be retrieved under the key. May contain slashes to indicate subfolders
Files.N.UploadFrom redirect Yes
Files.N.TargetURI Yes Freenet Uri to redirect to
""
-------------------------------------------------------------------------------------------------------
====Details=====
Deletions:
This is a message of the [[FreenetFCPSpec2Point0 Freenet Client Protocol 2.0]] (FCP 2.0).
It is sent from a client program to the Freenet node.
This inserts an arbitrary number of data items, either as files, data inserted directly into the message, or redirects. Like the [[FCP2p0ClientPutDiskDir ClientPutDiskDir]] command, all of the files are inserted under a single key (technically, as a manifest file), so that each of the inserted files is located using the same key like this:
""CHK@NOSdw7FF88S....4BgOPxSPqv~bNg7YsgM,AAEC--8/file1.txt""
""CHK@NOSdw7FF88S....4BgOPxSPqv~bNg7YsgM,AAEC--8/file2.jpg""
""CHK@NOSdw7FF88S....4BgOPxSPqv~bNg7YsgM,AAEC--8/subdir/file3.html""
""CHK@NOSdw7FF88S....4BgOPxSPqv~bNg7YsgM,AAEC--8/subdir/file4.ogg""
""CHK@NOSdw7FF88S....4BgOPxSPqv~bNg7YsgM,AAEC--8/foo/bar/file5.pdf""
The MIME types (**""Metadata.ContentType""**) are automatically detected if you don't specify them explicitly.
As you can see, **""ClientPutComplexDir""** is somewhat more complex, but also far more flexible, than [[FCP2p0ClientPutDiskDir ClientPutDiskDir]]. Note that the numbers under **Files** must start at zero and advance sequentially, and that the data for any **""UploadFrom=direct""** files will be read in that order at the end of the message.
**TODO**
Indicate which of the 'keyword=value' lines below are mandatory, and if not, what their defaults are
==Example==
Identifier=My Identifier
Verbosity=1023
MaxRetries=999
PriorityClass=2
URI=SSK@Fk6sQ6...../myinsert-4/
GetCHKOnly=false
DontCompress=true
ClientToken=My Client Token
Persistence=reboot
Global=true
DefaultName=hello.txt
Files.0.Name=hello.txt
Files.0.UploadFrom=direct
Files.0.Metadata.ContentType=text/plain
Files.0.DataLength=59
Files.1.Name=something.pdf
Files.1.UploadFrom=disk
Files.1.Filename=something.pdf
Files.2.Name=gpl.txt
Files.2.UploadFrom=redirect
Files.2.TargetURI=KSK@sample.txt
hello, this is the contents
of the file called "hello.txt"

Revision [2135]

Edited on 2007-07-14 19:25:00 by NextGens [#1535: Remove all references to KSK@gpl.txt on the website]
Additions:
Files.2.TargetURI=KSK@sample.txt
Deletions:
Files.2.TargetURI=KSK@gpl.txt

Revision [1940]

Edited on 2007-03-30 21:50:49 by AlexLehm [typo]
Additions:
This inserts an arbitrary number of data items, either as files, data inserted directly into the message, or redirects. Like the [[FCP2p0ClientPutDiskDir ClientPutDiskDir]] command, all of the files are inserted under a single key (technically, as a manifest file), so that each of the inserted files is located using the same key like this:
Deletions:
This inserts an arbitrary number of data items, either as files, data inserted directly into the message, or redirects. Like the [[FCP2p0ClientPutDiskDir CliejntPutDiskDir]] command, all of the files are inserted under a single key (technically, as a manifest file), so that each of the inserted files is located using the same key like this:

Revision [1713]

Edited on 2007-01-17 09:40:34 by MosTeo [Changed End to EndMessage after verifying it]
Additions:
EndMessage
Deletions:
Why End and not EndMessage before the data like in [[FCP2p0ClientPut ClientPut]]?
End

Revision [1706]

Edited on 2007-01-12 13:21:14 by MosTeo [End or EndMessage?]
Additions:
**TODO**
Indicate which of the 'keyword=value' lines below are mandatory, and if not, what their defaults are
Why End and not EndMessage before the data like in [[FCP2p0ClientPut ClientPut]]?
Deletions:
**TODO** - Indicate which of the 'keyword=value' lines below are mandatory, and if not, what their defaults are

Revision [1303]

Edited on 2006-08-03 21:45:14 by JaQa
Additions:
The MIME types (**""Metadata.ContentType""**) are automatically detected if you don't specify them explicitly.
Deletions:
The MIME types are automatically detected if you don't specify them explicitly.

Revision [1302]

The oldest known version of this page was created on 2006-08-03 21:44:22 by JaQa
Valid XHTML 1.0 Transitional :: Valid CSS :: Powered by WikkaWiki