LocationManager (fred API)

java.lang.Object
- freenet.node.LocationManager

All Implemented Interfaces:: ByteCounter

public class LocationManager
extends java.lang.Object
implements ByteCounter

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`LocationManager.IncomingSwapRequestHandler` Similar to OutgoingSwapRequestHandler, except that we did not initiate the SwapRequest.
`class`	`LocationManager.MyCallback`
`class`	`LocationManager.OutgoingSwapRequestHandler` Locks the LocationManager.
`class`	`LocationManager.SwapRequestSender` Sends an FNPSwapRequest every second unless the LM is locked (which it will be most of the time)

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`FOIL_PITCH_BLACK_ATTACK_PREFIX`
`static int`	`noSwaps`
`static int`	`startedSwaps`
`static int`	`swaps`
`static int`	`swapsRejectedAlreadyLocked`
`static int`	`swapsRejectedNowhereToGo`
`static int`	`swapsRejectedRateLimit`
`static int`	`swapsRejectedRecognizedID`

Constructor Summary

Constructors
Constructor and Description

LocationManager(RandomSource r, Node node)

Constructors
Constructor and Description
`LocationManager(RandomSource r, Node node)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`announceLocChange()` Tell all connected peers that our location has changed
`void`	`clearOldSwapChains()`
`static double[]`	`extractLocs(PeerNode[] peers, boolean indicateBackoff)`
`static long[]`	`extractUIDs(PeerNode[] peers)`
`int`	`getAverageSwapTime()`
`java.lang.Object[]`	`getKnownLocations(long timestamp)` Method called by Node.getKnownLocations(long timestamp)
`double`	`getLocation()`
`double`	`getLocChangeSession()`
`int`	`getNetworkSizeEstimate(long timestamp)`
`long`	`getSendSwapInterval()`
`boolean`	`handleSwapCommit(Message m, PeerNode source)` Handle an unmatched FNPSwapCommit
`boolean`	`handleSwapComplete(Message m, PeerNode source)` Handle an unmatched FNPSwapComplete
`boolean`	`handleSwapRejected(Message m, PeerNode source)` Handle an unmatched FNPSwapRejected
`boolean`	`handleSwapReply(Message m, PeerNode source)` Handle an unmatched FNPSwapReply
`boolean`	`handleSwapRequest(Message m, PeerNode pn)` Handle an incoming SwapRequest
`void`	`lostOrRestartedNode(PeerNode pn)` We lost the connection to a node, or it was restarted.
`void`	`receivedBytes(int x)`
`void`	`sentBytes(int x)` Sent some bytes.
`void`	`sentPayload(int x)` Sent payload - only include the number of bytes of actual payload i.e.
`void`	`setLocation(double l)`
`void`	`start()` Start a thread to send FNPSwapRequests every second when we are not locked.
`boolean`	`swappingDisabled()` Should we swap? LOCKING: Call without holding locks.
`void`	`updateLocationChangeSession(double newLoc)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FOIL_PITCH_BLACK_ATTACK_PREFIX
```
public static final java.lang.String FOIL_PITCH_BLACK_ATTACK_PREFIX
```
    See Also:
    
    Constant Field Values
  - swaps
```
public static int swaps
```
  - noSwaps
```
public static int noSwaps
```
  - startedSwaps
```
public static int startedSwaps
```
  - swapsRejectedAlreadyLocked
```
public static int swapsRejectedAlreadyLocked
```
  - swapsRejectedNowhereToGo
```
public static int swapsRejectedNowhereToGo
```
  - swapsRejectedRateLimit
```
public static int swapsRejectedRateLimit
```
  - swapsRejectedRecognizedID
```
public static int swapsRejectedRecognizedID
```
- Constructor Detail
  - LocationManager
```
public LocationManager(RandomSource r,
                       Node node)
```
- Method Detail
  - getLocation
```
public double getLocation()
```
    Returns:
    
    The current Location of this node.
  - setLocation
```
public void setLocation(double l)
```
    Parameters:
    
    l -
  - updateLocationChangeSession
```
public void updateLocationChangeSession(double newLoc)
```
  - start
