2.2.2.2 AUX_HEADER Structure

Article
10/13/2020

The AUX_HEADER structure provides information about the auxiliary block structures that follow it.

0	1	2	3	4	5	6	7	8	9	1 0	1	2	3	4	5	6	7	8	9	2 0	1	2	3	4	5	6	7	8	9	3 0	1
Size																Version								Type

Size (2 bytes): The size of the AUX_HEADER structure plus any additional payload data that follows.

Version (1 byte): The version information of the payload data that follows the AUX_HEADER structure. This value in conjunction with the Type field determines which structure to use to interpret the data that follows the header.

Version	Value
AUX_VERSION_1	0x01
AUX_VERSION_2	0x02

Type (1 byte): The type of auxiliary block data structure that follows the AUX_HEADER structure. The value of the Type field in conjunction with the Version field determines which auxiliary block structure to use to interpret the data that follows the AUX_HEADER structure. Several of the types distinguish among the client's foreground request (FG), the client's background request (BG), and the client's global catalog request (GC). A foreground request is a request where the client is waiting for a response from the server before continuing. A background request is a request where the client is operating in cached mode versus online. A global catalog request is a client request sent to the mailbox directory.

The block type names, associated Type field values, and the corresponding auxiliary block structure that follows the AUX_HEADER structure when the Version field is AUX_VERSION_1 are listed in the following table.

Type name	Value	Auxiliary block structure
AUX_TYPE_PERF_REQUESTID	0x01	AUX_PERF_REQUESTID (section 2.2.2.2.1)
AUX_TYPE_PERF_CLIENTINFO	0x02	AUX_PERF_CLIENTINFO (section 2.2.2.2.4)
AUX_TYPE_PERF_SERVERINFO	0x03	AUX_PERF_SERVERINFO (section 2.2.2.2.5)
AUX_TYPE_PERF_SESSIONINFO	0x04	AUX_PERF_SESSIONINFO (section 2.2.2.2.2)
AUX_TYPE_PERF_DEFMDB_SUCCESS	0x05	AUX_PERF_DEFMDB_SUCCESS (section 2.2.2.2.7)
AUX_TYPE_PERF_DEFGC_SUCCESS	0x06	AUX_PERF_DEFGC_SUCCESS (section 2.2.2.2.8)
AUX_TYPE_PERF_MDB_SUCCESS	0x07	AUX_PERF_MDB_SUCCESS (section 2.2.2.2.9)
AUX_TYPE_PERF_GC_SUCCESS	0x08	AUX_PERF_GC_SUCCESS (section 2.2.2.2.11)
AUX_TYPE_PERF_FAILURE	0x09	AUX_PERF_FAILURE (section 2.2.2.2.13)
AUX_TYPE_CLIENT_CONTROL	0x0A	AUX_CLIENT_CONTROL (section 2.2.2.2.15)
AUX_TYPE_PERF_PROCESSINFO	0x0B	AUX_PERF_PROCESSINFO (section 2.2.2.2.6)
AUX_TYPE_PERF_BG_DEFMDB_SUCCESS	0x0C	AUX_PERF_DEFMDB_SUCCESS
AUX_TYPE_PERF_BG_DEFGC_SUCCESS	0x0D	AUX_PERF_DEFGC_SUCCESS
AUX_TYPE_PERF_BG_MDB_SUCCESS	0x0E	AUX_PERF_MDB_SUCCESS
AUX_TYPE_PERF_BG_GC_SUCCESS	0x0F	AUX_PERF_GC_SUCCESS
AUX_TYPE_PERF_BG_FAILURE	0x10	AUX_PERF_FAILURE
AUX_TYPE_PERF_FG_DEFMDB_SUCCESS	0x11	AUX_PERF_DEFMDB_SUCCESS
AUX_TYPE_PERF_FG_DEFGC_SUCCESS	0x12	AUX_PERF_DEFGC_SUCCESS
AUX_TYPE_PERF_FG_MDB_SUCCESS	0x13	AUX_PERF_MDB_SUCCESS
AUX_TYPE_PERF_FG_GC_SUCCESS	0x14	AUX_PERF_GC_SUCCESS
AUX_TYPE_PERF_FG_FAILURE	0x15	AUX_PERF_FAILURE
AUX_TYPE_OSVERSIONINFO	0x16	AUX_OSVERSIONINFO (section 2.2.2.2.16)
AUX_TYPE_EXORGINFO	0x17	AUX_EXORGINFO (section 2.2.2.2.17)
AUX_TYPE_PERF_ACCOUNTINFO	0x18	AUX_PERF_ACCOUNTINFO (section 2.2.2.2.18)
AUX_TYPE_SERVER_CAPABILITIES	0x46	AUX_SERVER_CAPABILITIES (section 2.2.2.2.19)
AUX_TYPE_ENDPOINT_CAPABILITIES	0x48	AUX_ENDPOINT_CAPABILITIES<2> (section 2.2.2.2.20)
AUX_CLIENT_CONNECTION_INFO	0x4A	AUX_CLIENT_CONNECTION_INFO (section 2.2.2.2.21)
AUX_SERVER_SESSION_INFO	0x4B	AUX_SERVER_SESSION_INFO (section 2.2.2.2.22)
AUX_PROTOCOL_DEVICE_IDENTIFICATION	0x4E	AUX_PROTOCOL_DEVICE_IDENTIFICATION (section 2.2.2.2.23)

The block type names, associated Type field values, and the corresponding auxiliary block structure that follows the AUX_HEADER when the Version field is AUX_VERSION_2 are listed in the following table.

Type name	Value	Auxiliary block structure
AUX_TYPE_PERF_SESSIONINFO	0x04	AUX_PERF_SESSIONINFO_V2 (section 2.2.2.2.3)
AUX_TYPE_PERF_MDB_SUCCESS	0x07	AUX_PERF_MDB_SUCCESS_V2 (section 2.2.2.2.10)
AUX_TYPE_PERF_GC_SUCCESS	0x08	AUX_PERF_GC_SUCCESS_V2 (section 2.2.2.2.12)
AUX_TYPE_PERF_FAILURE	0x09	AUX_PERF_FAILURE_V2 (section 2.2.2.2.14)
AUX_TYPE_PERF_PROCESSINFO	0x0B	AUX_PERF_PROCESSINFO
AUX_TYPE_PERF_BG_MDB_SUCCESS	0x0E	AUX_PERF_MDB_SUCCESS_V2
AUX_TYPE_PERF_BG_GC_SUCCESS	0x0F	AUX_PERF_GC_SUCCESS_V2
AUX_TYPE_PERF_BG_FAILURE	0x10	AUX_PERF_FAILURE_V2
AUX_TYPE_PERF_FG_MDB_SUCCESS	0x13	AUX_PERF_MDB_SUCCESS_V2
AUX_TYPE_PERF_FG_GC_SUCCESS	0x14	AUX_PERF_GC_SUCCESS_V2
AUX_TYPE_PERF_FG_FAILURE	0x15	AUX_PERF_FAILURE_V2

The auxiliary block structures are specified in section 2.2.2.2.1 through section 2.2.2.2.23.

Share via

2.2.2.2 AUX_HEADER Structure

Additional resources