Class DHTPlugin

java.lang.Object

com.biglybt.plugin.dht.DHTPlugin

All Implemented Interfaces:

Plugin, DHTPluginBasicInterface, DHTPluginInterface

public class DHTPlugin
extends Object
implements Plugin, DHTPluginInterface

Nested Class Summary

Nested classes/interfaces inherited from interface DHTPluginInterface

DHTPluginInterface.DHTInterface

Field Summary

Fields

Modifier and Type	Field	Description
private static final boolean	AZ_CVS_DHT_ENABLE
private static final boolean	AZ_MAIN_DHT_ENABLE
private static final boolean	AZ_MAIN_DHT_V6_ENABLE
private DHTPluginImpl	biglybt_dht
private static final boolean	BIGLYBT_MAIN_DHT_ENABLE
private DHTPluginImpl	cvs_dht
private int	dht_data_port
private DHTLogger	dht_log
private DHTPluginImpl[]	dhts
static final byte	DT_FREQUENCY
static final byte	DT_NONE
static final byte	DT_SIZE
private boolean	enabled
static final int	EVENT_DHT_AVAILABLE
private boolean	extended_use
static final byte	FLAG_ANON
static final byte	FLAG_DOWNLOADING
static final byte	FLAG_MULTI_VALUE
static final byte	FLAG_PRECIOUS
static final byte	FLAG_SEEDING
static final byte	FLAG_SINGLE_VALUE
static final byte	FLAG_STATS
private boolean	got_extended_use
private AESemaphore	init_sem
private boolean[]	ipfilter_logging
private List	listeners
private LoggerChannel	log
private DHTPluginImpl	main_dht
private DHTPluginImpl	main_v6_dht
static final int	MAX_VALUE_SIZE
static final int	NW_AZ_CVS
static final int	NW_AZ_MAIN
static final int	NW_AZ_MAIN_V6
static final int	NW_BIGLYBT_MAIN
static final int	NW_MAIN	Deprecated. Use NW_AZ_MAIN
private static final String	PLUGIN_CONFIGSECTION_ID
private PluginInterface	plugin_interface
private static final String	PLUGIN_NAME
private static final String	PLUGIN_RESOURCE_ID
private static final String	PLUGIN_VERSION
private AEMonitor	port_change_mon
private int	port_change_outstanding
private boolean	port_changing
private BooleanParameter	prefer_i2p
private ActionParameter	reseed
private long	start_mono_time
private int	status
static final int	STATUS_DISABLED
static final int	STATUS_FAILED
static final int	STATUS_INITALISING
static final int	STATUS_RUNNING
private BooleanParameter	torrent_xfer
private UPnPMapping	upnp_mapping
private BooleanParameter	warn_user

Fields inherited from interface DHTPluginInterface

FLAG_BRIDGED, FLAG_PUT_AND_FORGET

Constructor Summary

Constructors

Constructor	Description
DHTPlugin()

Method Summary

