aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Schneider <asn@cryptomilk.org>2011-03-09 19:19:56 +0100
committerAndreas Schneider <asn@cryptomilk.org>2011-03-09 19:19:56 +0100
commit52e223dfdd560152d7030d39f3e1a0a51041c349 (patch)
tree1eec906a6f082580a144b0274db870379cf84f79
parente2706fe21d8eb4b7c15927ec39a07586cb13f6b6 (diff)
downloadlibssh-52e223dfdd560152d7030d39f3e1a0a51041c349.tar.gz
libssh-52e223dfdd560152d7030d39f3e1a0a51041c349.tar.xz
libssh-52e223dfdd560152d7030d39f3e1a0a51041c349.zip
doc: Added missing doc for common message function.
-rw-r--r--src/messages.c19
1 files changed, 19 insertions, 0 deletions
diff --git a/src/messages.c b/src/messages.c
index 4d7382a..5953338 100644
--- a/src/messages.c
+++ b/src/messages.c
@@ -144,6 +144,13 @@ ssh_message ssh_message_get(ssh_session session) {
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) {
if (msg == NULL) {
return -1;
@@ -152,6 +159,13 @@ int ssh_message_type(ssh_message msg) {
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) {
if (msg == NULL) {
return -1;
@@ -171,6 +185,11 @@ int ssh_message_subtype(ssh_message msg) {
return -1;
}
+/**
+ * @brief Free a SSH message.
+ *
+ * @param[in] msg The message to release the memory.
+ */
void ssh_message_free(ssh_message msg){
if (msg == NULL) {
return;