FCPv2 FCPPluginMessage (old)

FCPPluginMessage will send a message to a loaded plugin.

The plugin can reply to a message, and the reply will be returned as an FCPPluginReply to the FCP client that sent the original message.

This is accurate for clients implementing FCP handling through the old fred/src/freenet/support/plugins/helpers1/AbstractFCPHandler.java interface. e.g. KeyUtils.

Example

FCPPluginMessage
Identifier=fcp-plugin-message-123
PluginName=com.example.plugin
Param.Command=test
Param.Identifier=inner-plugin-message-123
Param.Verbose=true
EndMessage

Details

Field	Possible values	Mandatory	Default	Description
Identifier	Arbitrary text string	Yes		This is for the client to be able to identify responses from the node, not the plugin.
PluginName	Main class name of the plugin	Yes		The destination plugin’s main class name, as shown in the Configurations -> Plugin page.
DataLength	Length of the (optional) data following the message	Yes, if the FCP message is terminated with “Data” instead of “EndMessage”		Length of the optional data that follows the message. Must be included if FCP message is terminated with “Data,” must not be included if FCP message is terminated with “EndMessage.”
Param.Command	Arbitrary text string	Yes		e.g. Param.Command=Get The Get part is equivalent to the FCP message name, e.g. ClientHello, or FCPPluginMessage, and is specific to the plugin being addressed.
Param.Identifier	Arbitrary text string	Yes		This is for the client to be able to identify responses from the plugin, not the node.
Param.parameter=value	Arbitrary parameter for the receiving plugin	No		Parameter for the receiving the plugin. This field (with changing values of parameter) can be repeated as often as necessary, and the contents are specific to the plugin.