On Wed, 22 Jul 2009 22:26:23 +0200
David ?Bombe? Roden <bombe at pterodactylus.net> wrote:

> On Friday 03 July 2009 00:31:56 Matthew Toseland wrote:
> 
> > Subscribe/UnsubscribeFeed etc etc should eventually be documented on the
> > wiki.
> 
> Absolutely! I?m pretty much dying to know how that stuff works, and I need to 
> know because I have to integrate it into jFCPlib. :)
> 
> 
>       David

My plan is to write the documentation after August 10. That is the date
called "Suggested 'pencils down' date. Take a week to scrub code, write
tests, improve documentation, etc." in the GSoC-timeline.

The following is a short description of how it works at the moment, it
is based on a mail I sent to toad some time ago. It isn't final and
is going to be improved in several ways. The base64-encoding is going
to be removed and it should also be possible to make feed-subscriptions
more granular.

Client to node

SendTextFeed
NodeIdentifier=identity, ip:port or name of a darknet peer
Text=Base64-encoded text
Identifier=Optional arbitrary text string
EndMessage

SendBookmarkFeed
NodeIdentifier=identity, ip:port or name of a darknet peer
URI=URI of the bookmark
Name=Name of the bookmark
Description=Optional base64-encoded description
HasActiveLink=Optional, true or false
Identifier=Optional arbitrary text string
EndMessage

SendDownloadFeed
NodeIdentifier=identity, ip:port or name of a darknet peer
URI=URI of the file
Description=Optional base64-encoded description
Identifier=Optional arbitrary text string
EndMessage

SubscribeFeeds
Identifier=Arbitrary text string
EndMessage

Node to client

SentFeed
Identifier=Optional identifier of the feed
NodeStatus=An integer between 1 and 14 as defined in PeerManager.
EndMessage

SubscribedFeed
Identifier=Identifier of the subscription
EndMessage

ReceivedTextFeed
Identifier=Identifier of a subscription
SourceNodeName=Name of the sender
TargetNodeName=Name of the receiver
ComposedTime=Unix timestamp of when the sender claims he composed it
SentTime=Unix timestamp of when the sender claims he sent it
ReceivedTime=Unix timestamp of when it was received
Text=Base64-encoded text
EndMessage

ReceivedBookmarkFeed
Identifier=Identifier of a subscription
SourceNodeName=Name of the sender
TargetNodeName=Name of the receiver
ComposedTime=Unix timestamp of when the sender claims he composed it
SentTime=Unix timestamp of when the sender claims he sent it
ReceivedTime=Unix timestamp of when it was received
URI=URI of the bookmark
Name=Name of the bookmark
Description=Optional base64-encoded description
EndMessage

ReceivedDownloadFeed
Identifier=Identifier of a subscription
SourceNodeName=Name of the sender
TargetNodeName=Name of the receiver
ComposedTime=Unix timestamp of when the sender claims he composed it
SentTime=Unix timestamp of when the sender claims he sent it
ReceivedTime=Unix timestamp of when it was received
URI=URI of the file
Description=Optional base64-encoded description
EndMessage

ReceivedStatusFeed
Identifier=Identifier of a subscription
TimeCreated=Unix timestamp of when the alert was registered
PriorityClass=Integer between 1 and 3
Header=Base64-encoding of the header of the alert
ShortText=Base64-encoding of the short text of the alert
Text=Base64-encoding of the text of the alert
EndMessage
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 197 bytes
Desc: not available
URL: 
<https://emu.freenetproject.org/pipermail/devl/attachments/20090723/233397d7/attachment.pgp>

Reply via email to