Skip to main content
Pigweed's logo Pigweed
code_xml
  1. Home
  2. Reference
  3. C/C++
  4. pw::transfer::Client::Handle Class Reference
Loading...
Searching...
No Matches
pw::transfer::Client::Handle Class Reference

Overview

A handle to an active transfer. Used to manage the transfer during its operation.

Public Member Functions

constexpr Handle ()
 Creates an unassigned Handle not associated with any active transfer.
 
void Cancel ()
 Terminates the ongoing transfer.
 
void SetTransferSize (size_t size_bytes)
 

Friends

class Client
 

Member Function Documentation

◆ SetTransferSize()

void pw::transfer::Client::Handle::SetTransferSize ( size_t  size_bytes)
inline

In a Write() transfer, updates the total size of the resource being transferred. This size will be indicated to the server.

Parameters
[in]size_bytesTotal size of the transfer resource in bytes.

The documentation for this class was generated from the following file: