GATE
Classes | Macros | Typedefs | Functions
sshclients.h File Reference
GATE Net Library

SSH client library. More...

#include "gate/net/gate_net_api.h"
#include "gate/strings.h"
#include "gate/streams.h"
#include "gate/files.h"

Classes

struct  gate_sshclient_class
 

Macros

#define GATE_SSHCLIENT_DEFAULT_PORT   22
 
#define GATE_SSHCLIENT_STREAMTYPE_DEFAULT   0
 
#define GATE_SSHCLIENT_STREAMTYPE_ERROR   1
 

Typedefs

typedef struct gate_sshclient_class gate_sshclient_t
 
typedef void * gate_sshclient_sftp_t
 
typedef void * gate_sshclient_sftp_handle_t
 
typedef void * gate_sshclient_channel_t
 

Functions

GATE_NET_API gate_result_t gate_sshclient_create (gate_sshclient_t *client, gate_string_t const *server, gate_uint16_t port)
 
GATE_NET_API gate_result_t gate_sshclient_connect (gate_sshclient_t *client, gate_string_t const *user, gate_string_t const *password, gate_uint32_t flags)
 
GATE_NET_API gate_result_t gate_sshclient_disconnect (gate_sshclient_t *client)
 
GATE_NET_API gate_result_t gate_sshclient_release (gate_sshclient_t *client)
 
GATE_NET_API gate_result_t gate_sshclient_open_sftp (gate_sshclient_t *client, gate_sshclient_sftp_t *sftp)
 
GATE_NET_API gate_result_t gate_sshclient_close_sftp (gate_sshclient_sftp_t *sftp)
 
GATE_NET_API gate_result_t gate_sshclient_sftp_open (gate_sshclient_sftp_t *sftp, gate_string_t const *path, gate_uint32_t stream_open_flags, gate_sshclient_sftp_handle_t *sftp_handle)
 
GATE_NET_API gate_result_t gate_sshclient_sftp_read (gate_sshclient_sftp_handle_t *sftp_handle, char *buffer, gate_size_t capacity, gate_size_t *returned)
 
GATE_NET_API gate_result_t gate_sshclient_sftp_write (gate_sshclient_sftp_handle_t *sftp_handle, char const *buffer, gate_size_t length, gate_size_t *written)
 
GATE_NET_API gate_result_t gate_sshclient_sftp_seek (gate_sshclient_sftp_handle_t *sftp_handle, gate_uint64_t position)
 
GATE_NET_API gate_result_t gate_sshclient_sftp_tell (gate_sshclient_sftp_handle_t *sftp_handle, gate_uint64_t *position)
 
GATE_NET_API gate_result_t gate_sshclient_sftp_close (gate_sshclient_sftp_handle_t *sftp_handle)
 
GATE_NET_API gate_result_t gate_sshclient_sftp_opendir (gate_sshclient_sftp_t *sftp, gate_string_t const *path, gate_sshclient_sftp_handle_t *sftp_handle)
 
GATE_NET_API gate_result_t gate_sshclient_sftp_readdir (gate_sshclient_sftp_handle_t *sftp_handle, gate_file_entry_t *file_entry)
 
GATE_NET_API gate_result_t gate_sshclient_sftp_listdir (gate_sshclient_sftp_t *sftp, gate_string_t const *path, gate_file_list_callback_t callback, void *userdata)
 
GATE_NET_API gate_result_t gate_sshclient_sftp_mkdir (gate_sshclient_sftp_t *sftp, gate_string_t const *path)
 
GATE_NET_API gate_result_t gate_sshclient_sftp_rmdir (gate_sshclient_sftp_t *sftp, gate_string_t const *path)
 
GATE_NET_API gate_result_t gate_sshclient_sftp_unlink (gate_sshclient_sftp_t *sftp, gate_string_t const *path)
 
GATE_NET_API gate_result_t gate_sshclient_sftp_rename (gate_sshclient_sftp_t *sftp, gate_string_t const *src_path, gate_string_t const *dst_path)
 
GATE_NET_API gate_result_t gate_sshclient_sftp_stat (gate_sshclient_sftp_t *sftp, gate_string_t const *path, gate_file_properties_t *file_props)
 
GATE_NET_API gate_result_t gate_sshclient_channel_open (gate_sshclient_t *client, gate_sshclient_channel_t *ptr_channel)
 
GATE_NET_API gate_result_t gate_sshclient_channel_close (gate_sshclient_channel_t *channel)
 
GATE_NET_API gate_result_t gate_sshclient_channel_free (gate_sshclient_channel_t *channel)
 
GATE_NET_API gate_result_t gate_sshclient_channel_exec (gate_sshclient_channel_t *channel, gate_string_t const *command)
 
GATE_NET_API gate_result_t gate_sshclient_channel_canread (gate_sshclient_channel_t *channel, gate_enumint_t stream_type, gate_bool_t *ptr_canread)
 
GATE_NET_API gate_result_t gate_sshclient_channel_read (gate_sshclient_channel_t *channel, gate_enumint_t stream_type, char *buffer, gate_size_t bufferlen, gate_size_t *bufferused)
 
GATE_NET_API gate_result_t gate_sshclient_channel_write (gate_sshclient_channel_t *channel, gate_enumint_t stream_type, char const *buffer, gate_size_t bufferlen, gate_size_t *bufferprocessed)
 
GATE_NET_API gate_bool_t gate_sshclient_channel_eof (gate_sshclient_channel_t *channel)
 
GATE_NET_API gate_result_t gate_sshclient_channel_send_eof (gate_sshclient_channel_t *channel)
 
GATE_NET_API gate_result_t gate_sshclient_channel_wait_eof (gate_sshclient_channel_t *channel)
 
GATE_NET_API gate_result_t gate_sshclient_channel_setenv (gate_sshclient_channel_t *channel, gate_string_t const *name, gate_string_t const *value)
 
GATE_NET_API gate_result_t gate_sshclient_channel_get_exit_signal (gate_sshclient_channel_t *channel, gate_string_t *ptr_signal, gate_string_t *ptr_errmsg, gate_string_t *ptr_langtag)
 
GATE_NET_API gate_result_t gate_sshclient_channel_get_exit_status (gate_sshclient_channel_t *channel, int *ptr_status)
 

Detailed Description

SSH client library.