interface - Transfer

This topic discusses the functions to execute a transfer with the PLANTA Link API and how to read the results.

Classes

CounterDimmer

The CounterDimmer class displays a dimmer during the transfer and records the results

  • All transfer methods return the CounterDimmer instance so you can check what happened

Properties

Property Getter Setter Description
CounterDimmer.critical checked unchecked True when a critical error aborted the transfer before it could finish
CounterDimmer.duration checked unchecked The duration of the transfer in seconds
CounterDimmer.errors checked unchecked The amount of records that couldn't be received by the target module
CounterDimmer.received_records checked unchecked The total amount of records received by the target module
CounterDimmer.sent_records checked unchecked The total amount of records sent by the source module
CounterDimmer.was_successful checked unchecked True when no errors were encountered

Functions

All transfer functions need a instance that is derived from ppms.interface.Config to execute the interface

  • If you don't have a reason to explicitly use the base ppms.interface.Config class you should use the ppms.interface.StaticConfig class as it outperforms the former heavily

Function Parameters Return Value Description
direct_transfer(invoker_module, config) invoker_module: A Module instance
config: A ppms.interface.Config instance
CounterDimmer Transfer the data from the source module to the target module. Use this if you have no pool module.
transfer_both_steps(invoker_module, config) invoker_module: A Module instance
config: A ppms.interface.Config instance
CounterDimmer Perform transfer_step_one() and if it succeeded, call transfer_step_two(). When the source to pool step fails, the transfer is aborted and the CounterDimmer for that transfer returned. When it succeeded the CounterDimmer for the second step is returned.
transfer_step_one(invoker_module, config) invoker_module: A Module instance
config: A ppms.interface.Config instance
CounterDimmer Transfer the data from the source module to the pool module.
transfer_step_two(invoker_module, config) invoker_module: A Module instance
config: A ppms.interface.Config instance
CounterDimmer Transfer the data from the pool module to the target module. Make sure to call transfer_step_one() before calling this!
Topic revision: r3 - 2017-10-10 - 16:32:42 - MarcelCarl








 
  • Suche in Topic-Namen

  • Suche in Topic-Inhalten