faspmanager2 Namespace Reference

Classes
class	_object
class	ITransferListener
Functions
def	swig_import_helper
def	startTransfer
def	isRunning
def	stopTransfer
def	modifyTransfer
def	configureLogLocation
def	configureAsperaLocation
def	startTransferStream
Variables
tuple	_faspmanager2 = swig_import_helper()
tuple	_faspmanager2 = swig_import_helper()
	_swig_property = property
int	_newclass = 0
	weakref_proxy = weakref.proxy
	weakref_proxy = lambdax:x
int	ITransferListener_swigregister = 2
int	startTransferStream = 2

---

Function Documentation

def faspmanager2::swig_import_helper

(

)

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

def faspmanager2::isRunning

(

xferId

)

Checks if transfer is in progress
 xferId - The transfer GUID
 Returns status of the transfer

def faspmanager2::stopTransfer

(

xferId

)

Stops transfer
 xferId - The transfer GUID
 Returns whether successful or not

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

def faspmanager2::configureLogLocation

(

logPath

)

Sets log location
 logPath - log path
 Returns whether successful or not

def faspmanager2::configureAsperaLocation

(

asperaPath

)

Sets package location
 asperaPath - package path
 Returns whether successful or not

def faspmanager2::startTransferStream	(		xferId,
			configuration,
			transferSpec,
			transferListener
	)

---

Variable Documentation

tuple faspmanager2::_faspmanager2 = swig_import_helper() [static]

tuple faspmanager2::_faspmanager2 = swig_import_helper() [static]

faspmanager2::_swig_property = property [static]

int faspmanager2::_newclass = 0 [static]

faspmanager2::weakref_proxy = weakref.proxy [static]

faspmanager2::weakref_proxy = lambdax:x [static]

int faspmanager2::ITransferListener_swigregister = 2 [static]

int faspmanager2::startTransferStream = 2 [static]

---