FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kMsgInfo.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_MSG_INFO_H
9 #define K_FIRESYNC_MSG_INFO_H
10 
11 #include <kFireSync/kNodeDef.h>
12 #include <kFireSync/Data/kMsgInfo.x.h>
13 
62 //typedef kObject kMsgInfo; --forward-declared in kFsDef.x.h
63 
75  kFsFx(kStatus) kMsgInfo_Construct(kMsgInfo* info, kMsgSource source, kSize tag, kMsgSet message, kAlloc allocator);
76 
86 {
87  kObj(kMsgInfo, info);
88 
89  obj->source = source;
90 
91  return kOK;
92 }
93 
102 {
103  kObj(kMsgInfo, info);
104 
105  return obj->source;
106 }
107 
124 {
125  kObj(kMsgInfo, info);
126 
127  obj->tag = tag;
128 
129  return kOK;
130 }
131 
144 {
145  kObj(kMsgInfo, info);
146 
147  return obj->tag;
148 }
149 
159 {
160  kObj(kMsgInfo, info);
161 
162  obj->message = message;
163 
164  return kOK;
165 }
166 
175 {
176  kObj(kMsgInfo, info);
177 
178  return obj->message;
179 }
180 
181 #endif
kMsgSet kMsgInfo_Message(kMsgInfo info)
Gets the message object.
Definition: kMsgInfo.h:174
Represents information about the source of a pipe message.
Definition: kNodeDef.h:2508
#define kInlineFx(TYPE)
Essential declarations related to FireSync nodes.
kStatus kMsgInfo_SetTag(kMsgInfo info, kSize tag)
Sets the message tag.
Definition: kMsgInfo.h:123
kMsgSource kMsgInfo_Source(kMsgInfo info)
Gets the message source.
Definition: kMsgInfo.h:101
kStatus kMsgInfo_SetSource(kMsgInfo info, kMsgSource source)
Sets the message source.
Definition: kMsgInfo.h:85
#define kObj(TypeName_T, T_object)
kSize kMsgInfo_Tag(kMsgInfo info)
Gets the message tag.
Definition: kMsgInfo.h:143
Abstract base class for FireSync data messages.
#define kOK
kStatus kMsgInfo_Construct(kMsgInfo *info, kMsgSource source, kSize tag, kMsgSet message, kAlloc allocator)
Constructs a kMsgInfo object.
kStatus kMsgInfo_SetMessage(kMsgInfo info, kMsgSet message)
Sets the message object.
Definition: kMsgInfo.h:158
Represents message source information and an attached message.