src/libqmi-glib/qmi-message-context.h

/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */

/*
 * libqmi-glib -- GLib/GIO based library to control QMI devices
 *
 * This library 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 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301 USA.
 *
 * Copyright (C) 2017 Aleksander Morgado <aleksander@aleksander.es>
 */

#ifndef _LIBQMI_GLIB_QMI_MESSAGE_CONTEXT_H_
#define _LIBQMI_GLIB_QMI_MESSAGE_CONTEXT_H_

#if !defined (__LIBQMI_GLIB_H_INSIDE__) && !defined (LIBQMI_GLIB_COMPILATION)
#error "Only <libqmi-glib.h> can be included directly."
#endif

#include <glib.h>
#include <glib-object.h>

G_BEGIN_DECLS

/**
 * SECTION:qmi-message-context
 * @short_description: the QMI message context
 *
 * The #QmiMessageContext defines non-standard features of the QMI message
 * associated with it, which may be required for a correct processing.
 *
 * The main purpose of this type is to provide a common context when processing
 * the request sent and the response received, so that the reception logic
 * can know in advance the type of response expected. Therefore, when a context
 * is given when sending a request with qmi_device_command_full(), the same
 * context will then be applied for the associated response.
 *
 * If there are multiple types of messages using the same service and command
 * id, the context is flagged as vendor-specific automatically, by assigning
 * a specific vendor id in the #QmiMessageContext. This does not mean that the
 * command will only be available for that specific vendor id, it is just a way
 * to make a difference among commands that have the same command id and a
 * totally different meaning. The actual vendor id value given in the context is
 * therefore really irrelevant, as long as the vendor id is different to the
 * other vendor ids specified for other commands reusing the same command id. In
 * order to simplify the selection of the vendor id, the library will use the
 * standard vendor-specific USB vendor id.
 */

/**
 * QmiMessageContext:
 *
 * An opaque type representing a QMI message context.
 *
 * Since: 1.18
 */
typedef struct _QmiMessageContext QmiMessageContext;

GType qmi_message_context_get_type (void);

/*****************************************************************************/
/* Basic context */

/**
 * qmi_message_context_new:
 *
 * Create a new empty #QmiMessageContext.
 *
 * Returns: (transfer full): a newly created #QmiMessageContext. The returned value should be freed with qmi_message_context_unref().
 *
 * Since: 1.18
 */
QmiMessageContext *qmi_message_context_new (void);

/**
 * qmi_message_context_ref:
 * @self: a #QmiMessageContext.
 *
 * Atomically increments the reference count of @self by one.
 *
 * Returns: (transfer full): the new reference to @self.
 *
 * Since: 1.18
 */
QmiMessageContext *qmi_message_context_ref (QmiMessageContext *self);

/**
 * qmi_message_context_unref:
 * @self: a #QmiMessageContext.
 *
 * Atomically decrements the reference count of @self by one.
 * If the reference count drops to 0, @self is completely disposed.
 *
 * Since: 1.18
 */
void qmi_message_context_unref (QmiMessageContext *self);
G_DEFINE_AUTOPTR_CLEANUP_FUNC (QmiMessageContext, qmi_message_context_unref)

/*****************************************************************************/
/* Vendor ID */

/**
 * QMI_MESSAGE_VENDOR_GENERIC:
 *
 * Generic vendor id (0x0000).
 *
 * Since: 1.18
 */
#define QMI_MESSAGE_VENDOR_GENERIC 0x0000

/**
 * qmi_message_context_set_vendor_id:
 * @self: a #QmiMessageContext.
 * @vendor_id: the vendor ID.
 *
 * Sets the vendor ID associated to the message.
 *
 * Since: 1.18
 */
void qmi_message_context_set_vendor_id (QmiMessageContext *self,
                                        guint16            vendor_id);

/**
 * qmi_message_context_get_vendor_id:
 * @self: a #QmiMessageContext.
 *
 * Gets the vendor ID associated to the message.
 *
 * Returns: the vendor ID.
 *
 * Since: 1.18
 */
guint16 qmi_message_context_get_vendor_id (QmiMessageContext *self);

G_END_DECLS

#endif /* _LIBQMI_GLIB_QMI_MESSAGE_CONTEXT_H_ */