Module dopal.class_defs
Defines all constants, variables and methods available on classes in
Azureus's plugin API.
Not all classes are defined here are mentioned in this API
documentation (simply because too much documentation will be
generated).
For each class that DOPAL has explicit support for, there will be a
class defined here which contains the class information. The list of
classes supported in this version is described in classes.
For each class that we support, there will be a class in this module
with the same name with the suffix of "DataType". It will have
a get_xml_type method defined on the class. It may have some
of the following attributes on the class:
-
A
__az_methods__ attribute (which will be a AzureusMethods instance) - defining
what methods we support. These correlate to the methods defined on
each class.
-
A
__az_constants__ attribute (which will be a
dictionary) - defining what class constants are defined. These
correlate to the constants on the class.
-
A
__az_attributes__ attribute (which will be a
dictionary) - defining what attributes will be on the object. These
attributes are unique to the XML/HTTP plugin. The plugin defines
certain precalculated 'attributes' when returning the data for a
given object, by invoking certain methods on the object. This saves
the client making multiple calls on an object to retrieve certain
pieces of information, by calculating it and returning it all in one
go.
If you are interested to know what methods are available on each
classes, then please look at Azureus's own Javadoc API
documentation.
The meta-attributes for these classes are defined by the XML/HTTP
plugin - you can find their definitions in the GenericRPAttributes.java
source file.