LogFile Property

The log file written.

Syntax

 as2sender.getLogFile([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 getLogFile([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 setLogFile([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 LogDirectory is specified a log file will be written in the specified directory and LogFile will contain the full path and name of the files written, minus the extension.

The class will write multiple log files for each transmission, with separate extensions for each type of data:


Status (.log)	Contains information on applied security options and pass/fail status of transmission
Request (.req)	Contains the outgoing request, after security options have been applied
Payload (.dat)	Contains the unsecured payload data prior to transmission
MDN Receipt (.mdn)	For synchronous requests or asynchronous receipts verified with VerifyReceipt. This contains the MDN receipt.
Error (.err)	This is only written if an error is encountered and will contain the error.

This property is read-only.

Data Type