Modifier and Type	Method	Description
void	addListener(DHTPluginListener l)
protected void	changePort(int _new_port)
DHTPluginKeyStats	decodeStats(DHTPluginValue value)
void	get(byte[] original_key, String description, byte flags, int max_values, long timeout, boolean exhaustive, boolean high_priority, DHTPluginOperationListener original_listener)
long	getClockSkew()
InetSocketAddress	getConnectionOrientedEndpoint()
InetSocketAddress[]	getConnectionOrientedEndpoints()
DHT	getDHT(int network)
DHTPluginInterface.DHTInterface[]	getDHTInterfaces()
DHTPluginBasicInterface	getDHTPlugin(int network)
DHT[]	getDHTs()
private DHTPluginImpl[]	getDHTsToUse()
DHTPluginContact	getLocalAddress()
DHTPluginContact[]	getLocalAddresses()
DHTPluginValue	getLocalValue(byte[] key)
String	getNetwork()
int	getStatus()
List<DHTPluginValue>	getValues()
List<DHTPluginValue>	getValues(byte[] key)
List<DHTPluginValue>	getValues(int network)
boolean	hasLocalKey(byte[] hash)
DHTPluginContact	importContact(InetSocketAddress address)
DHTPluginContact	importContact(InetSocketAddress address, byte version)
DHTPluginContact	importContact(InetSocketAddress address, byte version, boolean is_cvs)
DHTPluginContact	importContact(InetSocketAddress address, byte version, int preferred_net)
DHTPluginContact	importContact(Map<String,Object> map)
protected void	initComplete(UITextField status_area, boolean logging, String override_ip)
void	initialize(PluginInterface _plugin_interface)	This method is called when the Plugin is loaded by the client
boolean	isDiversified(byte[] key)
boolean	isEnabled()
boolean	isExtendedUseAllowed()
boolean	isInitialising()
boolean	isReachable()
boolean	isSleeping()
boolean	isTorrentXferEnabled()
static void	load(PluginInterface plugin_interface)
protected long	loadClockSkew()
void	log(String str)
boolean	peekEnabled()
void	put(byte[] key, String description, byte[] value, byte flags, boolean high_priority, DHTPluginOperationListener listener)
void	put(byte[] key, String description, byte[] value, byte flags, DHTPluginOperationListener listener)
void	put(byte[] key, String description, byte[] value, short flags, boolean high_priority, DHTPluginOperationListener listener)
void	registerHandler(byte[] handler_key, DHTPluginTransferHandler handler, Map<String,Object> options)
void	remove(byte[] key, String description, short flags, DHTPluginOperationListener listener)
void	remove(byte[] key, String description, DHTPluginOperationListener listener)
void	remove(DHTPluginContact[] targets, byte[] key, String description, DHTPluginOperationListener listener)
void	removeListener(DHTPluginListener l)
protected void	saveClockSkew()
protected void	setPluginInfo()
boolean	setSuspended(boolean susp)
void	unregisterHandler(byte[] handler_key, DHTPluginTransferHandler handler)

Methods inherited from class Object

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

Methods inherited from interface DHTPluginInterface

getAENetwork

Methods inherited from interface Plugin

getInitialProperties

Field Details

EVENT_DHT_AVAILABLE

public static final int EVENT_DHT_AVAILABLE

See Also:

• Constant Field Values

STATUS_DISABLED

public static final int STATUS_DISABLED

See Also:

• Constant Field Values

STATUS_INITALISING

public static final int STATUS_INITALISING

See Also:

• Constant Field Values

STATUS_RUNNING

public static final int STATUS_RUNNING

See Also:

• Constant Field Values

STATUS_FAILED

public static final int STATUS_FAILED

See Also:

• Constant Field Values

FLAG_SINGLE_VALUE

public static final byte FLAG_SINGLE_VALUE

See Also:

• Constant Field Values

FLAG_DOWNLOADING

public static final byte FLAG_DOWNLOADING

See Also:

• Constant Field Values

FLAG_SEEDING

public static final byte FLAG_SEEDING

See Also:

• Constant Field Values

FLAG_MULTI_VALUE

public static final byte FLAG_MULTI_VALUE

See Also:

• Constant Field Values

FLAG_STATS

public static final byte FLAG_STATS

See Also:

• Constant Field Values

FLAG_ANON

public static final byte FLAG_ANON

See Also:

• Constant Field Values

FLAG_PRECIOUS

public static final byte FLAG_PRECIOUS

See Also:

• Constant Field Values

DT_NONE

public static final byte DT_NONE

See Also:

• Constant Field Values

DT_FREQUENCY

public static final byte DT_FREQUENCY

See Also:

• Constant Field Values

DT_SIZE

public static final byte DT_SIZE

See Also:

• Constant Field Values

NW_MAIN

public static final int NW_MAIN

Deprecated.

Use NW_AZ_MAIN

See Also:

• Constant Field Values

NW_AZ_MAIN

public static final int NW_AZ_MAIN

See Also:

• Constant Field Values

NW_AZ_MAIN_V6

public static final int NW_AZ_MAIN_V6

See Also:

• Constant Field Values

NW_AZ_CVS

public static final int NW_AZ_CVS

See Also:

• Constant Field Values

NW_BIGLYBT_MAIN

