net.i2p.router.peermanager

## Class ProfileManagerImpl

- java.lang.Object
- - net.i2p.router.peermanager.ProfileManagerImpl

- All Implemented Interfaces:
    ProfileManager

      public class ProfileManagerImpl
      extends Object
      implements ProfileManager

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `ProfileManagerImpl(RouterContext context)`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `commErrorOccurred(Hash peer)` Note that there was some sort of communication error talking with the peer
    `void` | `dbLookupFailed(Hash peer)` Note that the peer was unable to reply to a db lookup - either with data or with a lookupReply redirecting the user elsewhere This will force creation of DB stats
    `void` | `dbLookupReceived(Hash peer)` Note that the local router received a db lookup from the given peer
    `void` | `dbLookupReply(Hash peer, int newPeers, int oldPeers, int invalid, int duplicate, long responseTimeMs)` Note that the peer replied to a db lookup with a redirect to other routers, where the list of redirected users included newPeers routers that the local router didn't know about, oldPeers routers that the local router already knew about, the given invalid routers that were invalid in some way, and the duplicate number of routers that we explicitly asked them not to send us, but they did anyway
    `void` | `dbLookupSuccessful(Hash peer, long responseTimeMs)` Note that the peer was able to return the valid data for a db lookup This will force creation of DB stats
    `void` | `dbStoreFailed(Hash peer)` Note that we were unable to confirm a successful send of db data to the peer, at least not within our timeout period This will force creation of DB stats
    `void` | `dbStoreReceived(Hash peer, boolean wasNewKey)` Note that the local router received an unprompted db store from the given peer
    `void` | `dbStoreSent(Hash peer, long responseTimeMs)` Note that we've confirmed a successful send of db data to the peer (though we haven't necessarily requested it again from them, so they /might/ be lying) This is not really interesting, since they could be lying, so we do not increment any DB stats at all.
    `void` | `dbStoreSuccessful(Hash peer)` Note that we've verified a successful send of db data to the floodfill peer by querying another floodfill.
    `void` | `heardAbout(Hash peer)` Note that the local router received a reference to the given peer, either through an explicit dbStore or in a dbLookupReply
    `void` | `heardAbout(Hash peer, long when)` Note that the local router received a reference to the given peer at a certain time.
    `void` | `messageFailed(Hash peer)` Note that the router failed to send a message to the peer over any transport
    `void` | `messageFailed(Hash peer, String transport)` Note that the router failed to send a message to the peer over the transport specified
    `void` | `messageReceived(Hash peer, String style, long msToReceive, int bytesRead)` Note that the router received a message from the given peer on the specified transport.
    `void` | `messageSent(Hash peer, String transport, long msToSend, long bytesSent)` Note that it took msToSend to send a message of size bytesSent to the peer over the transport.
    `Properties` | `summarizePeers(int numPeers)` provide a simple summary of a number of peers, suitable for publication in the netDb
    `void` | `tunnelDataPushed(Hash peer, long rtt, int size)` Note that we were able to push some data through a tunnel that the peer is participating in (detected after rtt).
    `void` | `tunnelDataPushed1m(Hash peer, int size)` Note that the peer is participating in a tunnel that pushed the given amount of data over the last minute.
    `void` | `tunnelFailed(Hash peer, int pct)` Note that the peer participated in a tunnel that failed.
    `void` | `tunnelJoined(Hash peer, long responseTimeMs)` Note that the router agreed to participate in a tunnel
    `void` | `tunnelLifetimePushed(Hash peer, long lifetime, long size)` Note that we were able to push the given amount of data through a tunnel that the peer is participating in
    `void` | `tunnelRejected(Hash peer, long responseTimeMs, int severity)` Note that a router explicitly rejected joining a tunnel.
    `void` | `tunnelTestSucceeded(Hash peer, long responseTimeMs)` Note that a tunnel that the router is participating in was successfully tested with the given round trip latency
    `void` | `tunnelTimedOut(Hash peer)` Note that a router did not respond to a tunnel join.

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### ProfileManagerImpl

          public ProfileManagerImpl(RouterContext context)

  - ### Method Detail

    - #### messageSent

          public void messageSent(Hash peer,
                         String transport,
                         long msToSend,
                         long bytesSent)

      Note that it took msToSend to send a message of size bytesSent to the peer over the transport. This should only be called if the transport considered the send successful.
      Specified by:
        `messageSent` in interface `ProfileManager`

    - #### messageFailed

          public void messageFailed(Hash peer,
                           String transport)

      Note that the router failed to send a message to the peer over the transport specified
      Specified by:
        `messageFailed` in interface `ProfileManager`

    - #### messageFailed

          public void messageFailed(Hash peer)

      Note that the router failed to send a message to the peer over any transport
      Specified by:
        `messageFailed` in interface `ProfileManager`

    - #### commErrorOccurred

          public void commErrorOccurred(Hash peer)

      Note that there was some sort of communication error talking with the peer
      Specified by:
        `commErrorOccurred` in interface `ProfileManager`

    - #### tunnelJoined

          public void tunnelJoined(Hash peer,
                          long responseTimeMs)

      Note that the router agreed to participate in a tunnel
      Specified by:
        `tunnelJoined` in interface `ProfileManager`

    - #### tunnelRejected

          public void tunnelRejected(Hash peer,
                            long responseTimeMs,
                            int severity)

      Note that a router explicitly rejected joining a tunnel.
      Specified by:
        `tunnelRejected` in interface `ProfileManager`
      Parameters:
        `responseTimeMs` - ignored
        `severity` - how much the peer doesnt want to participate in the tunnel (large == more severe)
        `peer` - who rejected us

    - #### tunnelTimedOut

          public void tunnelTimedOut(Hash peer)

      Note that a router did not respond to a tunnel join. Since TunnelHistory doesn't have a timeout stat, pretend we were rejected for bandwidth reasons.
      Specified by:
        `tunnelTimedOut` in interface `ProfileManager`
      Parameters:
        `peer` - who rejected us

    - #### tunnelTestSucceeded

          public void tunnelTestSucceeded(Hash peer,
                                 long responseTimeMs)

      Note that a tunnel that the router is participating in was successfully tested with the given round trip latency
      Specified by:
        `tunnelTestSucceeded` in interface `ProfileManager`

    - #### tunnelDataPushed

          public void tunnelDataPushed(Hash peer,
                              long rtt,
                              int size)

      Description copied from interface: `ProfileManager`
      Note that we were able to push some data through a tunnel that the peer is participating in (detected after rtt).
      Specified by:
        `tunnelDataPushed` in interface `ProfileManager`

    - #### tunnelDataPushed1m

          public void tunnelDataPushed1m(Hash peer,
                                int size)

      Description copied from interface: `ProfileManager`
      Note that the peer is participating in a tunnel that pushed the given amount of data over the last minute.
      Specified by:
        `tunnelDataPushed1m` in interface `ProfileManager`

    - #### tunnelLifetimePushed

          public void tunnelLifetimePushed(Hash peer,
                                  long lifetime,
                                  long size)

      Description copied from interface: `ProfileManager`
      Note that we were able to push the given amount of data through a tunnel that the peer is participating in
      Specified by:
        `tunnelLifetimePushed` in interface `ProfileManager`

    - #### tunnelFailed

          public void tunnelFailed(Hash peer,
                          int pct)

      Note that the peer participated in a tunnel that failed. Its failure may not have been the peer's fault however. Blame the peer with a probability of pct/100.
      Specified by:
        `tunnelFailed` in interface `ProfileManager`

    - #### dbLookupSuccessful

          public void dbLookupSuccessful(Hash peer,
                                long responseTimeMs)

      Note that the peer was able to return the valid data for a db lookup This will force creation of DB stats
      Specified by:
        `dbLookupSuccessful` in interface `ProfileManager`

    - #### dbLookupFailed

          public void dbLookupFailed(Hash peer)

      Note that the peer was unable to reply to a db lookup - either with data or with a lookupReply redirecting the user elsewhere This will force creation of DB stats
      Specified by:
        `dbLookupFailed` in interface `ProfileManager`

    - #### dbLookupReply

          public void dbLookupReply(Hash peer,
                           int newPeers,
                           int oldPeers,
                           int invalid,
                           int duplicate,
                           long responseTimeMs)

      Note that the peer replied to a db lookup with a redirect to other routers, where the list of redirected users included newPeers routers that the local router didn't know about, oldPeers routers that the local router already knew about, the given invalid routers that were invalid in some way, and the duplicate number of routers that we explicitly asked them not to send us, but they did anyway
      Specified by:
        `dbLookupReply` in interface `ProfileManager`

    - #### dbLookupReceived

          public void dbLookupReceived(Hash peer)

      Note that the local router received a db lookup from the given peer
      Specified by:
        `dbLookupReceived` in interface `ProfileManager`

    - #### dbStoreReceived

          public void dbStoreReceived(Hash peer,
                             boolean wasNewKey)

      Note that the local router received an unprompted db store from the given peer
      Specified by:
        `dbStoreReceived` in interface `ProfileManager`

    - #### dbStoreSent

          public void dbStoreSent(Hash peer,
                         long responseTimeMs)

      Note that we've confirmed a successful send of db data to the peer (though we haven't necessarily requested it again from them, so they /might/ be lying) This is not really interesting, since they could be lying, so we do not increment any DB stats at all. On verify, call dbStoreSuccessful().
      Specified by:
        `dbStoreSent` in interface `ProfileManager`
      Parameters:
        `responseTimeMs` - ignored

    - #### dbStoreSuccessful

          public void dbStoreSuccessful(Hash peer)

      Note that we've verified a successful send of db data to the floodfill peer by querying another floodfill. This will force creation of DB stats
      Specified by:
        `dbStoreSuccessful` in interface `ProfileManager`

    - #### dbStoreFailed

          public void dbStoreFailed(Hash peer)

      Note that we were unable to confirm a successful send of db data to the peer, at least not within our timeout period This will force creation of DB stats
      Specified by:
        `dbStoreFailed` in interface `ProfileManager`

    - #### heardAbout

          public void heardAbout(Hash peer)

      Note that the local router received a reference to the given peer, either through an explicit dbStore or in a dbLookupReply
      Specified by:
        `heardAbout` in interface `ProfileManager`

    - #### heardAbout

          public void heardAbout(Hash peer,
                        long when)

      Note that the local router received a reference to the given peer at a certain time. Only update the time if newer.
      Specified by:
        `heardAbout` in interface `ProfileManager`

    - #### messageReceived

          public void messageReceived(Hash peer,
                             String style,
                             long msToReceive,
                             int bytesRead)

      Note that the router received a message from the given peer on the specified transport. Messages received without any "from" information aren't recorded through this metric. If msToReceive is negative, there was no timing information available
      Specified by:
        `messageReceived` in interface `ProfileManager`

    - #### summarizePeers

          public Properties summarizePeers(int numPeers)

      provide a simple summary of a number of peers, suitable for publication in the netDb
      Specified by:
        `summarizePeers` in interface `ProfileManager`