gxPL  1.0
Tools, Application and Framework for xPL
message.h
1 
9 #ifndef _GXPL_MESSAGE_HEADER_
10 #define _GXPL_MESSAGE_HEADER_
11 
12 #include <gxPL/defs.h>
13 
14 __BEGIN_C_DECLS
15 /* ========================================================================== */
16 
24 /* internal public functions ================================================ */
25 
36 gxPLMessage * gxPLMessageNew (gxPLMessageType type);
37 
43 void gxPLMessageDelete (gxPLMessage * message);
44 
52 char * gxPLMessageToString (const gxPLMessage * message);
53 
69 gxPLMessage * gxPLMessageFromString (gxPLMessage * message, char * line);
70 
77 int gxPLMessageFilterMatch (const gxPLMessage * message, const gxPLFilter * filter);
78 
84 gxPLMessageType gxPLMessageTypeGet (const gxPLMessage * message);
85 
92 int gxPLMessageTypeSet (gxPLMessage * message, gxPLMessageType type);
93 
99 const char * gxPLMessageTypeToString (gxPLMessageType type);
100 
107 gxPLMessageType gxPLMessageTypeFromString (const char * str);
108 
114 int gxPLMessageHopGet (const gxPLMessage * message);
115 
122 int gxPLMessageHopSet (gxPLMessage * message, int hop);
123 
129 int gxPLMessageHopInc (gxPLMessage * message);
130 
136 const gxPLId * gxPLMessageSourceIdGet (const gxPLMessage * message);
137 
143 const char * gxPLMessageSourceVendorIdGet (const gxPLMessage * message);
144 
150 const char * gxPLMessageSourceDeviceIdGet (const gxPLMessage * message);
151 
157 const char * gxPLMessageSourceInstanceIdGet (const gxPLMessage * message);
158 
165 int gxPLMessageSourceIdSet (gxPLMessage * message, const gxPLId * id);
166 
175 int gxPLMessageSourceSet (gxPLMessage * message, const char * vendor_id,
176  const char * device_id, const char * instance_id);
177 
184 int gxPLMessageSourceVendorIdSet (gxPLMessage * message, const char * vendor_id);
185 
192 int gxPLMessageSourceDeviceIdSet (gxPLMessage * message, const char * device_id);
193 
200 int gxPLMessageSourceInstanceIdSet (gxPLMessage * message, const char * instance_id);
201 
207 const gxPLId * gxPLMessageTargetIdGet (const gxPLMessage * message);
208 
214 const char * gxPLMessageTargetVendorIdGet (const gxPLMessage * message);
215 
221 const char * gxPLMessageTargetDeviceIdGet (const gxPLMessage * message);
222 
228 const char * gxPLMessageTargetInstanceIdGet (const gxPLMessage * message);
229 
236 int gxPLMessageTargetIdSet (gxPLMessage * message, const gxPLId * id);
237 
246 int gxPLMessageTargetSet (gxPLMessage * message, const char * vendor_id,
247  const char * device_id, const char * instance_id);
248 
255 int gxPLMessageTargetVendorIdSet (gxPLMessage * message, const char * vendor_id);
256 
263 int gxPLMessageTargetDeviceIdSet (gxPLMessage * message, const char * device_id);
264 
271 int gxPLMessageTargetInstanceIdSet (gxPLMessage * message, const char * instance_id);
272 
278 const gxPLSchema * gxPLMessageSchemaGet (const gxPLMessage * message);
279 
285 const char * gxPLMessageSchemaClassGet (const gxPLMessage * message);
286 
292 const char * gxPLMessageSchemaTypeGet (const gxPLMessage * message);
293 
300 int gxPLMessageSchemaCopy (gxPLMessage * message, const gxPLSchema * schema);
301 
309 int gxPLMessageSchemaSet (gxPLMessage * message,
310  const char * schema_class, const char * schema_type);
311 
318 int gxPLMessageSchemaClassSet (gxPLMessage * message, const char * schema_class);
319 
326 int gxPLMessageSchemaTypeSet (gxPLMessage * message, const char * schema_type);
327 
334 const xVector * gxPLMessageBodyGetConst (const gxPLMessage * message);
335 
347 xVector * gxPLMessageBodyGet (gxPLMessage * message);
348 
354 int gxPLMessageBodySize (const gxPLMessage * message);
355 
361 int gxPLMessageBodyClear (gxPLMessage * message);
362 
369 const char * gxPLMessagePairGet (const gxPLMessage * message, const char * name);
370 
377 int gxPLMessagePairExist (const gxPLMessage * message, const char * name);
378 
386 int gxPLMessagePairAdd (gxPLMessage * message, const char * name, const char * value);
387 
395 int gxPLMessagePairSet (gxPLMessage * message, const char * name, const char * value);
396 
404 int gxPLMessagePairAddFormat (gxPLMessage * message, const char * name, const char * format, ...);
405 
413 int gxPLMessagePairSetFormat (gxPLMessage * message, const char * name, const char * format, ...);
414 
420 int gxPLMessagePairValuesSet (gxPLMessage * message, ...);
421 
427 int gxPLMessageIsValid (const gxPLMessage * message);
428 
434 int gxPLMessageIsError (const gxPLMessage * message);
435 
441 gxPLMessageState gxPLMessageStateGet (const gxPLMessage * message);
442 
448 int gxPLMessageFlagClear (gxPLMessage * message);
449 
455 int gxPLMessageIsReceived (const gxPLMessage * message);
456 
463 int gxPLMessageReceivedSet (gxPLMessage * message, bool isReceived);
464 
470 int gxPLMessageIsBroadcast (const gxPLMessage * message);
471 
478 int gxPLMessageGroupedSet (gxPLMessage * message, bool isGrouped);
479 
485 int gxPLMessageIsGrouped (const gxPLMessage * message);
486 
492 int gxPLMessageIsBroadcast (const gxPLMessage * message);
493 
500 int gxPLMessageBroadcastSet (gxPLMessage * message, bool isBroadcast);
501 
506 /* ========================================================================== */
507 __END_C_DECLS
508 #endif /* _GXPL_MESSAGE_HEADER_ defined */
int gxPLMessageSourceVendorIdSet(gxPLMessage *message, const char *vendor_id)
Sets source vendor identifier.
const char * gxPLMessageTargetDeviceIdGet(const gxPLMessage *message)
Target device identifier.
gxPLMessageType gxPLMessageTypeGet(const gxPLMessage *message)
Gets message type.
int gxPLMessageSourceIdSet(gxPLMessage *message, const gxPLId *id)
Sets source identifier.
int gxPLMessageTypeSet(gxPLMessage *message, gxPLMessageType type)
Sets message type.
int gxPLMessageIsError(const gxPLMessage *message)
Check if a message is in error.
const char * gxPLMessageTargetInstanceIdGet(const gxPLMessage *message)
Target instance identifier.
gxPLMessageType gxPLMessageTypeFromString(const char *str)
message type from a string
const char * gxPLMessageSourceInstanceIdGet(const gxPLMessage *message)
Source instance identifier.
int gxPLMessageGroupedSet(gxPLMessage *message, bool isGrouped)
Sets if a message is grouped.
const xVector * gxPLMessageBodyGetConst(const gxPLMessage *message)
Returns body of message as a const vector of gxPLPair.
int gxPLMessagePairAddFormat(gxPLMessage *message, const char *name, const char *format,...)
Produce value according to a format.
xVector * gxPLMessageBodyGet(gxPLMessage *message)
Returns body of message as a vector of gxPLPair.
const char * gxPLMessagePairGet(const gxPLMessage *message, const char *name)
Gets the value of a name/value pair.
int gxPLMessageSchemaClassSet(gxPLMessage *message, const char *schema_class)
Sets the schema class.
gxPLMessageType
Possible xPL message types.
Definition: defs.h:136
int gxPLMessageSchemaSet(gxPLMessage *message, const char *schema_class, const char *schema_type)
Sets the schema.
Describe a source or destination xPL identifier.
Definition: defs.h:279
int gxPLMessageSourceSet(gxPLMessage *message, const char *vendor_id, const char *device_id, const char *instance_id)
Sets source identifier.
const char * gxPLMessageTypeToString(gxPLMessageType type)
string from a message type
int gxPLMessageTargetVendorIdSet(gxPLMessage *message, const char *vendor_id)
Sets target vendor identifier.
int gxPLMessageFilterMatch(const gxPLMessage *message, const gxPLFilter *filter)
Check if the passed message matches the passed filter.
const char * gxPLMessageSchemaClassGet(const gxPLMessage *message)
Gets the schema class.
int gxPLMessageBodyClear(gxPLMessage *message)
Clear, release a body and all it&#39;s resources.
const gxPLId * gxPLMessageTargetIdGet(const gxPLMessage *message)
Target identifier.
gxPLMessageState gxPLMessageStateGet(const gxPLMessage *message)
gets the decoding state
int gxPLMessageSourceDeviceIdSet(gxPLMessage *message, const char *device_id)
Sets source device identifier.
int gxPLMessageSchemaCopy(gxPLMessage *message, const gxPLSchema *schema)
Sets the schema.
int gxPLMessageSchemaTypeSet(gxPLMessage *message, const char *schema_type)
Sets the schema type.
int gxPLMessageBodySize(const gxPLMessage *message)
Number of pairs of the body.
int gxPLMessageTargetInstanceIdSet(gxPLMessage *message, const char *instance_id)
Sets target instance identifier.
int gxPLMessageIsReceived(const gxPLMessage *message)
Check if a message is received.
const gxPLId * gxPLMessageSourceIdGet(const gxPLMessage *message)
Source identifier.
void gxPLMessageDelete(gxPLMessage *message)
Release a message and all it&#39;s resources.
int gxPLMessageBroadcastSet(gxPLMessage *message, bool isBroadcast)
Sets if a message is broadcast.
int gxPLMessageFlagClear(gxPLMessage *message)
Clear all flags.
int gxPLMessageReceivedSet(gxPLMessage *message, bool isReceived)
Sets if a message is received.
int gxPLMessagePairSet(gxPLMessage *message, const char *name, const char *value)
Sets the value of a name/value pair.
int gxPLMessageSourceInstanceIdSet(gxPLMessage *message, const char *instance_id)
Sets source instance identifier.
const char * gxPLMessageSchemaTypeGet(const gxPLMessage *message)
Gets the schema type.
int gxPLMessageTargetIdSet(gxPLMessage *message, const gxPLId *id)
Sets target identifier.
int gxPLMessageHopSet(gxPLMessage *message, int hop)
Sets hop count.
int gxPLMessagePairAdd(gxPLMessage *message, const char *name, const char *value)
Adds a pair to the body.
Describe a xPL schema.
Definition: defs.h:288
int gxPLMessageTargetDeviceIdSet(gxPLMessage *message, const char *device_id)
Sets target device identifier.
const char * gxPLMessageSourceDeviceIdGet(const gxPLMessage *message)
Source device identifier.
int gxPLMessagePairValuesSet(gxPLMessage *message,...)
Set a series of NameValue pairs for a message.
Describe a xPL filter.
Definition: defs.h:296
const char * gxPLMessageTargetVendorIdGet(const gxPLMessage *message)
Target vendor identifier.
char * gxPLMessageToString(const gxPLMessage *message)
Returns xPL message as text.
int gxPLMessageTargetSet(gxPLMessage *message, const char *vendor_id, const char *device_id, const char *instance_id)
Sets target identifier.
int gxPLMessageIsGrouped(const gxPLMessage *message)
Check if a message is for a group.
const gxPLSchema * gxPLMessageSchemaGet(const gxPLMessage *message)
Gets the schema.
const char * gxPLMessageSourceVendorIdGet(const gxPLMessage *message)
Source vendor identifier.
gxPLMessageState
Decoding states of a message.
Definition: defs.h:176
int gxPLMessageHopInc(gxPLMessage *message)
Increments hop count.
gxPLMessage * gxPLMessageFromString(gxPLMessage *message, char *line)
Parse a list of lines as text to extract a message.
gxPLMessage * gxPLMessageNew(gxPLMessageType type)
Create a new empty message.
int gxPLMessageIsBroadcast(const gxPLMessage *message)
Check if a message is broadcast.
int gxPLMessageIsValid(const gxPLMessage *message)
Check if a message is valid.
int gxPLMessagePairExist(const gxPLMessage *message, const char *name)
Check if a pair exist.
int gxPLMessageHopGet(const gxPLMessage *message)
Gets hop count.
int gxPLMessagePairSetFormat(gxPLMessage *message, const char *name, const char *format,...)
Sets the value according to a format.