Read message from dipc queue

URL

/rw/dipc/{queue-name}

Method

GET

URL Params

action=dipc-read Required

timeout={timeout in ms} (default 0) Optional

See Common URL parameters

Data Params

None

Success Response

HTTP_OK (200)

see HTTP Status codes

Example Response

         <?xml version="1.0" encoding="utf-8"?>
          <html xmlns="http://www.w3.org/1999/xhtml">
            <head>
                <title>RobAPI2 DIPC</title>
                <base href= "http://localhost/rw/dipc/" />
            </head>
            <body>
                <div class="state">
                    <a href= "testq?action=dipc-read" rel="action"/>
                    <ul>
                        <li class="dipc-read-li" title="testq">
                            <span class="queue-name">testq</span>
                            <span class="queue-size">4</span>
                            <span class="queue-sid">186</span>
                            <span class="queue-did">186</span>
                            <span class="dipc-msgtype">IPC_PACKAGE</span>
                            <span class="dipc-cmd">111</span>                               
                            <span class="dipc-userdef">222</span>
                            <span class="dipc-data">hello</span>
                        </li>
                    </ul>
                </div>
            </body>
        </html>

Resources

dipc-read-li
- queue-name The queue name to create
- queue-size The queue size
- queue-sid The slot id of the current queue
- queue-did The slot id of the queue that write the data
- dipc-msgtype Message type. Can be either IPC_PACKAGE|IPC_SEND (1 or 0 in DIPC Send)
- dipc-cmd The dipc command
- dipc-userdef Userdef
- dipc-data The queue data

Error Response

BAD_REQUEST (400)

See Robot controller return codes

Sample Call

curl --digest -u "Default User":robotics "http://localhost/rw/dipc/testq?action=dipc-read"

Notes

Not supported in bootserver mode.