Appendix A structures
WF_SMC_SERVER_DATA
typedef struct
{
UINT32 VersionNumber;
UINT64 TotalBytesSentPreCompression;
UINT64 TotalBytesSentPostCompression;
UINT64 TotalBytesReceivedPreExpansion;
UINT64 TotalBytesReceivedPostExpansion;
UINT32 BandwidthSentBitsPerSec;
UINT32 BandwidthReceivedBitsPerSec;
UINT32 CompressionNumeratorSent;
UINT32 CompressionDenominatorSent;
UINT32 CompressionNumeratorReceived;
UINT32 CompressionDenominatorReceived;
} WF_SMC_SERVER_DATA, * PWF_SMC_SERVER_DATA;
Members
| Element | Description |
|---|---|
| VersionNumber | Version number of this structure. The value is 1. |
| TotalBytesSentPreCompression | Cumulative total bytes sent from all virtual channels before compression since the server was last rebooted. |
| TotalBytesSentPostCompression | Cumulative total of bytes sent to the wire since the server was last rebooted. This does not include TCP/IP or wire packet overhead. |
| TotalBytesReceivedPreExpansion | Cumulative total of bytes received from the wire since the server was last rebooted. This does not include TCP/IP or wire packet overhead. |
| TotalBytesReceivedPostExpansion | Cumulative total of bytes passed to virtual channels after expansion since the server was last rebooted. |
| BandwidthSentBitsPerSec | The ICA bandwidth sent from the server to all clients. |
| BandwidthReceivedBitsPerSec | The ICA bandwidth received at the server from all clients. |
| CompressionNumeratorSent | The numerator for the compression ratio for server to client traffic. |
| CompressionDenominatorSent | The denominator for the compression ratio for server to client traffic. |
| CompressionNumeratorReceived | The numerator for the compression ratio for client to server traffic. |
| CompressionDenominatorReceived | The denominator for the compression ratio for client to server traffic. |
WF_SMC_SERVER_VC_DATA
typedef struct
{
UINT32 VersionNumber;
UINT32 InUseCount;
UINT32 BandwidthSentBitsPerSecPostCompressionEstimate;
UINT64 BytesSent;
UINT32 BandwidthReceivedBitsPerSecPreExpansionEstimate;
UINT64 BytesReceived;
WCHAR rgwchName[8];
} WF_SMC_SERVER_VC_DATA, * PWF_SMC_SERVER_VC_DATA;
Members
| Value | Description |
|---|---|
| VersionNumber | Version Number of this structure. The value is 1. |
| InUseCount | Count of current sessions sending or receiving data through this virtual channel. |
| BandwidthSentBitsPerSecPostCompressionEstimate | The estimated bandwidth on this virtual channel from the server to all clients. |
| BytesSent | Cumulative total of bytes sent through this virtual channel. |
| BandwidthReceivedBitsPerSecPreExpansionEstimate | The estimated bandwidth on this virtual channel from all clients to the server. |
| BytesReceived | Cumulative total of bytes received through this virtual channel. |
| rgwchName | The internal name of this virtual channel, which is less than or equal to eight characters including the terminating NULL. |
WF_SMC_SESSION_DATA
typedef struct {
UINT32 VersionNumber;
UINT32 BandwidthSentBitsPerSecond;
UINT32 BytesSentPreCompression;
UINT32 BytesSentPostCompression;
UINT32 BandwidthReceivedBitsPerSecond;
UINT32 BytesReceivedPreExpansion;
UINT32 BytesReceivedPostExpansion;
UINT32 CompressionNumeratorSent;
UINT32 CompressionDenominatorSent;
UINT32 CompressionNumeratorReceived;
UINT32 CompressionDenominatorReceived;
UINT32 LastClientLatency;
UINT32 AverageClientLatency;
UINT32 RoundTripDeviation;
UINT32 LastUpdateTime;
UINT32 SessionBandwidthLimitKBitsPerSecond;
UINT32 OutputSpeedInBitsPerSecond;
UINT32 InputSpeedInBitsPerSecond;
} WF_SMC_SESSION_DATA, * PWF_SMC_SESSION_DATA;
Members
| Value | Description |
|---|---|
| VersionNumber | Version Number of this structure. The value is 1. |
| BandwidthSentBitsPerSecond | The current bandwidth of this session for sent data. |
| BytesSentPreCompression | The total bytes sent by this session before compression has occurred. |
| BytesSentPostCompression | The total bytes sent by this session after compression has occurred. |
| BandwidthReceivedBitsPerSecond | The current bandwidth of this session for received data. |
| BytesReceivedPreExpansion | The total bytes received by this session before expansion of the data has occurred. |
| BytesReceivedPostExpansion | The total number of bytes received by this session after expansion of the data has occurred. |
| CompressionNumeratorSent | The current numerator of compression for bytes sent. |
| CompressionDenominatorSent | The current denominator of compression for bytes sent. |
| CompressionNumeratorReceived | The current numerator of expansion of bytes received. |
| CompressionDenominatorReceived | The current denominator of expansion of bytes received. |
| LastClientLatency | Last recorded latency reading for this session. |
| AverageClientLatency | Average calculated latency for this session. |
| RoundTripDeviation | Round trip deviation for this session. |
| LastUpdateTime | The tick count at the last update of latency values. |
| SessionBandwidthLimitKBitsPerSecond | The bandwidth cap on this session in KBits / Second |
| OutputSpeedInBitsPerSecond | The output line speed from server to client for a session in bits per second. |
| InputSpeedInBitsPerSecond | The input line speed from client to sever for a session in bits per second. |
Remarks
For all latency counters, a value of 0xFFFFFFFF means it is invalid.
WF_SMC_SESSION_VC_DATA
typedef struct
{
UINT32 VersionNumber;
UINT32 idVC;
UINT32 PreReducerBitsPerSecond;
UINT32 BandwidthSentPostCompressionEstimate;
UINT32 BytesSentTotal;
UINT32 PostExpanderBitsPerSecond;
UINT32 BandwidthReceivedPreExpansionEstimate;
UINT32 BytesReceivedTotal;
} WF_SMC_SESSION_VC_DATA, * PWF_SMC_SESSION_VC_DATA;
Members
| Value | Description |
|---|---|
| VersionNumber | Version number of this structure. The value is 1. |
| idVC | The ID number of this virtual channel for which data is to be retrieved. |
| PreReducerBitsPerSecond | The bit rate passing into the reducer before compression has occurred. |
| BandwidthSentPostCompressionEstimate | The estimated sent bandwidth on the wire for this VC. This value takes into account the output session compression ratio. |
| PostExpanderBitsPerSecond | The bit rate of the channel after expansion of the data stream from the client has taken place. |
| BandwidthReceivedPreExpansionEstimate | The estimated received bandwidth on the wire for this vrtucal channel. This is calculated using the session compression ratio. |
| BytesReceivedTotal | Total bytes received on the virtual channel. |
CTX_SMC_SESSION_DATA_V2
typedef struct
{
UINT32 VersionNumber;
UINT32 QosLevel;
UINT32 BandwidthSentBitsPerSecond;
UINT32 BytesSentPreCompression;
UINT32 BytesSentPostCompression;
UINT32 BandwidthReceivedBitsPerSecond;
UINT32 BytesReceivedPreExpansion;
UINT32 BytesReceivedPostExpansion;
UINT32 CompressionNumeratorSent;
UINT32 CompressionDenominatorSent;
UINT32 CompressionNumeratorReceived;
UINT32 CompressionDenominatorReceived;
UINT32 LastClientLatency;
UINT32 AverageClientLatency;
UINT32 RoundTripDeviation;
UINT32 LastUpdateTime;
UINT32 SessionBandwidthLimitKBitsPerSecond;
UINT32 OutputSpeedInBitsPerSecond;
UINT32 InputSpeedInBitsPerSecond;
UINT32 IsConnectionActive;
UINT32 IsPrimaryStream;
} Ctx_Smc_Session_Data_V2, *pCtx_Smc_Session_Data_V2;
Members
| Value | Description | ||
|---|---|---|---|
| VersionNumber | Version Number of this structure. The value is 2. | ||
| QosLevel | This is the connection-within session and corresponds to QoSLevel that can be between 0 – 3. | ||
| BandwidthSentBitsPerSecond | The current bandwidth of this session-connection for sent data. | ||
| BytesSentPreCompression | The total bytes sent by this session-connection before compression has occurred | BytesSentPostCompression | The total bytes sent by this session-connection after compression has occurred |
| BandwidthReceivedBitsPerSecond | The current bandwidth of this session-connection for received data. | ||
| BytesReceivedPreExpansion | The total bytes received by this session-connection before expansion of the data has occurred. | ||
| BytesReceivedPostExpansion | The total number of bytes received by this session-connection after expansion of the data has occurred. | ||
| CompressionNumeratorSent | The current numerator of compression for bytes sent for this session-connection. | ||
| CompressionDenominatorSent | The current denominator of compression for bytes sent for this session-connection. | ||
| CompressionNumeratorReceived | The current numerator of expansion of bytes received for this session connection. | ||
| CompressionDenominatorReceived | The current denominator of expansion of bytes received for this session-connection. | ||
| LastClientLatency | Last recorded latency reading for this session-connection. | ||
| AverageClientLatency | Average calculated latency for this session-connection. | ||
| RoundTripDeviation | Round trip deviation for this session-connection. | ||
| LastUpdateTime | The tick count at the last update of latency values for this session-connection. | ||
| SessionBandwidthLimitKBitsPerSecond | The bandwidth cap on this session-connection in KBits / Second. | ||
| OutputSpeedInBitsPerSecond | The output line speed from server to client for a session-connection in bits per second. | ||
| InputSpeedInBitsPerSecond | The input line speed from client to sever for a session-connection in bits per second. | ||
| IsConnectionActive | Non-zero if this connection in the session is active, otherwise it is 0. | ||
| IsPrimaryStream | Non-zero if this connection is the primary connection within the session otherwise it is 0. |
CTX_SMC_SESSION_VC_DATA_V2
typedef struct
{
UINT32 VersionNumber;
UINT32 idVC;
WCHAR rgwchName[8];
UINT32 QosLevel;
UINT32 PreReducerBitsPerSecond;
UINT32 BandwidthSentPostCompressionEstimate;
UINT32 BytesSentTotal;
UINT32 PostExpanderBitsPerSecond;
UINT32 BandwidthReceivedPreExpansionEstimate;
UINT32 BytesReceivedTotal;
UINT32 BandwidthLimitKBitsPerSecond;
} Ctx_Smc_Session_VC_Data_V2, *pCtx_Smc_Session_VC_Data_V2;
Members
| Element | Description |
|---|---|
| VersionNumber | Version number of this structure. The value is 2. |
| idVC | The ID number of this virtual channel for which data is to be retrieved. |
| rgwchName | Name of the virtual channel. |
| QosLevel | QosLevel or connection-within the session on which the virtual channel is running. |
| PreReducerBitsPerSecond | The bit rate passing into the reducer before compression has occurred. |
| BandwidthSentPostCompressionEstimate | The estimated sent bandwidth on the wire for this virtual channel. This value takes into account the output session compression ratio. |
| PostExpanderBitsPerSecond | The bit rate of the channel after expansion of the data stream from the client has taken place. |
| BandwidthReceivedPreExpansionEstimate | The estimated received bandwidth on the wire for this virtual channel. This is calculated using the session compression ratio. |
| BytesReceivedTotal | Total bytes received on the virtual channel. |
WF_SMC_SESSION_VC_NAME
typedef struct
{
UINT32 VersionNumber,
UINT32 idVC,
WCHAR rgwchName[8]
} WF_SMC_SESSION_VC_NAME, * PWF_SMC_SESSION_VC_NAME;
Members
| Element | Description |
|---|---|
| VersionNumber | Version number of this structure. The value is 1. |
| idVC | The ID number of this virtual channel to be used in other calls for this session. |
| rgwchName | The null terminated WCHAR name of the virtual channel. |