RTRlib
Loading...
Searching...
No Matches
tr_ssh_config Struct Reference

A tr_ssh_config struct holds configuration data for an tr_ssh socket. More...

#include <ssh_transport.h>

Data Fields

char * host
 
unsigned int port
 
char * bindaddr
 
char * username
 
char * server_hostkey_path
 
char * client_privkey_path
 
void * data
 
int(* new_socket )(void *data)
 
unsigned int connect_timeout
 
char * password
 

Detailed Description

A tr_ssh_config struct holds configuration data for an tr_ssh socket.

Parameters
hostHostname or IP address to connect to.
portPort to connect to.
bindaddrHostname or IP address to connect from. NULL for determination by OS.
usernameUsername for authentication.
server_hostkey_pathPath to public SSH key of the server or NULL to don't verify host authenticity.
client_privkey_pathPath to private key of the authentication keypair or NULL to use ~/.ssh/id_rsa.
dataInformation to pass to callback function in charge of retrieving socket
new_socket(void*opaque_info) callback routine, that Pointer to the function that is called every time a new connection is made. The returned socket is expected to be ready for use (e.g. in state established), and must use a reliably stream-oriented transport. When new_socket() is used, host, port, and bindaddr are not used.
connect_timeoutTime in seconds to wait for a successful connection. Defaults to RTRLIB_TRANSPORT_CONNECT_TIMEOUT_DEFAULT

Field Documentation

◆ bindaddr

char* tr_ssh_config::bindaddr

◆ client_privkey_path

char* tr_ssh_config::client_privkey_path

◆ connect_timeout

unsigned int tr_ssh_config::connect_timeout

◆ data

void* tr_ssh_config::data

◆ host

char* tr_ssh_config::host

◆ new_socket

int(* tr_ssh_config::new_socket) (void *data)

◆ password

char* tr_ssh_config::password

◆ port

unsigned int tr_ssh_config::port

◆ server_hostkey_path

char* tr_ssh_config::server_hostkey_path

◆ username

char* tr_ssh_config::username

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