Pigweed
C/C++ API Reference
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
pw::channel::PendingWrite< Packet > Class Template Reference

Public Member Functions

 PendingWrite (const PendingWrite &)=delete
 
PendingWriteoperator= (const PendingWrite &)=delete
 
constexpr PendingWrite (PendingWrite &&other)
 
constexpr PendingWriteoperator= (PendingWrite &&other)
 
void Stage (Packet &&packet)
 
size_t num_packets () const
 

Friends

class AnyPacketChannel< Packet >
 

Detailed Description

template<typename Packet>
class pw::channel::PendingWrite< Packet >

Represents a pending write operation. Returned by pw::channel::PacketChannel::PendReadyToWrite.

Member Function Documentation

◆ Stage()

template<typename Packet >
void pw::channel::PendingWrite< Packet >::Stage ( Packet &&  packet)
inline

Enqueues a packet to be written. Must be called before the PendingWrite goes out of scope.

Stage may be called up to num_packets() times.


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