summaryrefslogtreecommitdiffstats
path: root/doc/src/jsonstreamnamespace.qdoc
blob: 630e24f1c5d8b7da8896c80e179d3601340743b8 (plain)
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
/****************************************************************************
**
** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtAddOn.JsonStream module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

\*!
    \namespace JsonStream
    \brief The JsonStream namespace contains miscellaneous identifiers
     used throughout the JsonStream library.
*/

/*!
  \headerfile <jsonstream-global.h>
  \title Global JsonStream declarations

  \brief The <jsonstream-global.h> file provides namespace
         declarations and global enumerations for JsonStream.
 */

/*!
  \relates <jsonstream-global.h>
  \enum EncodingFormat

  This enum is used to control the serialization format of the data stream.
  All data streams start as \c JsonStream::FormatUndefined.  Once a data message is received,
  the stream automatically switches to the format of the received message.

  \value FormatUndefined    No messages have been sent or received yet.
  \value FormatUTF8         UTF-8
  \value FormatBSON         BSON binary format
  \value FormatQBJS         Qt Binary Json
  \value FormatUTF16BE      UTF-16, Big Endian
  \value FormatUTF16LE      UTF-16, Little Endian
*/