libssh_messages(3)

NAME
libssh_messages - The SSH message functions

This file contains the message parsing utilities for client and server programs using libssh.

  Functions
void ssh_message_free (ssh_message msg)
Free a SSH message.
ssh_message ssh_message_get (ssh_session session)
Retrieve a SSH message from a SSH session.
int ssh_message_subtype (ssh_message msg)
Get the subtype of the message.
int ssh_message_type (ssh_message msg)
Get the type of the message.

Detailed Description

This file contains the message parsing utilities for client and server programs using libssh. On the server the the main loop of the program will call ssh_message_get(session) to get messages as they come. They are not 1-1 with the protocol messages. Then, the user will know what kind of a message it is and use the appropriate functions to handle it (or use the default handlers if you don't know what to do).

Function Documentation

  void ssh_message_free (ssh_message msg)

Free a SSH message.

Parameters:
    msg The message to release the memory.

References ssh_buffer_free(), ssh_buffer_new(), ssh_channel_free(), ssh_channel_new(), ssh_get_hexa(), ssh_key_free(), SSH_LOG_PACKET, SSH_LOG_PROTOCOL, SSH_LOG_WARNING, ssh_message_reply_default(), SSH_PACKET_CALLBACK, SSH_PACKET_NOT_USED, SSH_PACKET_USED, ssh_string_data(), ssh_string_free(), ssh_string_len(), and ssh_string_to_char().

Referenced by ssh_channel_request_x11(), ssh_disconnect(), ssh_free(), and ssh_set_message_callback().

  ssh_message ssh_message_get (ssh_session session)

Retrieve a SSH message from a SSH session.

Parameters:
    session The SSH session to get the message.

Returns:
    The SSH message received, NULL in case of error, or timeout elapsed.

Warning:
    This function blocks until a message has been received. Betterset up a callback if this behavior is unwanted.

  int ssh_message_subtype (ssh_message msg)

Get the subtype of the message.

Parameters:
    msg The message to get the subtype from.

Returns:
    The message type or -1 on error.

Referenced by ssh_channel_request_x11().

  int ssh_message_type (ssh_message msg)

Get the type of the message.

Parameters:
    msg The message to get the type from.

Returns:
    The message type or -1 on error.

Referenced by ssh_channel_request_x11().

Author

Generated automatically by Doxygen for libssh from the source code.