SSHNetworkConnectionInterface Class Reference

#include <network_ip_ssh.h>

Inheritance diagram for SSHNetworkConnectionInterface:

Detailed Description

This class handles SSH encrypted network connections.

Public Member Functions

MAXON_METHOD Result< void > Init (const NetworkConnectionRef &connection, Bool blocking)
 
MAXON_METHOD Result< void > DoHandShake ()
 
MAXON_METHOD Result< void > LogIn (const String &name, const String &password, SSH_CHANGE_PASSWORD_CALLBACK changePasswordCallback=nullptr)
 
MAXON_METHOD LIBSSH2_SESSIONGetSession ()
 
MAXON_METHOD const StringGetFingerprint () const
 

Private Member Functions

 MAXON_INTERFACE (SSHNetworkConnectionInterface, MAXON_REFERENCE_NORMAL, "net.maxon.interface.sshnetworkconnection")
 

Member Function Documentation

◆ MAXON_INTERFACE()

MAXON_INTERFACE ( SSHNetworkConnectionInterface  ,
MAXON_REFERENCE_NORMAL  ,
"net.maxon.interface.sshnetworkconnection"   
)
private

◆ Init()

MAXON_METHOD Result<void> Init ( const NetworkConnectionRef &  connection,
Bool  blocking 
)

◆ DoHandShake()

MAXON_METHOD Result<void> DoHandShake ( )

◆ LogIn()

MAXON_METHOD Result<void> LogIn ( const String name,
const String password,
SSH_CHANGE_PASSWORD_CALLBACK  changePasswordCallback = nullptr 
)

◆ GetSession()

MAXON_METHOD LIBSSH2_SESSION* GetSession ( )

◆ GetFingerprint()

MAXON_METHOD const String& GetFingerprint ( ) const

Gets the fingerprint of the server.

Returns
The server's fingerprint.