freenet.clients.fcp

Class ProbeRequest

java.lang.Object

freenet.clients.fcp.FCPMessage

freenet.clients.fcp.ProbeRequest

public class ProbeRequest
extends FCPMessage

FCP Message which is received from a client and requests a network probe of a specific type.

• Identifier: Optional; identifier to match probe request with results.
• type: Mandatory; denotes the desired response type. Valid values are:
  • BANDWIDTH - returns outgoing bandwidth limit in KiB per second.
  • BUILD - returns Freenet build / main version.
  • IDENTIFIER - returns identifier and integer 7-day uptime percentage.
  • LINK_LENGTHS - returns link lengths between the endpoint and its connected peers.
  • LOCATION - returns the endpoint's location.
  • REJECT_STATS - returns CHK and SSK reject percentage for bulk inserts and bulk requests.
  • STORE_SIZE - returns store size in GiB.
  • UPTIME_48H - returns 48-hour uptime percentage.
  • UPTIME_7D - returns 7-day uptime percentage.
• hopsToLive: Optional; approximately how many hops the probe will take before possibly returning a result. Valid values are [1, Probe.MAX_HTL]. If omitted Probe.MAX_HTL is used.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

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

Constructor Summary

Constructors

Constructor and Description
ProbeRequest(SimpleFieldSet fs)

Method Summary

Modifier and Type	Method and Description
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.FCPMessage

create, create, send, 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

See Also:

Constant Field Values

Constructor Detail

ProbeRequest

public ProbeRequest(SimpleFieldSet fs)
             throws MessageInvalidException

Throws:

MessageInvalidException

Method Detail

getFieldSet

public SimpleFieldSet getFieldSet()

Specified by:

getFieldSet in class FCPMessage

getName

public java.lang.String getName()

Specified by:

getName in class FCPMessage

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