The following may be used to deal with the queue contents: “Obj” Class of verbs Verb Usage queue HL_mq_close() Mandatory. write in queue HL_mq_put() Mandatory (see also VIII.2.14 however). read from queue HL_mq_browse Mandatory delete from queue HL_mq_delete Mandatory. A message must have been successfully read and processed before deleting. 28: CSI verbs for queue access It is the responsibility of the application to organise the reading from a receiving queue in order to avoid loss of messages. Putting a message into a queue: HL_mq_put() CSILONG HL_mq_put( CSIMQHCONN Conn, CSIMQHOBJ ObjDesc, CSIMQMD *MsgDesc, CSIMQPMO *PutMsgOpts, CSIDD *DataIn, CSIQOS *QoS, CSILONG *ReturnCode, CSILONG *ReasonCode ); Value of argument is identical to the one obtained from HL_mq_conn(). “Conn” Value of argument is identical to the one obtained from HL_mq_open(). “Obj” Argument points to a CSIMQMD structure that was prepared as explained in “MsgDesc” paragraph VIII.2.1. The values present in this structure a successful call of the HL_mq_put() are not to be considered. Argument points to a CSIDD structure that was prepared as explained in paragraph “DataIn” VIII.2.2. Argument points to a CSIQOS structure that was prepared as explained in section “QoS” VIII.2.6. Argument is to be initialised with the statements: “PutMsgOpts” Define a static variable of type CSIMQPMO initialised with constant s_DefMQPMO values: CSIMQPMO s_DefMQPMO = {CSIMQPMO_DEFAULT}; Each time the HL_mq_put() verb will be used, define and initialise dynamically a variable of type CSIMQPMO by using the static variable : s_MQPMO s_DefMQPMO
The following may be used to deal with the “Obj” queue contents: Class of verbs Verb Usage queue HL_mq_close() Mandatory. write in queue HL_mq_put() Mandatory (see also VIII.2.14 however). read from queue HL_mq_browse Mandatory delete from queue HL_mq_delete Mandatory. A message must have been successfully read and processed before deleting. 28: CSI verbs for queue access It is the responsibility of the application to organise the reading from a receiving queue in order to avoid loss of messages. Putting a message into a queue: HL_mq_put() CSILONG HL_mq_put( CSIMQHCONN Conn, CSIMQHOBJ ObjDesc, CSIMQMD *MsgDesc, CSIMQPMO *PutMsgOpts, CSIDD *DataIn, CSIQOS *QoS, CSILONG *ReturnCode, CSILONG *ReasonCode ); Value of argument “Conn” is identical to the one obtained from HL_mq_conn(). Value of argument “Obj” is identical to the one obtained from HL_mq_open(). Argument “MsgDesc” points to a CSIMQMD structure that was prepared as explained in paragraph VIII.2.1. The values present in this structure a successful call of the HL_mq_put() are not to be considered. Argument “DataIn” points to a CSIDD structure that was prepared as explained in paragraph VIII.2.2. Argument “QoS” points to a CSIQOS structure that was prepared as explained in section VIII.2.6. Argument “PutMsgOpts” is to be initialised with the statements: Define a static variable s_DefMQPMO of type CSIMQPMO initialised with constant values: CSIMQPMO s_DefMQPMO = {CSIMQPMO_DEFAULT}; Each time the HL_mq_put() verb will be used, define and initialise dynamically a variable s_MQPMO of type CSIMQPMO by using the static variable s_DefMQPMO :
Design_Document_for_Common_Operations_and_Methods_DDCOM_v_1410.docx