1 files changed, 126 insertions, 0 deletions
diff --git a/src/libmdsclient/inbound.h b/src/libmdsclient/inbound.h
new file mode 100644
index 0000000..a127c3e
--- /dev/null
+++ b/src/libmdsclient/inbound.h
@@ -0,0 +1,126 @@
+/**
+ * mds — A micro-display server
+ * Copyright © 2014, 2015  Mattias Andrée (maandree@member.fsf.org)
+ * 
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#ifndef MDS_LIBMDSCLIENT_INBOUND_H
+#define MDS_LIBMDSCLIENT_INBOUND_H
+/* This module is eerily similar to <libmdsserver/mds-message.h>,
+ * somethings have been removed, some things have been added. */
+
+
+#include <stddef.h>
+
+
+
+/**
+ * Message passed between a server and a client or between two of either
+ */
+typedef struct libmds_message
+{
+  /**
+   * The headers in the message, each element in this list
+   * as an unparsed header, it consists of both the header
+   * name and its associated value, joined by ": ". A header
+   * cannot be `NULL` (unless its memory allocation failed,)
+   * but `headers` itself is `NULL` if there are no headers.
+   * The "Length" header should be included in this list.
+   */
+  char** headers;
+  
+  /**
+   * The number of headers in the message
+   */
+  size_t header_count;
+  
+  /**
+   * The payload of the message, `NULL` if none (of zero-length)
+   */
+  char* payload;
+  
+  /**
+   * The size of the payload
+   */
+  size_t payload_size;
+  
+  /**
+   * How much of the payload that has been stored (internal data)
+   */
+  size_t payload_ptr;
+  
+  /**
+   * Internal buffer for the reading function (internal data)
+   */
+  char* buffer;
+  
+  /**
+   * The size allocated to `buffer` (internal data)
+   */
+  size_t buffer_size;
+  
+  /**
+   * The number of bytes used in `buffer` (internal data)
+   */
+  size_t buffer_ptr;
+  
+  /**
+   * 0 while reading headers, 1 while reading payload, and 2 when done (internal data)
+   */
+  int stage;
+  
+} libmds_message_t;
+
+
+
+/**
+ * Initialise a message slot so that it can
+ * be used by `libmds_message_read`
+ * 
+ * @param   this  Memory slot in which to store the new message
+ * @return        Non-zero on error, `errno` will be set accordingly.
+ *                Destroy the message on error.
+ */
+__attribute__((nonnull))
+int libmds_message_initialise(libmds_message_t* restrict this);
+
+/**
+ * Release all resources in a message, should
+ * be done even if initialisation fails
+ * 
+ * @param  this  The message
+ */
+__attribute__((nonnull))
+void libmds_message_destroy(libmds_message_t* restrict this);
+
+/**
+ * Read the next message from a file descriptor
+ * 
+ * @param   this  Memory slot in which to store the new message
+ * @param   fd    The file descriptor
+ * @return        Non-zero on error or interruption, `errno` will be
+ *                set accordingly. Destroy the message on error,
+ *                be aware that the reading could have been
+ *                interrupted by a signal rather than canonical error.
+ *                If -2 is returned `errno` will not have been set,
+ *                -2 indicates that the message is malformated,
+ *                which is a state that cannot be recovered from.
+ */
+__attribute__((nonnull))
+int libmds_message_read(libmds_message_t* restrict this, int fd);
+
+
+
+#endif
+