summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAleksander Morgado <aleksander@lanedo.com>2012-09-24 16:39:47 +0200
committerAleksander Morgado <aleksander@lanedo.com>2012-09-26 09:25:06 +0200
commitc3c3acb3e6acd6782f81ef246e94beedc8eb8f0b (patch)
tree44ba922f4a6cbe51c9088940ec194a8ae76b39ec
parent7d3b6b3385f466848a9fe94d98a657594e66e880 (diff)
message: improve header readability
-rw-r--r--libqmi-glib/qmi-message.h63
1 files changed, 36 insertions, 27 deletions
diff --git a/libqmi-glib/qmi-message.h b/libqmi-glib/qmi-message.h
index 0b71503..d147bcf 100644
--- a/libqmi-glib/qmi-message.h
+++ b/libqmi-glib/qmi-message.h
@@ -45,6 +45,9 @@ G_BEGIN_DECLS
*/
typedef struct _QmiMessage QmiMessage;
+/*****************************************************************************/
+/* QMI Message life cycle */
+
QmiMessage *qmi_message_new (QmiService service,
guint8 client_id,
guint16 transaction_id,
@@ -54,23 +57,44 @@ QmiMessage *qmi_message_new_from_raw (const guint8 *raw,
QmiMessage *qmi_message_ref (QmiMessage *self);
void qmi_message_unref (QmiMessage *self);
+/*****************************************************************************/
+/* QMI Message content getters */
+
+gboolean qmi_message_is_response (QmiMessage *self);
+gboolean qmi_message_is_indication (QmiMessage *self);
+QmiService qmi_message_get_service (QmiMessage *self);
+guint8 qmi_message_get_client_id (QmiMessage *self);
+guint16 qmi_message_get_transaction_id (QmiMessage *self);
+guint16 qmi_message_get_message_id (QmiMessage *self);
+gsize qmi_message_get_length (QmiMessage *self);
+const guint8 *qmi_message_get_raw (QmiMessage *self,
+ gsize *length,
+ GError **error);
+gboolean qmi_message_get_version_introduced (QmiMessage *self,
+ guint *major,
+ guint *minor);
+
+/*****************************************************************************/
+/* Raw TLV handling */
+
typedef void (* QmiMessageForeachRawTlvFn) (guint8 type,
const guint8 *value,
gsize length,
gpointer user_data);
-void qmi_message_foreach_raw_tlv (QmiMessage *self,
- QmiMessageForeachRawTlvFn func,
- gpointer user_data);
-
-const guint8 *qmi_message_get_raw_tlv (QmiMessage *self,
- guint8 type,
- guint16 *length);
+void qmi_message_foreach_raw_tlv (QmiMessage *self,
+ QmiMessageForeachRawTlvFn func,
+ gpointer user_data);
+const guint8 *qmi_message_get_raw_tlv (QmiMessage *self,
+ guint8 type,
+ guint16 *length);
+gboolean qmi_message_add_raw_tlv (QmiMessage *self,
+ guint8 type,
+ const guint8 *raw,
+ gsize length,
+ GError **error);
-gboolean qmi_message_add_raw_tlv (QmiMessage *self,
- guint8 type,
- const guint8 *raw,
- gsize length,
- GError **error);
+/*****************************************************************************/
+/* Printable helpers */
gchar *qmi_message_get_printable (QmiMessage *self,
const gchar *line_prefix);
@@ -84,21 +108,6 @@ gchar *qmi_message_get_tlv_printable (QmiMessage *self,
gboolean qmi_message_check (QmiMessage *self,
GError **error);
-gboolean qmi_message_is_response (QmiMessage *self);
-gboolean qmi_message_is_indication (QmiMessage *self);
-QmiService qmi_message_get_service (QmiMessage *self);
-guint8 qmi_message_get_client_id (QmiMessage *self);
-guint16 qmi_message_get_transaction_id (QmiMessage *self);
-guint16 qmi_message_get_message_id (QmiMessage *self);
-gsize qmi_message_get_length (QmiMessage *self);
-const guint8 *qmi_message_get_raw (QmiMessage *self,
- gsize *length,
- GError **error);
-
-gboolean qmi_message_get_version_introduced (QmiMessage *self,
- guint *major,
- guint *minor);
-
G_END_DECLS
#endif /* _LIBQMI_GLIB_QMI_MESSAGE_H_ */