struct ssh_channel_callbacks_struct

Overview

#include <include/libssh/callbacks.h>

struct ssh_channel_callbacks_struct {
    // fields

    ssh_channel_auth_agent_req_callback channel_auth_agent_req_function;
    ssh_channel_close_callback channel_close_function;
    ssh_channel_data_callback channel_data_function;
    ssh_channel_env_request_callback channel_env_request_function;
    ssh_channel_eof_callback channel_eof_function;
    ssh_channel_exec_request_callback channel_exec_request_function;
    ssh_channel_exit_signal_callback channel_exit_signal_function;
    ssh_channel_exit_status_callback channel_exit_status_function;
    ssh_channel_pty_request_callback channel_pty_request_function;
    ssh_channel_pty_window_change_callback channel_pty_window_change_function;
    ssh_channel_shell_request_callback channel_shell_request_function;
    ssh_channel_signal_callback channel_signal_function;
    ssh_channel_subsystem_request_callback channel_subsystem_request_function;
    ssh_channel_x11_req_callback channel_x11_req_function;
    size_t size;
    void* userdata;
};

Detailed Documentation

Fields

ssh_channel_auth_agent_req_callback channel_auth_agent_req_function

This function will be called when a client requests agent authentication forwarding.

ssh_channel_close_callback channel_close_function

This functions will be called when the channel has been closed by remote.

ssh_channel_data_callback channel_data_function

This functions will be called when there is data available.

ssh_channel_env_request_callback channel_env_request_function

This function will be called when a client requests an environment variable to be set.

ssh_channel_eof_callback channel_eof_function

This functions will be called when the channel has received an EOF.

ssh_channel_exec_request_callback channel_exec_request_function

This function will be called when a client requests a command execution.

ssh_channel_exit_signal_callback channel_exit_signal_function

This functions will be called when an exit signal has been received.

ssh_channel_exit_status_callback channel_exit_status_function

This functions will be called when an exit status has been received.

ssh_channel_pty_request_callback channel_pty_request_function

This function will be called when a client requests a PTY.

ssh_channel_pty_window_change_callback channel_pty_window_change_function

This function will be called when a client requests a window change.

ssh_channel_shell_request_callback channel_shell_request_function

This function will be called when a client requests a shell.

ssh_channel_signal_callback channel_signal_function

This functions will be called when a signal has been received.

ssh_channel_subsystem_request_callback channel_subsystem_request_function

This function will be called when a client requests a subsystem (like sftp).

ssh_channel_x11_req_callback channel_x11_req_function

This function will be called when a client requests X11 forwarding.

size_t size

DON’T SET THIS use ssh_callbacks_init() instead.

void* userdata

User-provided data.

User is free to set anything he wants here