HttpProgress
HttpProgress
HttpProgress
HttpProgress
Struct
Definition
Contains status information on the progress of an HttpClient operation.
public : struct HttpProgresspublic struct HttpProgressPublic Structure HttpProgress// You can use this struct in JavaScript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Remarks
When sending (POST method) an HttpBufferContent class, the value jumps from 0% bytes sent to 100% bytes sent in one progress event, because the whole buffer is moved to lower network APIs all at once. For more detailed progress, use HttpStreamContent instead of HttpBufferContent, because streams are read and sent in smaller chunks, resulting in more progress events. E.g. 0 bytes sent, 65536 bytes sent, 131072 bytes sent, etc.
Fields
BytesReceived BytesReceived BytesReceived BytesReceived
The total number of bytes received.
This value includes bytes received as response headers.
If the operation was restarted, this value may be smaller than in the previous progress report.
public : field ulong BytesReceivedpublic field ulong BytesReceivedPublic Field BytesReceived// You can use this field in JavaScript.
BytesSent BytesSent BytesSent BytesSent
The total number of bytes sent.
This value includes bytes sent as request headers.
If the operation was restarted, this value may be smaller than in the previous progress report.
public : field ulong BytesSentpublic field ulong BytesSentPublic Field BytesSent// You can use this field in JavaScript.
Retries Retries Retries Retries
The number of retries.
public : field unsigned int Retriespublic field uint RetriesPublic Field Retries// You can use this field in JavaScript.
Stage Stage Stage Stage
The step in the progress of an HTTP connection.
public : field HttpProgressStage Stagepublic field HttpProgressStage StagePublic Field Stage// You can use this field in JavaScript.
TotalBytesToReceive TotalBytesToReceive TotalBytesToReceive TotalBytesToReceive
The total number of data bytes to receive.
If the number is unknown, this value is 0.
public : field IReference<ulong> TotalBytesToReceivepublic field Nullable<ulong> TotalBytesToReceivePublic Field TotalBytesToReceive// You can use this field in JavaScript.
TotalBytesToSend TotalBytesToSend TotalBytesToSend TotalBytesToSend
The total number of data bytes to send.
If the number is unknown, this value is 0.
public : field IReference<ulong> TotalBytesToSendpublic field Nullable<ulong> TotalBytesToSendPublic Field TotalBytesToSend// You can use this field in JavaScript.