Gocator API

- Home
- Types
- Files

All Classes Files Functions Variables Typedefs Macros Modules Pages
GoSerializer.h
Go to the documentation of this file.
1 /**
2 * @file GoSerializer.h
3 * @brief Declares the GoSerializer class.
4 *
5 * @internal
6 * Copyright (C) 2016 by LMI Technologies Inc.
7 * Licensed under the MIT License.
8 * Redistributed files must retain the above copyright notice.
9 */
10 #ifndef GO_SDK_SERIALIZER_H
11 #define GO_SDK_SERIALIZER_H
12
13 #include <GoSdk/GoSdkDef.h>
14 #include <kApi/Io/kSerializer.h>
15 kBeginHeader()
16
17 /**
18 * @class GoSerializer
19 * @extends kSerializer
20 * @ingroup GoSdk-Internal
21 * @brief Serializes/deserializes objects to/from Gocator Data Protocol.
22 */
23 typedef kSerializer GoSerializer;
24
25 /**
26 * Constructs a GoSerializer object.
27 *
28 * @public @memberof GoSerializer
29 * @version Introduced in firmware 4.0.10.27
30 * @param serializer Receives the constructed object.
31 * @param stream Stream for reading or writing.
32 * @param allocator Memory allocator (or kNULL for default).
33 * @return Operation status.
34 */
35 GoFx(kStatus) GoSerializer_Construct(GoSerializer* serializer, kStream stream, kAlloc allocator);
36
37 kEndHeader()
38 #include <GoSdk/Internal/GoSerializer.x.h>
39
40 #endif
GoSerializer::GoSerializer_Construct
kStatus GoSerializer_Construct(GoSerializer *serializer, kStream stream, kAlloc allocator)
Constructs a GoSerializer object.
GoSerializer
Serializes/deserializes objects to/from Gocator Data Protocol.
kAlloc
kSerializer
GoSdkDef.h
Essential SDK declarations.
kStream
kSerializer.h
kStatus