RestartDirectory Property

The directory to log cached files when using AS2 restart functionality.

Syntax

 as2sender.getRestartDirectory([callback])
 as2sender.setRestartDirectory( restartDirectory, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getRestartDirectory([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setRestartDirectory([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

If this property is set, the class will cache all data to the RestartDirectory. Thus, when sending a file is interrupted, the class can restart the transmission of the file starting where it was interrupted.

To use this functionality, simply set the RestartDirectory and call Restart.

When using restart functionality, the data is completely processed to the RestartDirectory before sending begins.

NOTE: This directory will not automatically be cleaned up.

Data Type

String