9 #ifndef _GXPL_MESSAGE_HEADER_ 10 #define _GXPL_MESSAGE_HEADER_ 12 #include <gxPL/defs.h> 176 const char * device_id,
const char * instance_id);
247 const char * device_id,
const char * instance_id);
310 const char * schema_class,
const char * schema_type);
386 int gxPLMessagePairAdd (gxPLMessage * message,
const char * name,
const char * value);
395 int gxPLMessagePairSet (gxPLMessage * message,
const char * name,
const char * value);
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.
int gxPLMessageSchemaSet(gxPLMessage *message, const char *schema_class, const char *schema_type)
Sets the schema.
Describe a source or destination xPL identifier.
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'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'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.
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.
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.
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.