freenet.clients.fcp

Class FCPMessage

java.lang.Object

freenet.clients.fcp.FCPMessage

Direct Known Subclasses:

AddPeer, BaseDataCarryingMessage, ClientHelloMessage, CloseConnectionDuplicateClientNameMessage, CompatibilityMode, ConfigData, DataFoundMessage, DisconnectMessage, EndListPeerNotesMessage, EndListPeersMessage, EndListPersistentRequestsMessage, EnterFiniteCooldown, ExpectedDataLength, ExpectedHashes, ExpectedMIME, FCPResponse, FinishedCompressionMessage, GenerateSSKMessage, GetConfig, GetFailedMessage, GetNode, GetPluginInfo, GetRequestStatusMessage, IdentifierCollisionMessage, ListPeerMessage, ListPeerNotesMessage, ListPeersMessage, ListPersistentRequestsMessage, LoadPlugin, ModifyConfig, ModifyPeer, ModifyPeerNote, ModifyPersistentRequest, NodeData, NodeHelloMessage, PeerMessage, PeerNote, PeerRemoved, PersistentGet, PersistentPut, PersistentPutDir, PersistentRequestModifiedMessage, PersistentRequestRemovedMessage, PluginInfoMessage, PluginRemovedMessage, ProbeRequest, ProtocolErrorMessage, PutFailedMessage, PutFetchableMessage, PutSuccessfulMessage, ReloadPlugin, RemovePeer, RemovePersistentRequest, RemovePlugin, SendingToNetworkMessage, SentPeerMessage, ShutdownMessage, SimpleProgressMessage, SSKKeypairMessage, StartedCompressionMessage, SubscribedUSKMessage, SubscribedUSKRoundFinishedMessage, SubscribedUSKSendingToNetworkMessage, SubscribedUSKUpdate, SubscribeUSKMessage, TestDDACompleteMessage, TestDDAReplyMessage, TestDDARequestMessage, TestDDAResponseMessage, UnknownNodeIdentifierMessage, UnknownPeerNoteTypeMessage, UnsubscribeUSKMessage, URIGeneratedMessage, WatchFeedsMessage, WatchGlobal

public abstract class FCPMessage
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BUILD
static java.lang.String	BULK_CHK_INSERT_REJECTS
static java.lang.String	BULK_CHK_REQUEST_REJECTS
static java.lang.String	BULK_SSK_INSERT_REJECTS
static java.lang.String	BULK_SSK_REQUEST_REJECTS
static java.lang.String	CODE
static java.lang.String	HTL
static java.lang.String	IDENTIFIER
static java.lang.String	LINK_LENGTHS
static java.lang.String	LOCAL
static java.lang.String	LOCATION
static java.lang.String	OUTPUT_BANDWIDTH
static java.lang.String	OUTPUT_BANDWIDTH_CLASS
static java.lang.String	OVERALL_BULK_OUTPUT_CAPACITY_USAGE
static java.lang.String	PROBE_IDENTIFIER
static java.lang.String	STORE_SIZE
static java.lang.String	TYPE
static java.lang.String	UPTIME_PERCENT

Constructor Summary

Constructors

Constructor and Description
FCPMessage()

Method Summary

Modifier and Type	Method and Description
static FCPMessage	create(java.lang.String name, SimpleFieldSet fs) Create a message from a SimpleFieldSet, and the message's name, if possible.
static FCPMessage	create(java.lang.String name, SimpleFieldSet fs, BucketFactory bfTemp, PersistentTempBucketFactory bfPersistent) Create a message from a SimpleFieldSet, and the message's name, if possible.
abstract SimpleFieldSet	getFieldSet()
abstract java.lang.String	getName()
abstract void	run(FCPConnectionHandler handler, Node node) Do whatever it is that we do with this type of message.
void	send(java.io.OutputStream os)
static FCPMessage	withListRequestIdentifier(FCPMessage fcpMessage, java.lang.String listRequestIdentifier) Returns an FCP message that delegates the methods getFieldSet(), getName(), and run(FCPConnectionHandler, Node) to the given FCP message, adding a “ListRequestIdentifier” field to the SimpleFieldSet returned by getFieldSet().

