Gocator API
 All Classes Files Functions Variables Typedefs Macros Groups 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) 2011-2012 by LMI Technologies Inc.
7  * Licensed under the MIT License.
8  * Redistributed files must retain the above copyright notice.
9  */
10 #ifndef GO_API_SERIALIZER_H
11 #define GO_API_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
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  * @param serializer Receives the constructed object.
30  * @param stream Stream for reading or writing.
31  * @param allocator Memory allocator (or kNULL for default).
32  * @return Operation status.
33  */
34 GoFx(kStatus) GoSerializer_Construct(GoSerializer* serializer, kStream stream, kAlloc allocator);
35 
36 kEndHeader()
37 #include <GoSdk/GoSerializer.x.h>
38 
39 #endif
Serializes/deserializes objects to/from Gocator Data Protocol.
Definition: GoSerializer.h:15
kStatus GoSerializer_Construct(GoSerializer *serializer, kStream stream, kAlloc allocator)
Constructs a GoSerializer object.
Essential API declarations.