Objective-C

Check Whether SSH Channel EOF Was Received

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 Objective-C Downloads

Download Chilkat for Objective-C

Objective-C

#import <CkoSsh.h>
#import <NSString.h>

BOOL success = NO;

//  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.

CkoSsh *ssh = [[CkoSsh alloc] init];

int sshPort = 22;
success = [ssh Connect: @"ssh.example.com" port: [NSNumber numberWithInt: sshPort]];
if (success == NO) {
    NSLog(@"%@",ssh.LastErrorText);
    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.
NSString *password = @"mySshPassword";

success = [ssh AuthenticatePw: @"mySshLogin" password: password];
if (success == NO) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

int channelNum = [[ssh OpenSessionChannel] intValue];
if (channelNum < 0) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

success = [ssh SendReqExec: [NSNumber numberWithInt: channelNum] command: @"ls -l /tmp"];
if (success == NO) {
    NSLog(@"%@",ssh.LastErrorText);
    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.
ssh.ReadTimeoutMs = [NSNumber numberWithInt:15000];

success = [ssh ChannelReceiveToClose: [NSNumber numberWithInt: channelNum]];
if (success == NO) {
    NSLog(@"%@",ssh.LastErrorText);
    return;
}

if ([ssh ChannelReceivedEof: [NSNumber numberWithInt: channelNum]]) {
    NSLog(@"%@",@"EOF was received -- no more ordinary channel data will arrive.");
}
else {
    NSLog(@"%@",@"No EOF has been received.");
}

[ssh Disconnect];