1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
|
/* -*- 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
* @title: QmiMessageContext
* @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.
*
* 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.
*/
/**
* 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);
/*****************************************************************************/
/* 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_ */
|
