Q parser

Collaboration diagram for Q parser:

Data Structures
struct	Q_packet_s
	Q packet structure object. More...

Macros
#define	Q_PACKETID_BYTELENGTH   6
#define	Q_OPCODE_BYTELENGTH   1
#define	Q_REQUESTID_BYTELENGTH   2
#define	Q_NODETYPE_BYTELENGTH   1
#define	Q_NODEID_BYTELENGTH   1
#define	Q_HEADER_BYTELENGTH   Q_PACKETID_BYTELENGTH + Q_OPCODE_BYTELENGTH
#define	Q_DISCOVERREPLY_BYTELENGTH   Q_HEADER_BYTELENGTH + Q_NODETYPE_BYTELENGTH + Q_NODEID_BYTELENGTH
#define	Q_POLLREPLY_BYTELENGTH   Q_DISCOVERREPLY_BYTELENGTH
#define	Q_OPCODE_INDEX   Q_PACKETID_BYTELENGTH
#define	Q_PAYLOAD_INDEX   Q_OPCODE_INDEX
#define	Q_PACKETID_STRING   "ASLS-Q"

Enumerations
enum	Q_packet_opcode_cmd_e {   Q_CMD_TRIGGER_START ,   Q_CMD_TRIGGER_PAUSE ,   Q_CMD_TRIGGER_RESUME ,   Q_CMD_TRIGGER_STOP ,   Q_CMD_CONTROL_ALLOFF ,   Q_CMD_CONTROL_RESTORE ,   Q_CMD_CONTROL_ACTUATOR ,   Q_CMD_PROBE_DISCOVER ,   Q_CMD_PROBE_POLL ,   Q_CMD_PROBE_DIAGNOSTIC ,   Q_CMD_REPLY_DISCOVER ,   Q_CMD_REPLY_POLL ,   Q_CMD_REPLY_DIAGNOSTIC }
	List of Q packet opcodes. More...

Functions
Q_packet_s *	Q_parser_parse (void *data, uint8_t len)
	parses and converts received data into a Q_packet instance More...
char *	Q_parser_forge_discover_reply (uint8_t node_id)
	Forges a discover reply packet using provided node's id. More...
char *	Q_parser_forge_poll_reply (uint8_t node_id)
	Forges a poll reply packet using provided node's id. More...
void	Q_parser_free (Q_packet_s *packet)
	Frees packet's dynamically allocated ressources. More...

Detailed Description

Parses "Q" formated UDP packets. Q packets are simply made of a single OPCODE byte and a variable length data payload conveying cue-specific information.

Macro Definition Documentation

Q_DISCOVERREPLY_BYTELENGTH

#define Q_DISCOVERREPLY_BYTELENGTH   Q_HEADER_BYTELENGTH + Q_NODETYPE_BYTELENGTH + Q_NODEID_BYTELENGTH

Q "discover" reply packet length in bytes

Definition at line 22 of file Q_parser.h.

Q_HEADER_BYTELENGTH

#define Q_HEADER_BYTELENGTH   Q_PACKETID_BYTELENGTH + Q_OPCODE_BYTELENGTH

Q packet header length in bytes

Definition at line 21 of file Q_parser.h.

Q_NODEID_BYTELENGTH

#define Q_NODEID_BYTELENGTH   1

Q packet "node id" field length in bytes

Definition at line 19 of file Q_parser.h.

Q_NODETYPE_BYTELENGTH

#define Q_NODETYPE_BYTELENGTH   1

Q packet "node type" field length in bytes

Definition at line 18 of file Q_parser.h.

Q_OPCODE_BYTELENGTH

#define Q_OPCODE_BYTELENGTH   1

Q packet "opcode" field length in bytes

Definition at line 16 of file Q_parser.h.

Q_OPCODE_INDEX

#define Q_OPCODE_INDEX   Q_PACKETID_BYTELENGTH

Q packet "opcode" byte index

Definition at line 25 of file Q_parser.h.

Q_PACKETID_BYTELENGTH

#define Q_PACKETID_BYTELENGTH   6

Q packet "packet id" field length in bytes

Definition at line 15 of file Q_parser.h.

Q_PACKETID_STRING

#define Q_PACKETID_STRING   "ASLS-Q"

Q packet "packeid" string value

Definition at line 28 of file Q_parser.h.

Q_PAYLOAD_INDEX

#define Q_PAYLOAD_INDEX   Q_OPCODE_INDEX

Q packet "payload" index

Definition at line 26 of file Q_parser.h.

Q_POLLREPLY_BYTELENGTH

#define Q_POLLREPLY_BYTELENGTH   Q_DISCOVERREPLY_BYTELENGTH

Q "poll" reply packet length in bytes

Definition at line 23 of file Q_parser.h.

Q_REQUESTID_BYTELENGTH

#define Q_REQUESTID_BYTELENGTH   2

Q packet "request id" field length in bytes

Definition at line 17 of file Q_parser.h.

Enumeration Type Documentation

Q_packet_opcode_cmd_e

enum Q_packet_opcode_cmd_e

List of Q packet opcodes.

Enumerator
Q_CMD_TRIGGER_START	Starts a cue
Q_CMD_TRIGGER_PAUSE	Pauses a cue
Q_CMD_TRIGGER_RESUME	Resumes a paused cue
Q_CMD_TRIGGER_STOP	Stops a started cue
Q_CMD_CONTROL_ALLOFF	Sets all outputs to OFF state
Q_CMD_CONTROL_RESTORE	Restores all outputs to their state prior to ALLOFF
Q_CMD_CONTROL_ACTUATOR	Controls an individual actuator channe value
Q_CMD_PROBE_DISCOVER	Discover all nodes on the network
Q_CMD_PROBE_POLL	Poll a specific probe
Q_CMD_PROBE_DIAGNOSTIC	Diagnostic a specific node
Q_CMD_REPLY_DISCOVER	Reply to a discover command
Q_CMD_REPLY_POLL	Reply to a poll command
Q_CMD_REPLY_DIAGNOSTIC	Reply to a diagnostic command

Definition at line 35 of file Q_parser.h.

Function Documentation

Q_parser_forge_discover_reply()

char * Q_parser_forge_discover_reply

(

uint8_t

node_id

)

Forges a discover reply packet using provided node's id.

Parameters

node_id

node identifier

Returns

char* pointer to raw data buffer to be sent

Definition at line 87 of file Q_parser.c.

Q_parser_forge_poll_reply()

char * Q_parser_forge_poll_reply

(

uint8_t

node_id

)

Forges a poll reply packet using provided node's id.

Parameters

node_id

node identifier

Returns

char* pointer to raw data buffer to be sent

Definition at line 99 of file Q_parser.c.

Q_parser_free()

void Q_parser_free

(

Q_packet_s *

packet

)

Frees packet's dynamically allocated ressources.

Parameters

*packet

pointer to packet instance to be freed

Definition at line 73 of file Q_parser.c.

Q_parser_parse()

Q_packet_s * Q_parser_parse	(	void *	data,
		uint8_t	len
	)

parses and converts received data into a Q_packet instance

Parameters

*data	pointer to data buffer
len	length of the data contained within the buffer in bytes

Returns

Q_packet_s* pointer to the created Q packet instance, NULL on fail

Definition at line 46 of file Q_parser.c.