```
public void start()
```
    Start a thread to send FNPSwapRequests every second when we are not locked.
  - swappingDisabled
```
public boolean swappingDisabled()
```
    Should we swap? LOCKING: Call without holding locks.
    
    Returns:
  - getSendSwapInterval
```
public long getSendSwapInterval()
```
  - announceLocChange
```
protected void announceLocChange()
```
    Tell all connected peers that our location has changed
  - handleSwapRequest
```
public boolean handleSwapRequest(Message m,
                                 PeerNode pn)
```
    Handle an incoming SwapRequest
    
    Returns:
    
    True if we have handled the message, false if it needs to be handled otherwise.
  - handleSwapReply
```
public boolean handleSwapReply(Message m,
                               PeerNode source)
```
    Handle an unmatched FNPSwapReply
    
    Returns:
    
    True if we recognized and forwarded this reply.
  - handleSwapRejected
```
public boolean handleSwapRejected(Message m,
                                  PeerNode source)
```
    Handle an unmatched FNPSwapRejected
    
    Returns:
    
    True if we recognized and forwarded this message.
  - handleSwapCommit
```
public boolean handleSwapCommit(Message m,
                                PeerNode source)
```
    Handle an unmatched FNPSwapCommit
    
    Returns:
    
    True if we recognized and forwarded this message.
  - handleSwapComplete
```
public boolean handleSwapComplete(Message m,
                                  PeerNode source)
```
    Handle an unmatched FNPSwapComplete
    
    Returns:
    
    True if we recognized and forwarded this message.
  - clearOldSwapChains
```
public void clearOldSwapChains()
```
  - lostOrRestartedNode
```
public void lostOrRestartedNode(PeerNode pn)
```
    We lost the connection to a node, or it was restarted.
  - getNetworkSizeEstimate
```
public int getNetworkSizeEstimate(long timestamp)
```
  - getKnownLocations
```
public java.lang.Object[] getKnownLocations(long timestamp)
```
    Method called by Node.getKnownLocations(long timestamp)
    
    Returns:
    
    an array containing two cells : Locations and their last seen time for a given timestamp.
  - extractLocs
```
public static double[] extractLocs(PeerNode[] peers,
                                   boolean indicateBackoff)
```
  - extractUIDs
```
public static long[] extractUIDs(PeerNode[] peers)
```
  - getLocChangeSession
```
public double getLocChangeSession()
```
  - getAverageSwapTime
```
public int getAverageSwapTime()
```
  - receivedBytes
```
public void receivedBytes(int x)
```
    Specified by:
    
    receivedBytes in interface ByteCounter
  - sentBytes
```
public void sentBytes(int x)
```
    Description copied from interface: ByteCounter
    
    Sent some bytes. *Includes* any bytes flagged as already-reported-to-throttle.
    
    Specified by:
    
    sentBytes in interface ByteCounter
  - sentPayload
```
public void sentPayload(int x)
```
    Description copied from interface: ByteCounter
    
    Sent payload - only include the number of bytes of actual payload i.e. data from the user's point of view, as opposed to overhead. IMPORTANT: This will also be reported to sentBytes()! DO NOT ADD the total from sentBytes() to the total from sentPayloadBytes(), or you will double-count.
    
    Specified by:
    
    sentPayload in interface ByteCounter
    
    Parameters:
    
    x - Number of bytes sent

Class LocationManager

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FOIL_PITCH_BLACK_ATTACK_PREFIX

swaps

noSwaps

startedSwaps

swapsRejectedAlreadyLocked

swapsRejectedNowhereToGo

swapsRejectedRateLimit

swapsRejectedRecognizedID

Constructor Detail

LocationManager

Method Detail

getLocation

setLocation

updateLocationChangeSession

start

swappingDisabled

getSendSwapInterval

announceLocChange

handleSwapRequest

handleSwapReply

handleSwapRejected

handleSwapCommit

handleSwapComplete

clearOldSwapChains

lostOrRestartedNode

getNetworkSizeEstimate

getKnownLocations

extractLocs

extractUIDs

getLocChangeSession

getAverageSwapTime

receivedBytes

sentBytes

sentPayload