Methods inherited from class java.lang.Object

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

Field Detail

BUILD

public static final java.lang.String BUILD

See Also:

Constant Field Values

CODE

public static final java.lang.String CODE

See Also:

Constant Field Values

HTL

public static final java.lang.String HTL

See Also:

Constant Field Values

IDENTIFIER

public static final java.lang.String IDENTIFIER

See Also:

Constant Field Values

LINK_LENGTHS

public static final java.lang.String LINK_LENGTHS

See Also:

Constant Field Values

LOCAL

public static final java.lang.String LOCAL

See Also:

Constant Field Values

LOCATION

public static final java.lang.String LOCATION

See Also:

Constant Field Values

OUTPUT_BANDWIDTH

public static final java.lang.String OUTPUT_BANDWIDTH

See Also:

Constant Field Values

PROBE_IDENTIFIER

public static final java.lang.String PROBE_IDENTIFIER

See Also:

Constant Field Values

STORE_SIZE

public static final java.lang.String STORE_SIZE

See Also:

Constant Field Values

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

UPTIME_PERCENT

public static final java.lang.String UPTIME_PERCENT

See Also:

Constant Field Values

BULK_CHK_REQUEST_REJECTS

public static final java.lang.String BULK_CHK_REQUEST_REJECTS

See Also:

Constant Field Values

BULK_SSK_REQUEST_REJECTS

public static final java.lang.String BULK_SSK_REQUEST_REJECTS

See Also:

Constant Field Values

BULK_CHK_INSERT_REJECTS

public static final java.lang.String BULK_CHK_INSERT_REJECTS

See Also:

Constant Field Values

BULK_SSK_INSERT_REJECTS

public static final java.lang.String BULK_SSK_INSERT_REJECTS

See Also:

Constant Field Values

OUTPUT_BANDWIDTH_CLASS

public static final java.lang.String OUTPUT_BANDWIDTH_CLASS

See Also:

Constant Field Values

OVERALL_BULK_OUTPUT_CAPACITY_USAGE

public static final java.lang.String OVERALL_BULK_OUTPUT_CAPACITY_USAGE

See Also:

Constant Field Values

Constructor Detail

FCPMessage

public FCPMessage()

Method Detail

send

public void send(java.io.OutputStream os)
          throws java.io.IOException

Throws:

java.io.IOException

getFieldSet

public abstract SimpleFieldSet getFieldSet()

getName

public abstract java.lang.String getName()

create

public static FCPMessage create(java.lang.String name,
                                SimpleFieldSet fs,
                                BucketFactory bfTemp,
                                PersistentTempBucketFactory bfPersistent)
                         throws MessageInvalidException

Create a message from a SimpleFieldSet, and the message's name, if possible.

Throws:

MessageInvalidException

create

public static FCPMessage create(java.lang.String name,
                                SimpleFieldSet fs)
                         throws MessageInvalidException

Create a message from a SimpleFieldSet, and the message's name, if possible. Useful for FCPClients

Throws:

MessageInvalidException

withListRequestIdentifier

public static FCPMessage withListRequestIdentifier(FCPMessage fcpMessage,
                                                   java.lang.String listRequestIdentifier)

Returns an FCP message that delegates the methods getFieldSet(), getName(), and run(FCPConnectionHandler, Node) to the given FCP message, adding a “ListRequestIdentifier” field to the SimpleFieldSet returned by getFieldSet().

Parameters:

fcpMessage - The FCP message to wrap

listRequestIdentifier - The list request identifier to add (may be null in which case nothing is added)

Returns:

The new FCP message

run

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

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

Throws:

MessageInvalidException