freenet.clients.fcp

Class FCPPluginClientMessage

java.lang.Object

freenet.clients.fcp.FCPMessage

freenet.clients.fcp.BaseDataCarryingMessage

freenet.clients.fcp.DataCarryingMessage

freenet.clients.fcp.FCPPluginClientMessage

public class FCPPluginClientMessage
extends DataCarryingMessage

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. Consider this class here as an internal representation of FCP plugin messages used solely for parsing client-to-server messages, while the other one is the external representation used for both server and client messages. Also notice that interface FCPPluginConnection consumes only objects of type FCPPluginMessage, not of this class here: As the external representation to both server and client, it does not care whether a message is from the server or the client, and is only interested in the external representation FCPPluginMessage of the message.

ATTENTION: The on-network name of this message is different: It is "FCPPluginMessage". The class previously had the same name but it was decided to rename it to fix the name clash with the aforementioned external representation class FCPPluginMessage. To stay backward compatible, it was decided to keep the raw network message name as is.
TODO: Would it technically be possible to add a second name to the on-network data so we can get rid of the old name after a transition period?

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME On-network format name of the message.
static java.lang.String	PARAM_PREFIX

Fields inherited from class freenet.clients.fcp.DataCarryingMessage

bucket, freeOnSent

Fields inherited from class freenet.clients.fcp.FCPMessage

BUILD, BULK_CHK_INSERT_REJECTS, BULK_CHK_REQUEST_REJECTS, BULK_SSK_INSERT_REJECTS, BULK_SSK_REQUEST_REJECTS, CODE, HTL, IDENTIFIER, LINK_LENGTHS, LOCAL, LOCATION, OUTPUT_BANDWIDTH, OUTPUT_BANDWIDTH_CLASS, OVERALL_BULK_OUTPUT_CAPACITY_USAGE, PROBE_IDENTIFIER, STORE_SIZE, TYPE, UPTIME_PERCENT

Method Summary

Modifier and Type	Method and Description
protected FCPPluginMessage	constructFCPPluginMessage()
SimpleFieldSet	getFieldSet()
java.lang.String	getName()
void	run(FCPConnectionHandler handler, Node node) Do whatever it is that we do with this type of message.

Methods inherited from class freenet.clients.fcp.DataCarryingMessage

getRandomAccessBucket, readFrom, writeData

Methods inherited from class freenet.clients.fcp.BaseDataCarryingMessage

send

Methods inherited from class freenet.clients.fcp.FCPMessage

create, create, withListRequestIdentifier

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final java.lang.String NAME

On-network format name of the message. ATTENTION: This one is different to the class name. For an explanation, see the class-level JavaDoc FCPPluginClientMessage.

See Also:

Constant Field Values

PARAM_PREFIX

public static final java.lang.String PARAM_PREFIX

See Also:

Constant Field Values

Method Detail

getFieldSet

public SimpleFieldSet getFieldSet()

Specified by:

getFieldSet in class FCPMessage

getName

public java.lang.String getName()

Specified by:

getName in class FCPMessage

constructFCPPluginMessage

protected FCPPluginMessage constructFCPPluginMessage()

run

public void run(FCPConnectionHandler handler,
                Node node)
         throws MessageInvalidException

Description copied from class: FCPMessage

Do whatever it is that we do with this type of message.

Specified by:

run in class FCPMessage

Throws:

MessageInvalidException