lib/libssh
1
0
Fork 0
mirror of https://git.libssh.org/projects/libssh.git synced 2025-11-30 13:01:23 +03:00
Code Activity

doc: Added missing doc for common message function.

Browse Source
This commit is contained in:
Andreas Schneider
2011-03-09 19:19:56 +01:00
parent e2706fe21d
commit 52e223dfdd
1 changed files with 19 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
src/messages.c
View File

@@ -144,6 +144,13 @@ ssh_message ssh_message_get(ssh_session session) {
return msg; return msg;
} }
/**
* @brief Get the type of the message.
*
* @param[in] msg The message to get the type from.
*
* @return The message type or -1 on error.
*/
int ssh_message_type(ssh_message msg) { int ssh_message_type(ssh_message msg) {
if (msg == NULL) { if (msg == NULL) {
return -1; return -1;
@@ -152,6 +159,13 @@ int ssh_message_type(ssh_message msg) {
return msg->type; return msg->type;
} }
/**
* @brief Get the subtype of the message.
*
* @param[in] msg The message to get the subtype from.
*
* @return The message type or -1 on error.
*/
int ssh_message_subtype(ssh_message msg) { int ssh_message_subtype(ssh_message msg) {
if (msg == NULL) { if (msg == NULL) {
return -1; return -1;
@@ -171,6 +185,11 @@ int ssh_message_subtype(ssh_message msg) {
return -1; return -1;
} }
/**
* @brief Free a SSH message.
*
* @param[in] msg The message to release the memory.
*/
void ssh_message_free(ssh_message msg){ void ssh_message_free(ssh_message msg){
if (msg == NULL) { if (msg == NULL) {
return; return;