The I2P router application handles the I2P network communication.
It encompasses sending and receiving messages, building up tunnels, encrypting and decrypting (on multiple levels) where applicable, and so on.
Classes in this package, sub-packages, and others in router.jar are not for use by apps, clients or plugins (except for routerconsole). Subject to change. Not necessarily maintained as a stable API.
For applications bundling the I2P router, instantiate Router and call runRouter(), or use Router.main() or RouterLaunch. Most public methods in Router are maintained as a stable I2P for those bundling the router.
Interface Summary Interface Description HandlerJobBuilderDefines a class that builds jobs to handle a particular message - these builders are registered with the InNetMessagePool for various I2NP message types, allowing immediate queueing of a handler job rather than waiting for a polling job to come pick it up. JobDefines an executable task For use by the router only. MessageSelectorDefine a mechanism to select what messages are associated with a particular OutNetMessage. PeerManagerFacadeManage peer references and keep them up to date so that when asked for peers, it can provide appropriate peers according to the criteria provided. ProfileManager ReplyJobDefines an executable task that can be fired off in reply to a message RouterClock.ClockShiftListener RouterThrottleGatekeeper for deciding whether to throttle the further processing of messages through the router. ServiceDefine the manageable service interface for the subsystems in the I2P router TunnelInfoDefines the information associated with a tunnel TunnelManagerFacadeBuild and maintain tunnels throughout the network.
Class Summary Class Description BanlistRouters are banlisted only if none of our transports can talk to them or their signed router info is completely screwy. Banlist.Entry BlocklistManage blocking by IP address, in a manner similar to the Banlist, which blocks by router hash. ClientManagerFacadeManage all interactions with clients ClientMessageWrap a message either destined for a local client or received from one. ClientMessagePoolManage all of the inbound and outbound client messages maintained by the router. ClientTunnelSettingsWrap up the client settings specifying their tunnel criteria CommandLineSimple command line access to various utilities. CommSystemFacadeManages the communication subsystem between peers, including connections, listeners, transports, connection keys, etc. InNetMessagePoolManage a pool of inbound InNetMessages. JobImplBase implementation of a Job For use by the router only. JobQueueManage the pending jobs according to whatever algorithm is appropriate, giving preference to earlier scheduled jobs. JobQueueRunnera do run run run a do run run JobStatsGlorified struct to contain basic job stats. JobTimingDefine the timing requirements and statistics for a particular job For use by the router only. KeyManagerMaintain all of the key pairs for the router. LeaseSetKeysWrap up the keys given to the router when a destination connects to it. MessageHistorySimply act as a pen register of messages sent in and out of the router. MessageValidatorSingleton to manage the logic (and historical data) to determine whether a message is valid or not (meaning it isn't expired and hasn't already been received). MultiRouterFire up multiple routers in the same VM, all with their own RouterContext (and all that entails). NetworkDatabaseFacadeDefines the mechanism for interacting with I2P's network database OutNetMessageWrap up an outbound I2NP message, along with the information associated with its delivery and jobs to be fired off if particular events occur. OutNetMessagePoolMaintain a pool of OutNetMessages destined for other routers, organized by priority, expiring messages as necessary. PersistentKeyRingConcurrentHashMap with backing in the router.config file. RouterMain driver for the router. RouterClockAlternate location for determining the time which takes into account an offset. RouterContextBuild off the core I2P context to provide a root for a router instance to coordinate its resources. RouterDoSThrottle Deprecated.unused RouterLaunchThis is the class called by the runplain.sh script on linux and the i2p.exe launcher on Windows. RouterThrottleImplSimple throttle that basically stops accepting messages or nontrivial requests if the jobQueue lag is too large. RouterVersionExpose a version string StatisticsManagerPublishes some statistics about the router in the netDB. TunnelPoolSettingsWrap up the settings for a pool of tunnels.
Enum Summary Enum Description CommSystemFacade.StatusSince the codes may change.