At^sisr Internet Service Read Data - Multi-Tech MultiModem EDGE Reference Manual

10.7 AT^SISR Internet Service Read Data

Description:
Test Command Syntax:
Response:
Write Command Syntax:
Response:
Unsolicited Result Code:
Parameter Descriptions:
<srvProfileId>
<srvProfileId> 0 ... 9 specified with AT^SISS.
<reqReadLength>
0 Peek Operator: Query number of received bytes within internal buffers.
The behavior of the peek operator depends on the selected Internet service, i.e. it may not be
supported by all IP Services.
For "Socket" service configured for UDP the size of the next available UDP packet is returned.
1...1500 Requested number of data bytes to be read via the Internet service configured in <srvProfileId>.
<cnfReadLength>
-2 Indicates end of data. Data transfer has been finished (all data have been read) and the service can
be closed with AT^SISC.
-1 Applies only to HTTP: Querying number of available bytes is not supported by the HTTP service.
0 Indicates that no further data is available at the moment.
>0 Number of available data bytes. The range is determined by <reqReadLength>:
If <reqReadLength> was greater than 0, then <cnfReadLength> may be less or equal to the value
requested with <reqReadLength>.
If <reqReadLength> equals 0 (peek operator) the value indicated by <cnfReadLength> may be
greater than 1500.
<urcCauseId>
Indicates whether or not data is available for reading with AT^SISR.
1 Data is available and can be read by sending the AT^SISR command. The URC appears when less
data was confirmed (in <cnfReadLength>) than requested (with <reqReadLength>) during the last
"Read Data" operation and new data is available.
2 End of data. Data transfer has completed (all data read). The service can be closed with AT^SISC.
<remainUdpPacketLength>
Optional third parameter of the AT^SISR write command response displayed only if the Socket service uses the
UDP protocol.
The reception of each datagram must be completed before the next datagram can be received. This may be a
problem if the buffer of the host application is limited and not designed to handle the maximum packet size of
1500 bytes. To compensate this, the host is advised to request, via <reqReadLength>, an amount less or equal
its maximum buffer capacity and wait for the resulting AT^SISR write command response with parameter
<remainUdpPacketLength>. The benefit of this approach is that the host may properly receive all parts of a UDP
datagram, as after each received data part the number of remaining bytes is synchronized, until reading the
datagram is finished.
If the currently read datagram is smaller than the number of bytes requested by the host, the
<remainUdpPacketLength> parameter is omitted.
Multi-Tech Systems, Inc. AT Commands for EDGE Modems (S000371G)
The AT^SISR command either triggers a read operation (download) or queries the
number of bytes in the internal buffer.
The AT^SISR write command may return the following errors:
•
"+CME ERROR: operation failed" if there is a problem on application, socket, PPP
or GPRS/GSM level. The
additional error information.
•
"+CME ERROR: operation temporary not allowed" e.g. if the service has not
network resources allocated.
•
"+CME ERROR: operation not allowed" e.g. if the service is not configured.
AT^SISR=?
OK
AT^SISR=<srvProfileId>, <reqReadLength>
SISR: <srvProfileId>, <cnfReadLength>[, <remainUdpPacketLength>[,
^
<optServParm>]]
Number of data bytes are sent as specified by <cnfReadLength>. If peek operator was
used no data bytes are sent.
^SISR: <srvProfileId>, <urcCauseId>
Data availability status of the Internet service configured with AT^SISS has changed.
The URC is issued when:
• Data is available after opening an Internet service or
•
less data was confirmed (in <cnfReadLength>) than requested (with
<reqReadLength>) during the last "Read Data" operation and new data is
available.
The URC is disabled in polling mode. See AT^SCFG, parameter "Tcp/WithURCs",
<tcpWithUrc>.
Chapter 10 – Internet Service Commands
AT^SISE command and the "^SIS" URC offer
150