public static final int NW_BIGLYBT_MAIN

See Also:

• Constant Field Values

MAX_VALUE_SIZE

public static final int MAX_VALUE_SIZE

See Also:

• Constant Field Values

PLUGIN_VERSION

private static final String PLUGIN_VERSION

See Also:

• Constant Field Values

PLUGIN_NAME

private static final String PLUGIN_NAME

See Also:

• Constant Field Values

PLUGIN_CONFIGSECTION_ID

private static final String PLUGIN_CONFIGSECTION_ID

See Also:

• Constant Field Values

PLUGIN_RESOURCE_ID

private static final String PLUGIN_RESOURCE_ID

See Also:

• Constant Field Values

AZ_MAIN_DHT_ENABLE

private static final boolean AZ_MAIN_DHT_ENABLE

AZ_CVS_DHT_ENABLE

private static final boolean AZ_CVS_DHT_ENABLE

AZ_MAIN_DHT_V6_ENABLE

private static final boolean AZ_MAIN_DHT_V6_ENABLE

BIGLYBT_MAIN_DHT_ENABLE

private static final boolean BIGLYBT_MAIN_DHT_ENABLE

plugin_interface

private PluginInterface plugin_interface

status

private int status

dhts

private DHTPluginImpl[] dhts

main_dht

private DHTPluginImpl main_dht

cvs_dht

private DHTPluginImpl cvs_dht

main_v6_dht

private DHTPluginImpl main_v6_dht

biglybt_dht

private DHTPluginImpl biglybt_dht

reseed

private ActionParameter reseed

enabled

private boolean enabled

dht_data_port

private int dht_data_port

got_extended_use

private boolean got_extended_use

extended_use

private boolean extended_use

init_sem

private AESemaphore init_sem

port_change_mon

private AEMonitor port_change_mon

port_changing

private boolean port_changing

port_change_outstanding

private int port_change_outstanding

ipfilter_logging

private boolean[] ipfilter_logging

warn_user

private BooleanParameter warn_user

prefer_i2p

private BooleanParameter prefer_i2p

torrent_xfer

private BooleanParameter torrent_xfer

upnp_mapping

private UPnPMapping upnp_mapping

log

private LoggerChannel log

dht_log

private DHTLogger dht_log

listeners

private List listeners

start_mono_time

private long start_mono_time

Constructor Details

DHTPlugin

public DHTPlugin()

Method Details

load

public static void load(PluginInterface plugin_interface)

initialize

public void initialize(PluginInterface _plugin_interface)

Description copied from interface: Plugin

This method is called when the Plugin is loaded by the client

Specified by:

initialize in interface Plugin

Parameters:

_plugin_interface - the interface that the plugin must use to communicate with the client

getConnectionOrientedEndpoint

public InetSocketAddress getConnectionOrientedEndpoint()

Specified by:

getConnectionOrientedEndpoint in interface DHTPluginInterface

getConnectionOrientedEndpoints

public InetSocketAddress[] getConnectionOrientedEndpoints()

Specified by:

getConnectionOrientedEndpoints in interface DHTPluginInterface

changePort

protected void changePort(int _new_port)

initComplete

protected void initComplete(UITextField status_area,
 boolean logging,
 String override_ip)

setPluginInfo

protected void setPluginInfo()

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface DHTPluginBasicInterface

peekEnabled

public boolean peekEnabled()

isInitialising

public boolean isInitialising()

Specified by:

isInitialising in interface DHTPluginBasicInterface

setSuspended

public boolean setSuspended(boolean susp)

isExtendedUseAllowed

public boolean isExtendedUseAllowed()

Specified by:

isExtendedUseAllowed in interface DHTPluginInterface

getNetwork

public String getNetwork()

Specified by:

getNetwork in interface DHTPluginInterface

isReachable

public boolean isReachable()

isDiversified

public boolean isDiversified(byte[] key)

put

public void put(byte[] key,
 String description,
 byte[] value,
 byte flags,
 DHTPluginOperationListener listener)

Specified by:

put in interface DHTPluginBasicInterface

put

