COS Aspera Library 0.9 API
faspmanager2 Namespace Reference

Classes

class  _object
 
class  ITransferListener
 

Functions

def swig_import_helper ()
 
def startTransfer (xferId, configuration, transferSpec, pyCallbackObj)
 
def isRunning (xferId)
 
def stopTransfer (xferId)
 
def modifyTransfer (xferId, option, value)
 
def configureLogLocation (logPath)
 
def configureAscpPath (ascpPath)
 

Variables

 weakref_proxy = weakref.proxy
 
def ITransferListener_swigregister = _faspmanager2.ITransferListener_swigregister
 
def configureAscpPath = _faspmanager2.configureAscpPath
 

Function Documentation

◆ configureAscpPath()

def faspmanager2.configureAscpPath (   ascpPath)

◆ configureLogLocation()

def faspmanager2.configureLogLocation (   logPath)
Sets log location
 logPath - log path
 Returns whether successful or not

◆ isRunning()

def faspmanager2.isRunning (   xferId)
Checks if transfer is in progress
 xferId - The transfer GUID
 Returns status of the transfer

◆ modifyTransfer()

def faspmanager2.modifyTransfer (   xferId,
  option,
  value 
)
Changes the transfer rate plus adaptive polycy while transfer is running.
 xferId - The transfer GUID
 option - running transfer options:
   rate_policy = 0,
   target_rate_kbps = 1,
   min_rate_kbps = 2,
   priority = 3,  
   CTRL_PAUSE = 4,
   CTRL_RESUME = 5,
 value - value of the corresponding option
 Returns whether successful or not

◆ startTransfer()

def faspmanager2.startTransfer (   xferId,
  configuration,
  transferSpec,
  pyCallbackObj 
)
Initiates transfer.
 xferId - The transfer GUID
 configuration - JSON string with additional configuration parameters
 transferSpec - JSON string with transfer parameters
 pyCallbackObj - ITransferListener implementation

◆ stopTransfer()

def faspmanager2.stopTransfer (   xferId)
Stops transfer
 xferId - The transfer GUID
 Returns whether successful or not

◆ swig_import_helper()

def faspmanager2.swig_import_helper ( )

Variable Documentation

◆ configureAscpPath

def faspmanager2.configureAscpPath = _faspmanager2.configureAscpPath

◆ ITransferListener_swigregister

def faspmanager2.ITransferListener_swigregister = _faspmanager2.ITransferListener_swigregister

◆ weakref_proxy

faspmanager2.weakref_proxy = weakref.proxy