IPWorks IoT 2020 Node.js Edition

Questions / Feedback?

CloseSession Method

Closes a session.

Syntax

amqp.closeSession(name, [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 closes the session named Name and removes it from the Session* properties. If no session with the given Name exists, an error will be thrown.

Any links open on the specified session when this method is called will be automatically closed and removed from the Link* properties.

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