Command:              CMD_SCHED_MSG_REPLACE
Destination:          SD_SCHED
Destination Channel:  n/a

Description

Clients use this command to replace a data message currently being transmitted by under control of the Scheduler.

Command data format

Schedule ID	Index	Flags	Value	Data Frame Header	Header	Data	Extra Data
4 bytes (unsigned long)	1 byte	1 byte	2 bytes	16 bytes	variable

Schedule ID

The Schedule ID returned by the CMD_SCHED_TX command used to create the schedule to be modified.

Index

The index of the Message List element that contains the message to be modified. The first Message List element (which contains the first message of those scheduled) has an Index value of 0.

Flags

Bit 0:

Set = Flush messages in the delay queue keeping only those that delay times within the time in milliseconds present in the next field.
 
Reset = Keep all current messages in the Delay queue.

Value

The maximum amount of time in milliseconds that the previously scheduled message(s) will be output.

Data Frame Header

The Data Frame Header field (bytes 8 through 23) of a Data Frame

Header

The message header bytes. The length of this field is dependent on the number of header bytes specified in the Data Header.

Data

The message data bytes. The length of this field is dependent on the number of data bytes specified in the Data Header.

Extra Data

The message extra data bytes. The length of this field is dependent on the number of extra data bytes specified in the Data Header.

Response data format

none

Response return codes

RESP_OK	Execution of the command was successful. (The response data will have a 4-byte Transmit Schedule ID.)
RESP_INVAL_CHAN	The specified channel is invalid.
RESP_UNSUPPORTED	This command is not supported on the specified channel.
RESP_INVAL_MSG	The specified message(s) is not a legal message for this protocol.
RESP_INVAL_LEN	The specified data size is not legal.
RESP_UNREG	The specified source channel is not registered with the server.
RESP_UNKNOWN_ERR	An unknown error occurred.