multipath-tools: remove "c" from __cpluscplus, misspelled
[multipath-tools/.git] / libmpathcmd / mpath_cmd.h
index f33f000..df9d938 100644 (file)
@@ -5,7 +5,7 @@
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public License
  *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public License
- * as published by the Free Software Foundation; either version 2
+ * as published by the Free Software Foundation; either version 2.1
  * of the License, or (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * of the License, or (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU Lesser General Public License for more details.
  *
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301,
- * USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 #ifndef LIB_MPATH_CMD_H
 #define LIB_MPATH_CMD_H
 
  */
 
 #ifndef LIB_MPATH_CMD_H
 #define LIB_MPATH_CMD_H
 
-#ifdef __cpluscplus
+#ifdef __cplusplus
 extern "C" {
 #endif
 
 #define DEFAULT_SOCKET         "/org/kernel/linux/storage/multipathd"
 extern "C" {
 #endif
 
 #define DEFAULT_SOCKET         "/org/kernel/linux/storage/multipathd"
-#define DEFAULT_REPLY_TIMEOUT  1000
-#define MAX_REPLY_LEN          65536
+#define DEFAULT_REPLY_TIMEOUT  4000
 
 
 /*
  * DESCRIPTION:
 
 
 /*
  * DESCRIPTION:
- *     Connect to the running multipathd daemon. On systems with the
- *     multipathd.socket systemd unit file installed, this command will
- *     start multipathd if it is not already running. This function
- *     must be run before any of the others in this library
+ *     Connect to the running multipathd daemon. On systems with the
+ *     multipathd.socket systemd unit file installed, this command will
+ *     start multipathd if it is not already running. This function
+ *     must be run before any of the others in this library
  *
  * RETURNS:
  *
  * RETURNS:
- *     A file descriptor on success. -1 on failure (with errno set).
+ *     A file descriptor on success. -1 on failure (with errno set).
  */
 int mpath_connect(void);
 
 
 /*
  * DESCRIPTION:
  */
 int mpath_connect(void);
 
 
 /*
  * DESCRIPTION:
- *     Disconnect from the multipathd daemon. This function must be
- *     run after after processing all the multipath commands.
+ *     Disconnect from the multipathd daemon. This function must be
+ *     run after after processing all the multipath commands.
  *
  * RETURNS:
  *
  * RETURNS:
- *     0 on success. -1 on failure (with errno set).
+ *     0 on success. -1 on failure (with errno set).
  */
 int mpath_disconnect(int fd);
 
 
 /*
  * DESCRIPTION
  */
 int mpath_disconnect(int fd);
 
 
 /*
  * DESCRIPTION
- *     Send multipathd a command and return the reply. This function
- *     does the same as calling mpath_send_cmd() and then
+ *     Send multipathd a command and return the reply. This function
+ *     does the same as calling mpath_send_cmd() and then
  *     mpath_recv_reply()
  *
  * RETURNS:
  *     mpath_recv_reply()
  *
  * RETURNS:
- *     0 on successs, and reply will either be NULL (if there was no
- *     reply data), or point to the reply string, which must be freed by
- *     the caller. -1 on failure (with errno set).
+ *     0 on successs, and reply will either be NULL (if there was no
+ *     reply data), or point to the reply string, which must be freed by
+ *     the caller. -1 on failure (with errno set).
  */
 int mpath_process_cmd(int fd, const char *cmd, char **reply,
                      unsigned int timeout);
  */
 int mpath_process_cmd(int fd, const char *cmd, char **reply,
                      unsigned int timeout);
@@ -72,50 +69,50 @@ int mpath_process_cmd(int fd, const char *cmd, char **reply,
 
 /*
  * DESCRIPTION:
 
 /*
  * DESCRIPTION:
- *     Send a command to multipathd
+ *     Send a command to multipathd
  *
  * RETURNS:
  *
  * RETURNS:
- *     0 on success. -1 on failure (with errno set)
+ *     0 on success. -1 on failure (with errno set)
  */
 int mpath_send_cmd(int fd, const char *cmd);
 
 
 /*
  * DESCRIPTION:
  */
 int mpath_send_cmd(int fd, const char *cmd);
 
 
 /*
  * DESCRIPTION:
- *     Return a reply from multipathd for a previously sent command.
- *     This is equivalent to calling mpath_recv_reply_len(), allocating
- *     a buffer of the appropriate size, and then calling
+ *     Return a reply from multipathd for a previously sent command.
+ *     This is equivalent to calling mpath_recv_reply_len(), allocating
+ *     a buffer of the appropriate size, and then calling
  *     mpath_recv_reply_data() with that buffer.
  *
  * RETURNS:
  *     mpath_recv_reply_data() with that buffer.
  *
  * RETURNS:
- *     0 on success, and reply will either be NULL (if there was no
- *     reply data), or point to the reply string, which must be freed by
- *     the caller, -1 on failure (with errno set).
+ *     0 on success, and reply will either be NULL (if there was no
+ *     reply data), or point to the reply string, which must be freed by
+ *     the caller, -1 on failure (with errno set).
  */
 int mpath_recv_reply(int fd, char **reply, unsigned int timeout);
 
 
 /*
  * DESCRIPTION:
  */
 int mpath_recv_reply(int fd, char **reply, unsigned int timeout);
 
 
 /*
  * DESCRIPTION:
- *     Return the size of the upcoming reply data from the sent multipath
- *     command. This must be called before calling mpath_recv_reply_data().
+ *     Return the size of the upcoming reply data from the sent multipath
+ *     command. This must be called before calling mpath_recv_reply_data().
  *
  * RETURNS:
  *
  * RETURNS:
- *     The required size of the reply data buffer on success. -1 on
- *     failure (with errno set).
+ *     The required size of the reply data buffer on success. -1 on
+ *     failure (with errno set).
  */
 ssize_t mpath_recv_reply_len(int fd, unsigned int timeout);
 
 
 /*
  * DESCRIPTION:
  */
 ssize_t mpath_recv_reply_len(int fd, unsigned int timeout);
 
 
 /*
  * DESCRIPTION:
- *     Return the reply data from the sent multipath command.
- *     mpath_recv_reply_len must be called first. reply must point to a
- *     buffer of len size.
+ *     Return the reply data from the sent multipath command.
+ *     mpath_recv_reply_len must be called first. reply must point to a
+ *     buffer of len size.
  *
  * RETURNS:
  *
  * RETURNS:
- *     0 on success, and reply will contain the reply data string. -1
- *     on failure (with errno set).
+ *     0 on success, and reply will contain the reply data string. -1
+ *     on failure (with errno set).
  */
 int mpath_recv_reply_data(int fd, char *reply, size_t len,
                          unsigned int timeout);
  */
 int mpath_recv_reply_data(int fd, char *reply, size_t len,
                          unsigned int timeout);