libssh  0.7.3
Public Member Functions
ssh::Channel Class Reference

the ssh::Channel class describes the state of an SSH channel. More...

#include <include/libssh/libsshpp.hpp>

Public Member Functions

ChannelacceptX11 (int timeout_ms)
 accept an incoming X11 connection More...
 
void changePtySize (int cols, int rows)
 change the size of a pseudoterminal More...
 
void close ()
 closes a channel More...
 
bool isClosed ()
 returns true if channel is in closed state More...
 
bool isEof ()
 returns true if channel is in EOF state More...
 
bool isOpen ()
 returns true if channel is in open state More...
 
int write (const void *data, size_t len, bool is_stderr=false)
 Writes on a channel. More...
 

Detailed Description

the ssh::Channel class describes the state of an SSH channel.

See also
ssh_channel

Member Function Documentation

Channel* ssh::Channel::acceptX11 ( int  timeout_ms)
inline

accept an incoming X11 connection

Parameters
[in]timeout_mstimeout for waiting, in ms
Returns
new Channel pointer on the X11 connection
NULL in case of error
Warning
you have to delete this pointer after use
See also
ssh_channel_accept_x11
Channel::requestX11

References ssh_channel_accept_x11().

void ssh::Channel::changePtySize ( int  cols,
int  rows 
)
inline

change the size of a pseudoterminal

Parameters
[in]colsnumber of columns
[in]rowsnumber of rows
Exceptions
SshExceptionon error
See also
ssh_channel_change_pty_size

References ssh_channel_change_pty_size().

void ssh::Channel::close ( )
inline

closes a channel

Exceptions
SshExceptionon error
See also
ssh_channel_close

References ssh_channel_close(), and ssh_channel_get_exit_status().

bool ssh::Channel::isClosed ( )
inline

returns true if channel is in closed state

See also
ssh_channel_is_closed

References ssh_channel_is_closed().

bool ssh::Channel::isEof ( )
inline

returns true if channel is in EOF state

See also
ssh_channel_is_eof

References ssh_channel_is_eof().

bool ssh::Channel::isOpen ( )
inline
int ssh::Channel::write ( const void *  data,
size_t  len,
bool  is_stderr = false 
)
inline

Writes on a channel.

Parameters
datadata to write.
lennumber of bytes to write.
is_stderrwrite should be done on the stderr channel (server only)
Returns
number of bytes written
Exceptions
SshExceptionin case of error
See also
channel_write
channel_write_stderr

References ssh_channel_write(), and ssh_channel_write_stderr().


The documentation for this class was generated from the following file: