Command:              CMD_SERVER_SET_TIMED_XMIT
Destination:          SD_SERVER
Destination Channel:  Channel ID

Description

This command is used by clients to enable or disable timed message transmission and transmission complete events.

By default all transmitted messages (frame type of FT_DATA) are sent to their specified channels immediately. This command changes the way FT_DATA messages are handled.

If timing is enabled, the time element in the Data Header is examined. If it is zero, the message is sent to its channel immediately as usual. If it is non-zero, the message is placed in a delay queue (list) for the client using the amount of time specified (in tens of microseconds). If no other messages are present for the client, the message will be sent after the delay time has expired. If one or more messages are present in the client's list, the message is placed at the end of the list and the specified delay time will occur between the last message in the list and this one.

If the delay time is set to EVENT_ON_SEND (0xFFFFFFFF) or EVENT_ON_SEND_PROXY (0xFFFFFFFE), the message is sent immediately. If the driver for the channel is able, it will send an EVENT_MSG_SENT event message back to the client that sent the message after the message has been sent. (Only one client is sent a given EVENT_MSG_SENT event.) If EVENT_ON_SEND is used for the time, the destination channel of the resulting event message is the same as the source channel of the data message. (The event message is sent to the same channel from which the data message came.) If EVENT_ON_SEND_PROXY is used for the time, the destination channel of the resulting event message is the content of the reserved short element in the data header of the data message. (The event message is sent to a different channel from which the data message came.) If multiple messages are already queued to the driver, the message will be placed at the end of the queue and the EVENT_MSG_SENT event will be sent when the driver places the message on the bus. If a driver is able to send an EVENT_MSG_SENT event, its documentation web page will state that it is able to do so.

For more information see using the Delay Driver and the individual driver pages.

Command data format

Timed mode : 1 byte.
        Timed mode = 0: Timing of messages and sending of EVENT_MSG_SENT events are disabled (default).
        Timed mode = 1: Timing of messages and sending of EVENT_MSG_SENT events are enabled.

Response data format

None (no response data).

Response return codes

RESP_OK	Execution of the command was successful.
RESP_UNKNOWN	An unknown error occurred.