Receive Method
Reads a portion of received data into a string.
Syntax
sshclient.receive([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, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
Use this method to read out a piece of data received from the server into a string.
Note that in synchronous mode this method may block in the absence of any inbound data until the next piece of data is received from the server. Use Poll to check if there is any data in the connection that is immediately available for reading.
In asynchronous mode a good time to call this method is upon receiving a read notification in DataReceived event handler. When working in asynchronous mode, this call returns immediately.
This method only returns data that arrives via the stdout channel. Use ReceiveFrom to read stderr data.