Trees       Indices       Help   
conduit
Package conduit :: Package modules :: Package NetworkModule :: Module Server :: Class NetworkEndpoint
[hide private]

Class NetworkEndpoint

source code

Simple class used for detecting when a user connects another dataprovider to this one, symbolising a network sync

Instance Methods [hide private]
 
__init__(self)
All sync functionality should be provided by derived classes		 source code
 
is_busy(self)
A DataProvider is busy if it is currently in the middle of the intialization or synchronization process.		 source code
 
is_configured(self, isSource, isTwoWay)
Checks if the dp has been configured or not (and if it needs to be)		 source code
 
get_status(self)
Returns: The current dataproviders status		 source code
 
get_input_type(self)
Provides a way for dataproviders to change the datatype they accept.		 source code
 
get_output_type(self)
Provides a way for dataproviders to change the datatype they emit.		 source code
string
get_UID(self)
Returns a UID that represents this dataproviders (locally) unique state and configuration.		 source code

Inherited from dataproviders.DataProvider.DataSource: add, get, get_all, get_changes, get_num_items

Inherited from dataproviders.DataProvider.DataProviderBase: configure, emit, emit_change_detected, finish, get_configuration, get_configuration_xml, get_input_conversion_args, get_name, get_output_conversion_args, initialize, refresh, set_configuration, set_configuration_xml, set_status, uninitialize

Inherited from dataproviders.DataProvider.DataSink: delete, put

Class Variables [hide private]
  _name_ = _("Network")
  _description_ = _("Enable synchronization via network")
  _category_ = DataProviderCategory.DataProviderCategory("Miscel...
  _module_type_ = "twoway"
  _icon_ = "network-idle"
  _configurable_ = False

Inherited from dataproviders.DataProvider.DataProviderBase: __gsignals__, _in_type_, _out_type_

Method Details [hide private]

__init__(self)
(Constructor)

source code 
All sync functionality should be provided by derived classes
Overrides: dataproviders.DataProvider.TwoWay.__init__

is_busy(self)

source code 
A DataProvider is busy if it is currently in the middle of the intialization or synchronization process.
Overrides: dataproviders.DataProvider.DataProviderBase.is_busy
(inherited documentation)

is_configured(self, isSource, isTwoWay)

source code 
Checks if the dp has been configured or not (and if it needs to be)
Overrides: dataproviders.DataProvider.DataProviderBase.is_configured
(inherited documentation)

get_status(self)

source code 
Returns:
The current dataproviders status
Overrides: dataproviders.DataProvider.DataProviderBase.get_status
(inherited documentation)

get_input_type(self)

source code 
Provides a way for dataproviders to change the datatype they accept. In most cases implementing get_in_conversion args is recommended and will let you acomplish what you want.
Overrides: dataproviders.DataProvider.DataProviderBase.get_input_type
(inherited documentation)

get_output_type(self)

source code 
Provides a way for dataproviders to change the datatype they emit. In most cases implementing get_out_conversion args is recommended and will let you acomplish what you want.
Overrides: dataproviders.DataProvider.DataProviderBase.get_output_type
(inherited documentation)

get_UID(self)

source code 

Returns a UID that represents this dataproviders (locally) unique state and configuration. For example the LUID for a gmail dp may be your username and password.

Derived types MUST overwride this function
Returns: string
Overrides: dataproviders.DataProvider.DataProviderBase.get_UID
(inherited documentation)

Class Variable Details [hide private]

_category_

Value:
DataProviderCategory.DataProviderCategory("Miscellaneous", "applicatio\
ns-accessories")

   Trees       Indices       Help   
conduit
Generated by Epydoc 3.0beta1 on Sat Aug 2 22:18:28 2008 http://epydoc.sourceforge.net