SSH2ChannelMBS.Close(Wait as Boolean = true)

Lasterror is set.
Close an active data channel. In practice this means sending an SSH_MSG_CLOSE packet to the remote host which serves as instruction that no further data will be sent to it. The remote host may still send data back until it sends its own close message in response. To wait for the remote end to close its connection as well, follow this command with WaitClosed.
Lasterror is set to kErrorEAgain when it would otherwise block. While kErrorEAgain is an error, it isn't really a failure per se.

If wait parameter is true, the plugin does a loop to try close until it receives an okay (and not EAGAIN).

SSH2ChannelMBS.Constructor   Private

See also:

• Constructor(session as SSH2SessionMBS)

SSH2ChannelMBS.Constructor(session as SSH2SessionMBS)

May raise UnsupportedOperationException if channel creation fails.

See also:

• Constructor

SSH2ChannelMBS.Destructor

SSH2ChannelMBS.EOF as boolean

dim s as string
dim channel as SSH2ChannelMBS // your channel

// read all till end of channel
s = ""
do
  app.YieldToNextThread
  dim r as string = channel.Read(50000)
  s = s + r
  
  if channel.LastError = SSH2SessionMBS.kErrorEagain then
    // no answer yet
    Continue
  elseif channel.LastError = SSH2SessionMBS.kErrorNone then
    // we got something
    if channel.EOF then
      // done?
      MsgBox "Result: " + s
      exit
    end if
  else
    exit
  end if
loop

Check if the remote host has sent an EOF status for the selected stream.
Returns true if the remote host has sent EOF, otherwise false.
Lasterror is set. On error, this function returns true.

SSH2ChannelMBS.Execute(command as string)

Lasterror is set.
Lasterror is set to kErrorEAgain when it would otherwise block. While kErrorEAgain is an error, it isn't really a failure per se.

SSH2ChannelMBS.Flush

Lasterror is set.

SSH2ChannelMBS.FlushAll

Lasterror is set.

SSH2ChannelMBS.FlushExtendedData

Lasterror is set.

SSH2ChannelMBS.FlushStdErr

Lasterror is set.

SSH2ChannelMBS.Read(length as Integer = 65536) as string

dim s as string
dim channel as SSH2ChannelMBS // your channel

// read all till end of channel
s = ""
do
  app.YieldToNextThread
  dim r as string = channel.Read(50000)
  s = s + r
  
  if channel.LastError = SSH2SessionMBS.kErrorEagain then
    // no answer yet
    Continue
  elseif channel.LastError = SSH2SessionMBS.kErrorNone then
    // we got something
    if channel.EOF then
      // done?
      MsgBox "Result: " + s
      exit
    end if
  else
    exit
  end if
loop

Lasterror is set.
Attempt to read data from a stdout channel stream.
Returns data read.
Lasterror is set to kErrorEAgain when it would otherwise block. While kErrorEAgain is an error, it isn't really a failure per se.
Version up to 18.2 return text marked as UTF-8, but in 18.3 we change to return text without encoding marking. So if you expect UTF-8, you can apply UTF-8 encoding with DefineEncoding.

SSH2ChannelMBS.ReadStdErr(length as Integer = 65536) as string

Lasterror is set.
Attempt to read data from a stderr channel stream.
Returns data read.
Lasterror is set to kErrorEAgain when it would otherwise block. While kErrorEAgain is an error, it isn't really a failure per se.

Some examples using this method:

• /Network/SSH/SSH execute

SSH2ChannelMBS.RequestPTY(term as string)

Lasterror is set.
Note that this does not make sense for all channel types and may be ignored by the server despite returning success.
Lasterror is set to kErrorEAgain when it would otherwise block. While kErrorEAgain is an error, it isn't really a failure per se.

Some examples using this method:

• /Network/SSH/SSH
• /Network/SSH/SSH console
• /Network/SSH/SSH with Xojo Socket

SSH2ChannelMBS.SendEOF

Lasterror is set.
Tell the remote host that no further data will be sent on the specified channel. Processes typically interpret this as a closed stdin descriptor.
Lasterror is set to kErrorEAgain when it would otherwise block. While kErrorEAgain is an error, it isn't really a failure per se.

SSH2ChannelMBS.SetBlocking(blocking as boolean)

Some examples using this method:

• /Network/SSH/SSH
• /Network/SSH/SSH console
• /Network/SSH/SSH execute
• /Network/SSH/SSH Terminal
• /Network/SSH/SSH tunnel
• /Network/SSH/SSH with Xojo Socket

SSH2ChannelMBS.SetEnv(name as string, value as string)

Lasterror is set.
Lasterror is set to kErrorEAgain when it would otherwise block. While kErrorEAgain is an error, it isn't really a failure per se.

SSH2ChannelMBS.Shell

Lasterror is set.
Lasterror is set to kErrorEAgain when it would otherwise block. While kErrorEAgain is an error, it isn't really a failure per se.

SSH2ChannelMBS.WaitClosed

Lasterror is set.

Enter a temporary blocking state until the remote host closes the named channel. Typically sent after Close in order to examine the exit status.
Lasterror is set to kErrorEAgain when it would otherwise block. While kErrorEAgain is an error, it isn't really a failure per se.

SSH2ChannelMBS.WaitEOF

Lasterror is set.
May give kErrorEAgain error which means you should try again later.

SSH2ChannelMBS.Write(data as MemoryBlock) as Integer

Lasterror is set.

Write functions will use as much as possible of the buffer and put it into a single SSH protocol packet. This means that to get maximum performance when sending larger files, you should try to always pass in at least 32K of data to this function.

Returns actual number of bytes written. Lasterror being kErrorEagain when it would otherwise block. While kErrorEagain is an error, it isn't really a failure per se.

See also:

• Write(text as string) as Integer

SSH2ChannelMBS.Write(text as string) as Integer

Lasterror is set.

Write functions will use as much as possible of the buffer and put it into a single SSH protocol packet. This means that to get maximum performance when sending larger files, you should try to always pass in at least 32K of data to this function.

Returns actual number of bytes written. Lasterror being kErrorEagain when it would otherwise block. While kErrorEagain is an error, it isn't really a failure per se.

Until version 18.2 we send text as UTF-8. Version 18.3 or newer send bytes as they are in whatever encoding your string has.

See also:

• Write(data as MemoryBlock) as Integer

SSH2ChannelMBS.WriteStdErr(data as MemoryBlock) as Integer

Lasterror is set.

Write functions will use as much as possible of the buffer and put it into a single SSH protocol packet. This means that to get maximum performance when sending larger files, you should try to always pass in at least 32K of data to this function.

Returns actual number of bytes written. Lasterror being kErrorEagain when it would otherwise block. While kErrorEagain is an error, it isn't really a failure per se.

See also:

• WriteStdErr(text as string) as Integer

SSH2ChannelMBS.WriteStdErr(text as string) as Integer

Lasterror is set.

Write functions will use as much as possible of the buffer and put it into a single SSH protocol packet. This means that to get maximum performance when sending larger files, you should try to always pass in at least 32K of data to this function.

Returns actual number of bytes written. Lasterror being kErrorEagain when it would otherwise block. While kErrorEagain is an error, it isn't really a failure per se.

Until version 18.2 we send text as UTF-8. Version 18.3 or newer send bytes as they are in whatever encoding your string has.

See also:

• WriteStdErr(data as MemoryBlock) as Integer