Check Whether SSH Channel EOF Was Received

See more SSH Examples

Demonstrates the Chilkat Ssh.ChannelReceivedEof method, which reports whether an SSH EOF message has been received for a channel. The only argument is the channel number. EOF means the server will send no more ordinary channel data, but it does not close the channel.

Background: EOF and CLOSE are separate events, and the distinction matters when deciding whether a command has truly finished. A server commonly sends EOF first and CLOSE afterward; in that interval this method is true while ChannelReceivedClose is still false, and the channel remains open and counted. EOF is the signal that all output has been produced — useful when you want to stop reading without waiting for the full close handshake. It returns false for an invalid, released, or locally closed channel.

Chilkat C Downloads

Download Chilkat for C

#include <C_CkSsh.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkSsh ssh;
    int sshPort;
    const char *password;
    int channelNum;

    success = FALSE;

    //  Demonstrates the Ssh.ChannelReceivedEof method, which reports whether an SSH EOF message has
    //  been received for a channel.  The only argument is the channel number.  EOF means the server
    //  will send no more ordinary channel data, but it does not close the channel.

    ssh = CkSsh_Create();

    sshPort = 22;
    success = CkSsh_Connect(ssh,"ssh.example.com",sshPort);
    if (success == FALSE) {
        printf("%s\n",CkSsh_lastErrorText(ssh));
        CkSsh_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 = "mySshPassword";

    success = CkSsh_AuthenticatePw(ssh,"mySshLogin",password);
    if (success == FALSE) {
        printf("%s\n",CkSsh_lastErrorText(ssh));
        CkSsh_Dispose(ssh);
        return;
    }

    channelNum = CkSsh_OpenSessionChannel(ssh);
    if (channelNum < 0) {
        printf("%s\n",CkSsh_lastErrorText(ssh));
        CkSsh_Dispose(ssh);
        return;
    }

    success = CkSsh_SendReqExec(ssh,channelNum,"ls -l /tmp");
    if (success == FALSE) {
        printf("%s\n",CkSsh_lastErrorText(ssh));
        CkSsh_Dispose(ssh);
        return;
    }

    //  IMPORTANT: Set a read timeout.  ReadTimeoutMs defaults to 0, which means no limit -- without
    //  it, this call waits forever if the server never sends channel close.
    CkSsh_putReadTimeoutMs(ssh,15000);

    success = CkSsh_ChannelReceiveToClose(ssh,channelNum);
    if (success == FALSE) {
        printf("%s\n",CkSsh_lastErrorText(ssh));
        CkSsh_Dispose(ssh);
        return;
    }

    if (CkSsh_ChannelReceivedEof(ssh,channelNum)) {
        printf("EOF was received -- no more ordinary channel data will arrive.\n");
    }
    else {
        printf("No EOF has been received.\n");
    }

    CkSsh_Disconnect(ssh);


    CkSsh_Dispose(ssh);

    }