/**
* A high-level client that allows simple yet full-featured access to a Freenet
* node.
- *
+ *
* @author David ‘Bombe’ Roden <bombe@freenetproject.org>
* @version $Id$
*/
/**
* Creates a new high-level client that connects to a node on
* <code>localhost</code>.
- *
+ *
* @param clientName
* The name of the client
* @throws UnknownHostException
/**
* Creates a new high-level client that connects to a node on the given
* host.
- *
+ *
* @param clientName
* The name of the client
* @param host
/**
* Creates a new high-level client that connects to a node on the given
* host.
- *
+ *
* @param clientName
* The name of the client
* @param host
/**
* Creates a new high-level client that connects to a node at the given
* address.
- *
+ *
* @param clientName
* The name of the client
* @param address
// ACCESSORS
//
+ /**
+ * Returns the FCP connection that backs this high-level client. This method
+ * should be used with care as fiddling around with the FCP connection can
+ * easily break the high-level client if you don’t know what you’re doing!
+ *
+ * @return The FCP connection of this client
+ */
+ public FcpConnection getFcpConnection() {
+ return fcpConnection;
+ }
+
//
// ACTIONS
//
/**
* Connects the client.
- *
+ *
* @return A callback with a connection result
* @throws IOException
* if an I/O error occurs communicating with the node
* Disconnects the client from the node.
*/
public void disconnect() {
+ fcpConnection.close();
}
/**
* Generates a new SSK keypair.
- *
+ *
* @return A callback with the keypair
* @throws IOException
* if an I/O error occurs communicating with the node
/**
* Gets a list of all peers from the node.
- *
+ *
* @return A callback with the peer list
* @throws IOException
* if an I/O error occurs with the node
/**
* Adds the peer whose noderef is stored in the given file.
- *
+ *
* @param nodeRefFile
* The name of the file the peer’s noderef is stored in
* @return A peer callback
/**
* Adds the peer whose noderef is stored in the given file.
- *
+ *
* @param nodeRefURL
* The URL where the peer’s noderef is stored
* @return A peer callback
/**
* Adds the peer whose noderef is stored in the given file.
- *
+ *
* @param nodeRef
* The peer’s noderef
* @return A peer callback
* Checks whether direct disk access for the given directory is possible.
* You have to perform this check before you can upload or download anything
* from or the disk directly!
- *
+ *
* @param directory
* The directory to check
* @param wantRead
* Starts a download. Files can either be download to disk or streamed from
* the node. When downloading to disk you have to perform a direct disk
* access check for the directory you want to put the downloaded file in!
- *
+ *
* @see #checkDirectDiskAccess(String, boolean, boolean)
* @param uri
* The URI to get
/**
* Generates an identifier for the given function.
- *
+ *
* @param function
* The name of the function
* @return An identifier
/**
* FCP listener for {@link HighLevelClient}.
- *
+ *
* @author David ‘Bombe’ Roden <bombe@freenetproject.org>
* @version $Id$
*/
* Creates a new FCP listener for {@link HighLevelClient}.
*/
HighLevelClientFcpListener() {
+ /* do nothing. */
}
//
/**
* Searches all callback collections for a callback with the given
* identifier and cancels it.
- *
+ *
* @param identifier
* The identifier to search for, or <code>null</code> to
* cancel all pending requests
/**
* Reads the given file and returns the first line of the file.
- *
+ *
* @param readFilename
* The name of the file to read
* @return The content of the file
/**
* Writes the given content to the given file.
- *
+ *
* @param directDiskAccessResult
* The DDA result
* @param writeFilename
/**
* Cleans up any files that written for the given result.
- *
+ *
* @param directDiskAccessResult
* The direct disk access result
*/
* net.pterodactylus.fcp.AllData)
*/
public void receivedAllData(FcpConnection fcpConnection, AllData allData) {
+ /* TODO */
}
/**
* net.pterodactylus.fcp.CloseConnectionDuplicateClientName)
*/
public void receivedCloseConnectionDuplicateClientName(FcpConnection fcpConnection, CloseConnectionDuplicateClientName closeConnectionDuplicateClientName) {
+ /* TODO */
}
/**
* net.pterodactylus.fcp.ConfigData)
*/
public void receivedConfigData(FcpConnection fcpConnection, ConfigData configData) {
+ /* TODO */
}
/**
* net.pterodactylus.fcp.DataFound)
*/
public void receivedDataFound(FcpConnection fcpConnection, DataFound dataFound) {
+ /* TODO */
}
/**
* net.pterodactylus.fcp.EndListPeerNotes)
*/
public void receivedEndListPeerNotes(FcpConnection fcpConnection, EndListPeerNotes endListPeerNotes) {
+ /* TODO */
}
/**
* net.pterodactylus.fcp.EndListPersistentRequests)
*/
public void receivedEndListPersistentRequests(FcpConnection fcpConnection, EndListPersistentRequests endListPersistentRequests) {
+ /* TODO */
}
/**
* net.pterodactylus.fcp.FCPPluginReply)
*/
public void receivedFCPPluginReply(FcpConnection fcpConnection, FCPPluginReply fcpPluginReply) {
+ /* TODO */
}
/**
* net.pterodactylus.fcp.IdentifierCollision)
*/
public void receivedIdentifierCollision(FcpConnection fcpConnection, IdentifierCollision identifierCollision) {
+ /* TODO */
}
/**
* net.pterodactylus.fcp.FcpMessage)
*/
public void receivedMessage(FcpConnection fcpConnection, FcpMessage fcpMessage) {
+ /* TODO */
}
/**
* net.pterodactylus.fcp.NodeData)
*/
public void receivedNodeData(FcpConnection fcpConnection, NodeData nodeData) {
+ /* TODO */
}
/**
* net.pterodactylus.fcp.PeerNote)
*/
public void receivedPeerNote(FcpConnection fcpConnection, PeerNote peerNote) {
+ /* TODO */
}
/**
* net.pterodactylus.fcp.PeerRemoved)
*/
public void receivedPeerRemoved(FcpConnection fcpConnection, PeerRemoved peerRemoved) {
+ /* TODO */
}
/**
* net.pterodactylus.fcp.PersistentPut)
*/
public void receivedPersistentPut(FcpConnection fcpConnection, PersistentPut persistentPut) {
+ /* TODO */
}
/**
* net.pterodactylus.fcp.PersistentPutDir)
*/
public void receivedPersistentPutDir(FcpConnection fcpConnection, PersistentPutDir persistentPutDir) {
+ /* TODO */
}
/**
* net.pterodactylus.fcp.PersistentRequestModified)
*/
public void receivedPersistentRequestModified(FcpConnection fcpConnection, PersistentRequestModified persistentRequestModified) {
+ /* TODO */
}
/**
* net.pterodactylus.fcp.PersistentRequestRemoved)
*/
public void receivedPersistentRequestRemoved(FcpConnection fcpConnection, PersistentRequestRemoved persistentRequestRemoved) {
+ /* TODO */
}
/**
* net.pterodactylus.fcp.PluginInfo)
*/
public void receivedPluginInfo(FcpConnection fcpConnection, PluginInfo pluginInfo) {
+ /* TODO */
}
/**
* net.pterodactylus.fcp.PutFailed)
*/
public void receivedPutFailed(FcpConnection fcpConnection, PutFailed putFailed) {
+ /* TODO */
}
/**
* net.pterodactylus.fcp.PutFetchable)
*/
public void receivedPutFetchable(FcpConnection fcpConnection, PutFetchable putFetchable) {
+ /* TODO */
}
/**
* net.pterodactylus.fcp.PutSuccessful)
*/
public void receivedPutSuccessful(FcpConnection fcpConnection, PutSuccessful putSuccessful) {
+ /* TODO */
}
/**
* net.pterodactylus.fcp.StartedCompression)
*/
public void receivedStartedCompression(FcpConnection fcpConnection, StartedCompression startedCompression) {
+ /* TODO */
}
/**
* net.pterodactylus.fcp.SubscribedUSKUpdate)
*/
public void receivedSubscribedUSKUpdate(FcpConnection fcpConnection, SubscribedUSKUpdate subscribedUSKUpdate) {
+ /* TODO */
}
/**
* net.pterodactylus.fcp.URIGenerated)
*/
public void receivedURIGenerated(FcpConnection fcpConnection, URIGenerated uriGenerated) {
+ /* TODO */
}
/**
* net.pterodactylus.fcp.UnknownNodeIdentifier)
*/
public void receivedUnknownNodeIdentifier(FcpConnection fcpConnection, UnknownNodeIdentifier unknownNodeIdentifier) {
+ /* TODO */
}
/**
* net.pterodactylus.fcp.UnknownPeerNoteType)
*/
public void receivedUnknownPeerNoteType(FcpConnection fcpConnection, UnknownPeerNoteType unknownPeerNoteType) {
+ /* TODO */
}
/**
* net.pterodactylus.fcp.FinishedCompression)
*/
public void receviedFinishedCompression(FcpConnection fcpConnection, FinishedCompression finishedCompression) {
+ /* TODO */
}
}
projects / jFCPlib.git / blobdiff