SSHChannel

Undocumented in source.
class SSHChannel : Disposable {}

Constructors

this
this(SSHSession parent, ssh_channel channel)
Undocumented in source.

Destructor

~this
~this()
Undocumented in source.

Members

Aliases

OnAuthAgentRequestCallback
alias OnAuthAgentRequestCallback = void delegate(SSHChannel channel)
Undocumented in source.
OnCloseCallback
alias OnCloseCallback = void delegate(SSHChannel channel)
Undocumented in source.
OnDataCallback
alias OnDataCallback = uint delegate(SSHChannel channel, void[] data, bool isStdErr)
Undocumented in source.
OnEOFCallback
alias OnEOFCallback = void delegate(SSHChannel channel)
Undocumented in source.
OnEnvRequestCallback
alias OnEnvRequestCallback = bool delegate(SSHChannel channel, string name, string value)
Undocumented in source.
OnExecRequestCallback
alias OnExecRequestCallback = bool delegate(SSHChannel channel, string command)
Undocumented in source.
OnExitSignalCallback
alias OnExitSignalCallback = void delegate(SSHChannel channel, string signal, bool isCoreDump, string errMsg, string lang)
Undocumented in source.
OnExitStatusCallback
alias OnExitStatusCallback = void delegate(SSHChannel channel, int exitStatus)
Undocumented in source.
OnPtyRequestCallback
alias OnPtyRequestCallback = bool delegate(SSHChannel channel, string term, int width, int height, int pxWidth, int pxHeight)
Undocumented in source.
OnPtyWindowChangeRequestCallback
alias OnPtyWindowChangeRequestCallback = bool delegate(SSHChannel channel, int width, int height, int pxWidth, int pxHeight)
Undocumented in source.
OnShellRequestCallback
alias OnShellRequestCallback = bool delegate(SSHChannel channel)
Undocumented in source.
OnSignalCallback
alias OnSignalCallback = void delegate(SSHChannel channel, string signal)
Undocumented in source.
OnSubsystemRequestCallback
alias OnSubsystemRequestCallback = bool delegate(SSHChannel channel, string subsystem)
Undocumented in source.
OnX11RequestCallback
alias OnX11RequestCallback = void delegate(SSHChannel channel, bool isSingleConnection, string authProtocol, string authCookie, uint screenNumber)
Undocumented in source.

Functions

acceptX11
SSHChannel acceptX11(int timeoutMs)
Undocumented in source. Be warned that the author may not have intended to support it.
changePtySize
void changePtySize(int width, int height)
Undocumented in source. Be warned that the author may not have intended to support it.
close
void close()
Undocumented in source. Be warned that the author may not have intended to support it.
dispose
void dispose()
Undocumented in source. Be warned that the author may not have intended to support it.
openAuthAgent
bool openAuthAgent()

return false if in nonblocking mode and call has to be done again.

openForward
bool openForward(string remoteHost, ushort remotePort, string srcHost, ushort localPort)

return false if in nonblocking mode and call has to be done again.

openReverseForward
bool openReverseForward(string remoteHost, ushort remotePort, string srcHost, ushort localPort)

return false if in nonblocking mode and call has to be done again.

openSession
bool openSession()

returns false if in nonblocking mode and call has to be done again.

openX11
bool openX11(string origAddr, ushort origPort)

returns false if in nonblocking mode and call has to be done again.

poll
int poll(bool isStdErr)

returns SSHChannel.PollEof if EOF

pollTimeout
int pollTimeout(int timeout, bool isStdErr)

returns SSHChannel.PollEof if EOF

read
int read(void[] dest, bool isStdErr)

returns SSHChannel.ReadAgain in nonblocking mode

readNonBlocking
int readNonBlocking(void[] dest, bool isStdErr)

returns SSHChannel.ReadAgain in nonblocking mode

readTimeout
int readTimeout(void[] dest, bool isStdErr, int timeout)

returns SSHChannel.ReadAgain in nonblocking mode

requestExec
bool requestExec(string cmd)

returns false if in nonblocking mode and call has to be done again.

requestPty
bool requestPty()

returns false if in nonblocking mode and call has to be done again.

requestPtySize
bool requestPtySize(string terminalType, int width, int height)

