Interface | Description |
---|---|
FCPPluginConnection |
An FCP connection between:
- a fred plugin which provides its services by a FCP server. - a client application which uses those services. |
RequestCompletionCallback |
Class | Description |
---|---|
AddPeer | |
AllDataMessage |
All the data, all in one big chunk.
|
BaseDataCarryingMessage | |
BookmarkFeed | |
ClientGet |
A simple client fetch.
|
ClientGetMessage |
ClientGet message.
|
ClientHelloMessage |
ClientHello
Name=Toad's Test Client
ExpectedVersion=0.7.0
End
|
ClientPut | |
ClientPutBase |
Base class for ClientPut and ClientPutDir.
|
ClientPutComplexDirMessage |
ClientPutComplexDir
< ...
|
ClientPutDir | |
ClientPutDirMessage |
Put a directory, rather than a file.
|
ClientPutDiskDirMessage |
Insert a directory from disk as a manifest.
|
ClientPutMessage |
ClientPut
URI=CHK@ // could as easily be an insertable SSK URI
Metadata.ContentType=text/html
Identifier=Insert-1 // identifier, as always
Verbosity=0 // just report when complete
MaxRetries=999999 // lots of retries
PriorityClass=1 // FProxy priority level
UploadFrom=direct // attached directly to this message
DataLength=100 // 100kB
or
UploadFrom=disk // upload a file from disk
Filename=/home/toad/something.html
FileHash=021349568329403123
Data
Neither IgnoreDS nor DSOnly make sense for inserts.
|
ClientRequest |
A request process carried out by the node for an FCP client.
|
CloseConnectionDuplicateClientNameMessage |
Error sent when the connection is closed because another connection with the same
client Name has been opened.
|
CompatibilityMode | |
ConfigData | |
DataCarryingMessage | |
DataFoundMessage | |
DirectDirPutFile |
Specialized DirPutFile for direct uploads.
|
DisconnectMessage |
Message that disconnects a client.
|
DiskDirPutFile | |
DownloadRequestStatus |
Cached status of a download of a file i.e.
|
EndListPeerNotesMessage | |
EndListPeersMessage | |
EndListPersistentRequestsMessage | |
EnterFiniteCooldown |
Status message sent when the whole of a request is waiting for a cooldown.
|
ExpectedDataLength | |
ExpectedHashes | |
ExpectedMIME | |
FCPClientRequestClient | |
FCPConnectionHandler | |
FCPConnectionHandler.DDACheckJob | |
FCPConnectionInputHandler | |
FCPConnectionOutputHandler | |
FCPMessage | |
FCPPluginClientMessage |
This class parses the network format for a FCP message which is send from a FCP client
to a FCP server plugin.
It is the inverse of FCPPluginServerMessage which produces the on-network format of
server to client messages.There is a similar class FCPPluginMessage which serves as a container of FCP plugin
messages which are produced and consumed by the actual server and client plugin implementations. |
FCPPluginMessage |
Container class for both incoming and outgoing FCP messages.
|
FCPPluginServerMessage |
This class produces the network format for a FCP message which is send from a FCP server
plugin to a FCP client.
It is the inverse of FCPPluginClientMessage which parses the on-network format of client
to server messages.There is a similar class FCPPluginMessage which serves as a container of FCP plugin
messages which are produced and consumed by the actual server and client plugin implementations. |
FCPResponse |
FCP message sent from the node to the client.
|
FCPServer |
FCP server process.
|
FeedMessage | |
FilterMessage |
Message for testing the content filter on a file.
|
FilterResultMessage |
Carries the result of a content filter test back to the client.
|
FinishedCompressionMessage | |
GeneratedMetadataMessage | |
GenerateSSKMessage | |
GetConfig | |
GetFailedMessage | |
GetNode | |
GetPluginInfo |
can find a plugin that implements FredPluginFCP
|
GetRequestStatusMessage | |
IdentifierCollisionMessage | |
ListPeerMessage | |
ListPeerNotesMessage | |
ListPeersMessage | |
ListPersistentRequestsMessage | |
ListPersistentRequestsMessage.ListJob | |
ListPersistentRequestsMessage.PersistentListJob | |
ListPersistentRequestsMessage.TransientListJob | |
LoadPlugin |
load a plugin
|
ModifyConfig | |
ModifyPeer | |
ModifyPeerNote | |
ModifyPersistentRequest |
FCP message: Modify a persistent request.
|
MultipleDataCarryingMessage | |
N2NFeedMessage | |
NodeData | |
NodeHelloMessage |
NodeHello
NodeHello
FCPVersion=
|
PeerMessage | |
PeerNote | |
PeerRemoved | |
PersistentGet |
Sent by the node to a client when it asks for a list of current requests.
|
PersistentPut | |
PersistentPutDir | |
PersistentRequestClient |
An FCP client.
|
PersistentRequestModifiedMessage |
Node answer message after a ModifyPerPersistentRequest message from client.
|
PersistentRequestRemovedMessage |
Node answer message after a RemovePersistentRequest message from client.
|
PersistentRequestRoot |
Tracks persistent requests by PersistentRequestClient.
|
PluginInfoMessage | |
PluginRemovedMessage | |
ProbeBandwidth |
FCP message sent from the node to the client which includes outgoing bandwidth limit returned by the endpoint.
|
ProbeBuild |
FCP message sent from the node to the client which includes build / main version returned by the endpoint.
|
ProbeError |
FCP message sent from the node to the client which indicates that an error has occurred.
|
ProbeIdentifier |
FCP message sent from the node to the client which includes an endpoint identifier and uptime information.
|
ProbeLinkLengths |
FCP message sent from the node to the client which includes link lengths reported by the endpoint.
|
ProbeLocation |
FCP message sent from the node to the client which includes the location reported by the endpoint.
|
ProbeOverallBulkOutputCapacityUsage | |
ProbeRefused |
FCP message sent from the node to the client which indicates that the endpoint has opted not to respond to the
request type.
|
ProbeRejectStats | |
ProbeRequest |
FCP Message which is received from a client and requests a network probe of a specific type.
|
ProbeStoreSize |
FCP message sent from the node to the client which includes store size returned by the endpoint.
|
ProbeUptime |
FCP message sent from the node to the client which includes uptime information returned by the endpoint.
|
ProtocolErrorMessage |
ProtocolError (some problem parsing the other side's FCP messages, or other
problem not related to Freenet)
ProtocolError
Code=1
CodeDescription=ClientHello must be first message
ExtraDescription=Duh
Fatal=false // means the connection stays open
[Identifier=
|
PutFailedMessage | |
PutFetchableMessage | |
PutSuccessfulMessage | |
RedirectDirPutFile | |
ReloadPlugin |
reload a plugin
|
RemovePeer | |
RemovePersistentRequest |
Client telling node to remove a (completed or not) persistent request.
|
RemovePlugin |
remove a plugin
|
RequestIdentifier |
Identifies a request and its client.
|
RequestStatus |
The status of a request.
|
RequestStatusCache |
Per-PersistentRequestClient cache of status of requests.
|
SendBookmarkMessage | |
SendingToNetworkMessage | |
SendPeerMessage | |
SendTextMessage | |
SendURIMessage | |
SentPeerMessage | |
ShutdownMessage | |
SimpleProgressMessage | |
SSKKeypairMessage | |
StartedCompressionMessage | |
SubscribedUSKMessage |
Sent by the node back to the client after it receives a SubscribeUSK message.
|
SubscribedUSKRoundFinishedMessage | |
SubscribedUSKSendingToNetworkMessage | |
SubscribedUSKUpdate | |
SubscribeUSK | |
SubscribeUSKMessage |
Sent by a client to subscribe to a USK.
|
TestDDACompleteMessage |
client -> node: DDARequest { WantRead=true, WantWrite=true, Dir=/tmp/blah }
node -> client: DDAReply { Dir=/tmp/blah, ReadFilename=random1, WriteFilename=random2, ContentToWrite=random3 }
client -> node: DDAResponse { Dir=/tmp/blah, ReadContent=blah }
node -> client: DDAComplete { Dir=/tmp/blah, ReadAllowed=true, WriteAllowed=true }
|
TestDDAReplyMessage |
client -> node: DDARequest { WantRead=true, WantWrite=true, Dir=/tmp/blah }
node -> client: DDAReply { Dir=/tmp/blah, ReadFilename=random1, WriteFilename=random2, ContentToWrite=random3 }
client -> node: DDAResponse { Dir=/tmp/blah, ReadContent=blah }
node -> client: DDAComplete { Dir=/tmp/blah, ReadAllowed=true, WriteAllowed=true }
|
TestDDARequestMessage |
client -> node: DDARequest { WantRead=true, WantWrite=true, Dir=/tmp/blah }
node -> client: DDAReply { Dir=/tmp/blah, ReadFilename=random1, WriteFilename=random2, ContentToWrite=random3 }
client -> node: DDAResponse { Dir=/tmp/blah, ReadContent=blah }
node -> client: DDAComplete { Dir=/tmp/blah, ReadAllowed=true, WriteAllowed=true }
|
TestDDAResponseMessage |
client -> node: DDARequest { WantRead=true, WantWrite=true, Dir=/tmp/blah }
node -> client: DDAReply { Dir=/tmp/blah, ReadFilename=random1, WriteFilename=random2, ContentToWrite=random3 }
client -> node: DDAResponse { Dir=/tmp/blah, ReadContent=blah }
node -> client: DDAComplete { Dir=/tmp/blah, ReadAllowed=true, WriteAllowed=true }
|
TextFeedMessage | |
UnknownNodeIdentifierMessage | |
UnknownPeerNoteTypeMessage | |
UnsubscribeUSKMessage | |
UploadDirRequestStatus | |
UploadFileRequestStatus |
Cached status of a file upload
|
UploadRequestStatus |
Base class for cached status of uploads
|
URIFeedMessage | |
URIGeneratedMessage | |
WatchFeedsMessage | |
WatchGlobal |
Enum | Description |
---|---|
ClientGet.ReturnType | |
ClientPut.COMPRESS_STATE | |
ClientPutBase.UploadFrom | |
ClientRequest.Persistence | |
DataSource | |
FCPPluginConnection.SendDirection |
The send functions are fully symmetrical: They work the same way no matter whether client
is sending to server or server is sending to client.
Thus, to prevent us from having to duplicate the send functions, this enum specifies in which situation we are. |
FCPPluginMessage.ClientPermissions |
Exception | Description |
---|---|
IdentifierCollisionException |
Thrown to indicate reuse of an Identifier.
|
MessageInvalidException |
Thrown when an FCP message is invalid.
|
NotAllowedException |
Thrown when a client tries to upload a file it's not allowed to upload (or otherwise read it), or
download to a file which it's not allowed to download to (or otherwise write to).
|
uses this, but we don't have a proper official Java
FCP library.