public void put(byte[] key,
 String description,
 byte[] value,
 byte flags,
 boolean high_priority,
 DHTPluginOperationListener listener)

getDHTsToUse

private DHTPluginImpl[] getDHTsToUse()

put

public void put(byte[] key,
 String description,
 byte[] value,
 short flags,
 boolean high_priority,
 DHTPluginOperationListener listener)

Specified by:

put in interface DHTPluginBasicInterface

getLocalValue

public DHTPluginValue getLocalValue(byte[] key)

getValues

public List<DHTPluginValue> getValues()

Specified by:

getValues in interface DHTPluginBasicInterface

getValues

public List<DHTPluginValue> getValues(byte[] key)

Specified by:

getValues in interface DHTPluginInterface

getValues

public List<DHTPluginValue> getValues(int network)

get

public void get(byte[] original_key,
 String description,
 byte flags,
 int max_values,
 long timeout,
 boolean exhaustive,
 boolean high_priority,
 DHTPluginOperationListener original_listener)

Specified by:

get in interface DHTPluginBasicInterface

hasLocalKey

public boolean hasLocalKey(byte[] hash)

remove

public void remove(byte[] key,
 String description,
 DHTPluginOperationListener listener)

Specified by:

remove in interface DHTPluginInterface

remove

public void remove(byte[] key,
 String description,
 short flags,
 DHTPluginOperationListener listener)

Specified by:

remove in interface DHTPluginInterface

remove

public void remove(DHTPluginContact[] targets,
 byte[] key,
 String description,
 DHTPluginOperationListener listener)

Specified by:

remove in interface DHTPluginInterface

importContact

public DHTPluginContact importContact(Map<String,Object> map)

Specified by:

importContact in interface DHTPluginInterface

importContact

public DHTPluginContact importContact(InetSocketAddress address)

Specified by:

importContact in interface DHTPluginInterface

importContact

public DHTPluginContact importContact(InetSocketAddress address,
 byte version)

Specified by:

importContact in interface DHTPluginInterface

importContact

public DHTPluginContact importContact(InetSocketAddress address,
 byte version,
 boolean is_cvs)

Specified by:

importContact in interface DHTPluginInterface

importContact

public DHTPluginContact importContact(InetSocketAddress address,
 byte version,
 int preferred_net)

Specified by:

importContact in interface DHTPluginInterface

getLocalAddress

public DHTPluginContact getLocalAddress()

Specified by:

getLocalAddress in interface DHTPluginInterface

getLocalAddresses

public DHTPluginContact[] getLocalAddresses()

Specified by:

getLocalAddresses in interface DHTPluginInterface

registerHandler

public void registerHandler(byte[] handler_key,
 DHTPluginTransferHandler handler,
 Map<String,Object> options)

Specified by:

registerHandler in interface DHTPluginInterface

unregisterHandler

public void unregisterHandler(byte[] handler_key,
 DHTPluginTransferHandler handler)

Specified by:

unregisterHandler in interface DHTPluginInterface

getStatus

public int getStatus()

isSleeping

public boolean isSleeping()

Specified by:

isSleeping in interface DHTPluginBasicInterface

isTorrentXferEnabled

public boolean isTorrentXferEnabled()

getDHTs

public DHT[] getDHTs()

getDHT

public DHT getDHT(int network)

getDHTPlugin

public DHTPluginBasicInterface getDHTPlugin(int network)

getDHTInterfaces

public DHTPluginInterface.DHTInterface[] getDHTInterfaces()

Specified by:

getDHTInterfaces in interface DHTPluginBasicInterface

loadClockSkew

protected long loadClockSkew()

saveClockSkew

protected void saveClockSkew()

getClockSkew

public long getClockSkew()

decodeStats

public DHTPluginKeyStats decodeStats(DHTPluginValue value)

Specified by:

decodeStats in interface DHTPluginInterface

addListener

public void addListener(DHTPluginListener l)

Specified by:

addListener in interface DHTPluginInterface

removeListener

public void removeListener(DHTPluginListener l)

Specified by:

removeListener in interface DHTPluginInterface

log

public void log(String str)

Specified by:

log in interface DHTPluginInterface