IPWorks EDI 2020 Node.js Edition

Questions / Feedback?

Logoff Method

Ends a session with the connection client.

Syntax

oftpserver.logoff(connectionId, [callback])

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 this 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

This method will attempt to end the session with the client if the client has acknowledged it is finished sending files to the server. If the client still wishes to process commands, the method will give control back to the client and OFTPConnectionReadyToSend will be false. When OFTPConnectionReadyToSend is true, calling this method will end the session.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks EDI 2020 Node.js Edition - Version 20.0 [Build 8203]