diff options
Diffstat (limited to 'src/session.rs')
| -rw-r--r-- | src/session.rs | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/src/session.rs b/src/session.rs index 49948f1..9707a77 100644 --- a/src/session.rs +++ b/src/session.rs @@ -8,6 +8,11 @@ use libc::{mod, c_uint, c_int, c_void, c_long}; use {raw, Error, DisconnectCode, ByApplication, SessionFlag, HostKeyType}; use {MethodType, Agent, Channel, Listener, HashType, KnownHosts, Sftp}; +/// An SSH session, typically representing one TCP connection. +/// +/// All other structures are based on an SSH session and cannot outlive a +/// session. Sessions are created and then have the TCP socket handed to them +/// (via the `handshake` method). pub struct Session { raw: *mut raw::LIBSSH2_SESSION, marker: marker::NoSync, |