Objective-C

Check Whether SSH Channel CLOSE Was Received

Demonstrates the Chilkat Ssh.ChannelReceivedClose method, which reports whether an SSH CLOSE message has been received for a channel. The only argument is the channel number. Remote CLOSE is distinct from EOF and closes the channel in both directions.

Background: Remote CLOSE is the definitive end of a channel's life. Once it is processed, ChannelIsOpen becomes false and the channel is normally removed from NumOpenChannels. Checking it distinguishes "the server finished sending output" (EOF) from "the channel is fully finished" (CLOSE) — which is what you want before concluding a remote command has completely wrapped up.

Chilkat Objective-C Downloads

Download Chilkat for Objective-C

Objective-C

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

BOOL success = NO;

//  Demonstrates the Ssh.ChannelReceivedClose method, which reports whether an SSH CLOSE message
//  has been received for a channel.  The only argument is the channel number.  Remote CLOSE is
//  distinct from EOF and closes the channel in both directions.

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;
}

//  The server may send EOF before CLOSE.  During that interval EOF is true while CLOSE is
//  still false.
if ([ssh ChannelReceivedEof: [NSNumber numberWithInt: channelNum]]) {
    NSLog(@"%@",@"EOF received.");
}

if ([ssh ChannelReceivedClose: [NSNumber numberWithInt: channelNum]]) {
    NSLog(@"%@",@"Remote CLOSE received -- the channel is closed in both directions.");
}
else {
    NSLog(@"%@",@"No remote CLOSE received.");
}

[ssh Disconnect];