Read an SSH Channel with a Byte Threshold

See more SSH Examples

Demonstrates the Chilkat Ssh.ChannelReadAndPoll2 method, which works like ChannelReadAndPoll but also returns once newly processed data brings the total buffered data to or above a byte threshold. The arguments are the channel number, the poll timeout, and the threshold.

The integer return value is -1 on error, -2 if nothing arrived before the timeout, 0 if EOF or channel close was processed, or — when greater than 0 — the total bytes currently buffered for the channel (not the bytes newly received by this call).

#include <C_CkSshW.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkSshW ssh;
    int sshPort;
    const wchar_t *password;
    int channelNum;
    int pollTimeoutMs;
    int maxNumBytes;
    int result;
    const wchar_t *output;

    success = FALSE;

    //  Demonstrates the Ssh.ChannelReadAndPoll2 method, which works like ChannelReadAndPoll but also
    //  returns once the total buffered data reaches or exceeds a byte threshold.  The 1st argument is
    //  the channel number, the 2nd is the poll timeout, and the 3rd is the byte threshold.

    ssh = CkSshW_Create();

    sshPort = 22;
    success = CkSshW_Connect(ssh,L"ssh.example.com",sshPort);
    if (success == FALSE) {
        wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
        CkSshW_Dispose(ssh);
        return;
    }

    //  Normally you would not hard-code the password in source.  You should instead obtain it
    //  from an interactive prompt, environment variable, or a secrets vault.
    password = L"mySshPassword";

    success = CkSshW_AuthenticatePw(ssh,L"mySshLogin",password);
    if (success == FALSE) {
        wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
        CkSshW_Dispose(ssh);
        return;
    }

    channelNum = CkSshW_OpenSessionChannel(ssh);
    if (channelNum < 0) {
        wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
        CkSshW_Dispose(ssh);
        return;
    }

    //  Start a shell WITHOUT requesting a PTY.  Without a PTY the shell sees it is connected to a
    //  raw data pipe and enters non-interactive mode: it suppresses the command prompt, does not
    //  echo typed commands back, and skips interactive login scripts.  The output is therefore
    //  clean and easily parseable -- but because no prompt is ever sent, code must not wait for
    //  one.  Instead, have each command print a predictable marker, or wait for EOF / channel close.
    success = CkSshW_SendReqShell(ssh,channelNum);
    if (success == FALSE) {
        wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
        CkSshW_Dispose(ssh);
        return;
    }

    success = CkSshW_ChannelSendString(ssh,channelNum,L"cat /var/log/syslog\n",L"utf-8");
    if (success == FALSE) {
        wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
        CkSshW_Dispose(ssh);
        return;
    }

    //  Return when output goes quiet for 500ms, or once about 64KB has been buffered.  The
    //  threshold is not a hard buffer limit -- a whole SSH packet may push the total above it.
    pollTimeoutMs = 500;
    maxNumBytes = 65536;
    //  The return value is: -1 on error, -2 if nothing arrived before the timeout, 0 if EOF or
    //  channel close was processed, or the total number of buffered bytes when greater than 0.
    result = CkSshW_ChannelReadAndPoll2(ssh,channelNum,pollTimeoutMs,maxNumBytes);
    if (result == -1) {
        wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
        CkSshW_Dispose(ssh);
        return;
    }

    if (result == -2) {
        wprintf(L"No channel data arrived before the timeout.\n");
    }

    if (result == 0) {
        wprintf(L"EOF or channel close was processed.  Buffered data may still remain.\n");
    }

    if (result > 0) {
        wprintf(L"Total bytes buffered: %d\n",result);
    }

    output = CkSshW_getReceivedText(ssh,channelNum,L"utf-8");
    if (CkSshW_getLastMethodSuccess(ssh) == FALSE) {
        wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
        CkSshW_Dispose(ssh);
        return;
    }

    wprintf(L"%s\n",output);

    CkSshW_Disconnect(ssh);


    CkSshW_Dispose(ssh);

    }