2.2.3.88.1 HeartbeatInterval (Ping)
The HeartbeatInterval element is a child element of the Ping element in Ping command requests and responses. In Ping command requests, it specifies the length of time, in seconds, that the server SHOULD wait before sending a response if no new items are added to the specified set of folders, as specified in section 3.1.5.8. The HeartbeatInterval element is also returned by the server with a status code of 5 and specifies either the minimum or maximum interval that is allowed when the client has requested a heartbeat interval that is outside the acceptable range.
All elements referenced in this section are defined in the Ping namespace.
|
Command request/response |
Parent elements |
Child elements |
Data type |
Number allowed |
|---|---|---|---|---|
|
Ping command request (section 2.2.1.13) |
Ping (section 2.2.3.136) |
None |
integer ([MS-ASDTYPE] section 2.6) |
1 (required in first request only) |
|
Ping command response |
Ping |
None |
integer |
0...1 (optional) |
Valid values for the HeartbeatInterval element are implementation-specific.<6>
The HeartbeatInterval element is required only in the first Ping command request from a device by a given user. The server then caches the heartbeat interval value so that in later requests the HeartbeatInterval element is necessary only if the client is changing the interval.
Protocol Versions
The following table specifies the protocol versions that support this element. The client indicates the protocol version being used by setting either the MS-ASProtocolVersion header, as specified in [MS-ASHTTP] section 2.2.1.1.2.6, or the Protocol version field, as specified in [MS-ASHTTP] section 2.2.1.1.1.1, in the request.
|
Protocol version |
Element support |
|---|---|
|
2.5 |
Yes |
|
12.0 |
Yes |
|
12.1 |
Yes |
|
14.0 |
Yes |
|
14.1 |
Yes |
|
16.0 |
Yes |
|
16.1 |
Yes |