2.2.5 Remote Event Format

The Remote Event format is used in the message body of the SendEvent request (section 2.2.2.9).

The syntax of the Remote Event format is defined by using ABNF as follows.

 EncodingFormat   = 1
 EncodingVersion      = 1
 EventType    = ( 28 / 29 / 30 )
 EventReason   = 1*10DIGIT
            
 remote-event-message = EncodingFormat CRLF
      EncodingVersion ","
      EventType ","
      EventReason CRLF
      [ 2(content-description) ]  ; section 2.2.4
            

The value of the EventType parameter MUST be set to one of the following three values: 28 to specify the remote-open event, 29 to specify the remote-close event, or 30 to specify the remote-log event.

The remote-open event is fired by a caching proxy server when it opens a content item from its cache. The remote-close event is fired by a caching proxy server when it closes a content item from its cache.

The remote-log event is fired by a client to indicate that the client is sending statistics to the server. Remote-logs are typically sent independent from streaming statistics.<59>

The value of the EventReason parameter MUST be an integer in the range from 0 through 4,294,967,295. It MUST be treated as an HRESULT code, as specified in [MS-ERREF].

The two content-description parameters MUST be present if the value EventType parameter is 30 (that is, for remote-log events) and MUST NOT be present otherwise.

The first content description MUST contain at least the following fields.

<name>	<value-type tag>	<value>
context-type	VT_I4	2
WMS_USER_AGENT	VT_LPWSTR	A string adhering to the syntax for client-token, or similar, as specified in User-Agent (section 2.2.1.8) header.
WMS_USER_GUID	VT_LPWSTR	A string adhering to the syntax for GUID value, as specified in xClientGUID (section 2.2.1.4.33) token.

The second content description MUST contain at least the following fields:

<name>	<value-type tag>	<value>
context-type	VT_I4	5
@WMS_COMMAND_CONTEXT_URL	VT_LPWSTR	A string adhering to the syntax for httpurl, as specified in [RFC1738].
@.REMOTE_LOG	VT_LPWSTR	A "rendering" log in XML format, as specified in [MS-WMLOG]

For more information about the syntax for content-description, see section 2.2.4.