2.2.1.13 Ping

The Ping command is used to request that the server monitor specified folders for changes that would require the client to resynchronize.

The body of the request contains a list of folders on the server about which the client is requesting notifications and an interval of time that specifies how long the server SHOULD wait before responding if no new items are added to the specified folders. If the Ping element (section 2.2.3.136) is specified in an XML request body, either the HeartbeatInterval element or the Folders element (section 2.2.3.75.2), or both elements MUST be specified.

The Ping namespace is the primary namespace for this section. Elements referenced in this section that are not defined in the Ping namespace use the namespace prefixes defined in section 2.2.4.

The following table lists the elements that are used in Ping command requests and responses.

Element name

Scope

Reference

Ping

Request and Response

section 2.2.3.136

HeartbeatInterval

Request and Response

section 2.2.3.88.1

Folders

Request and Response

section 2.2.3.75.2

Folder

Request and Response

section 2.2.3.71.2

Id

Request

section 2.2.3.90

Class

Request

section 2.2.3.27.4

Status

Response

section 2.2.3.177.11

MaxFolders

Response

section 2.2.3.102

The XML schema for the Ping command request is described in section 6.29. A Ping command can be sent with no body, in which case the cached version is used. The XML schema is applied only to requests that have a body. The XML schema for the Ping command response is described in section 6.30.

Protocol Versions

The following table specifies the protocol versions that support this command. 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

Command support

2.5

Yes

12.0

Yes

12.1

Yes

14.0

Yes

14.1

Yes

16.0

Yes

16.1

Yes

Show: