org.johnnei.javatorrent.module

Interface IModule

public interface IModule

Method Summary

Modifier and Type	Method and Description
void	configureTorrentClient(TorrentClient.Builder builder) Registers all the mandatory components to the TorrentClient.Builder.
List<Class<IModule>>	getDependsOn() Returns the extensions which must be present to allow this module to work at all.
int	getRelatedBep() Returns the number of the BEP to which this module is related.
void	onBuild(TorrentClient torrentClient) Event called as the last method in the build process of the TorrentClient.Builder#build() call.
void	onPostHandshake(Peer peer) Called when the peer has successfully passed the handshake with us.
void	onShutdown() Event called when the TorrentClient is being shutdown.

Method Detail

configureTorrentClient

void configureTorrentClient(TorrentClient.Builder builder)

Registers all the mandatory components to the TorrentClient.Builder.

Parameters:

builder - The torrent client builder to which the module is being registered

getRelatedBep

int getRelatedBep()

Returns the number of the BEP to which this module is related. This is used to inform the user/developer for what extension this module is being used.

Returns:

The related BEP number

getDependsOn

List<Class<IModule>> getDependsOn()

Returns the extensions which must be present to allow this module to work at all.

Returns:

The list of required modules

onPostHandshake

void onPostHandshake(Peer peer)
              throws IOException

Called when the peer has successfully passed the handshake with us.

Parameters:

peer - The peer who passed the handshake

Throws:

IOException

onBuild

void onBuild(TorrentClient torrentClient)
      throws ModuleBuildException

Event called as the last method in the build process of the TorrentClient.Builder#build() call.

Throws:

ModuleBuildException - When the module can not build itself correctly

onShutdown

void onShutdown()

Event called when the TorrentClient is being shutdown.