returns false if in nonblocking mode and call has to be done again.

requestShell
bool requestShell()

returns false if in nonblocking mode and call has to be done again.

requestSubsystem
bool requestSubsystem(string subsystem)

returns false if in nonblocking mode and call has to be done again.

requestX11
bool requestX11(bool singleConnection, string protocol, string cookie, int screenNumber)

returns false if in nonblocking mode and call has to be done again.

sendEof
void sendEof()
Undocumented in source. Be warned that the author may not have intended to support it.
sendExitSignal
void sendExitSignal(string signal, bool core, string errMsg, string lang)
Undocumented in source. Be warned that the author may not have intended to support it.
sendExitStatus
void sendExitStatus(int exitStatus)
Undocumented in source. Be warned that the author may not have intended to support it.
sendSignal
void sendSignal(string signal)
Undocumented in source. Be warned that the author may not have intended to support it.
setEnv
bool setEnv(string name, string value)

returns false if in nonblocking mode and call has to be done again.

write
int write(void[] src)

returns SSHChannel.WriteAgain in nonblocking mode

writeStdErr
int writeStdErr(void[] src)

returns SSHChannel.WriteAgain in nonblocking mode

Manifest constants

PollEof
enum PollEof;
Undocumented in source.
ReadAgain
enum ReadAgain;
Undocumented in source.
WriteAgain
enum WriteAgain;
Undocumented in source.

Properties

blocking
bool blocking [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
exitStatus
int exitStatus [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
isClosed
bool isClosed [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
isEof
bool isEof [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
isOpen
bool isOpen [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
onAuthAgentRequestCallback
onAuthAgentRequestCallback [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
onAuthAgentRequestCallback
OnAuthAgentRequestCallback onAuthAgentRequestCallback [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
onCloseCallback
onCloseCallback [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
onCloseCallback
OnCloseCallback onCloseCallback [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
onDataCallback
OnDataCallback onDataCallback [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
onDataCallback
OnDataCallback onDataCallback [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
onEOFCallback
onEOFCallback [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
onEOFCallback
OnEOFCallback onEOFCallback [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
onEnvRequestCallback
OnEnvRequestCallback onEnvRequestCallback [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
onEnvRequestCallback
OnEnvRequestCallback onEnvRequestCallback [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
onExecRequestCallback
OnExecRequestCallback onExecRequestCallback [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
onExecRequestCallback
OnExecRequestCallback onExecRequestCallback [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
onExitSignalCallback
onExitSignalCallback [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
onExitSignalCallback
OnExitSignalCallback onExitSignalCallback [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
onExitStatusCallback
onExitStatusCallback [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
onExitStatusCallback
OnExitStatusCallback onExitStatusCallback [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
onPtyRequestCallback
OnPtyRequestCallback onPtyRequestCallback [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
onPtyRequestCallback
OnPtyRequestCallback onPtyRequestCallback [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
onPtyWindowChangeRequestCallback
OnPtyWindowChangeRequestCallback onPtyWindowChangeRequestCallback [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
onPtyWindowChangeRequestCallback
OnPtyWindowChangeRequestCallback onPtyWindowChangeRequestCallback [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
onShellRequestCallback
OnShellRequestCallback onShellRequestCallback [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
onShellRequestCallback
OnShellRequestCallback onShellRequestCallback [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
onSignalCallback
onSignalCallback [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
onSignalCallback
OnSignalCallback onSignalCallback [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
onSubsystemRequestCallback
OnSubsystemRequestCallback onSubsystemRequestCallback [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
onSubsystemRequestCallback
OnSubsystemRequestCallback onSubsystemRequestCallback [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
onX11RequestCallback
onX11RequestCallback [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.
onX11RequestCallback
OnX11RequestCallback onX11RequestCallback [@property setter]
Undocumented in source. Be warned that the author may not have intended to support it.
parent
SSHSession parent [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

select
bool select(SSHChannelSet readChans, SSHChannelSet writeChans, SSHChannelSet exceptChans, Duration timeout)

return false if the select(2) syscall was interrupted, then relaunch the function.

Variables

_channel
ssh_channel _channel;
Undocumented in source.

Inherited Members

From Disposable

dispose
void dispose()
Undocumented in source.

Meta