Pw_channel_packets

Classes
class	pw::channel::PacketChannel< T, kProperties >
class	pw::channel::AnyPacketChannel< T >

Typedefs
template<typename Packet >
using	pw::channel::PacketWriter = PacketChannel< Packet, kWritable >
template<typename Packet >
using	pw::channel::PacketReader = PacketChannel< Packet, kReadable >
template<typename Packet >
using	pw::channel::PacketReaderWriter = PacketChannel< Packet, kReadable, kWritable >

Variables
constexpr uint16_t	pw::channel::kNoFlowControl = std::numeric_limits<uint16_t>::max()

Detailed Description

Typedef Documentation

PacketReader

template<typename Packet >

using pw::channel::PacketReader = typedef PacketChannel<Packet, kReadable>

Asynchronous type that receives packets of a given type.

Template Parameters

Packet

Type to be received.

PacketReaderWriter

template<typename Packet >

using pw::channel::PacketReaderWriter = typedef PacketChannel<Packet, kReadable, kWritable>

Asynchronous type that sends and receives packets of a given type.

Template Parameters

Packet

Type to be received or written.

PacketWriter

template<typename Packet >

using pw::channel::PacketWriter = typedef PacketChannel<Packet, kWritable>

Asynchronous type that sends packets of a given type.

This type has built-in flow control, and will block when it exhausts its available writes until some number of those writes have been acknowledged.

Template Parameters

Packet

Type to be written.

Variable Documentation

kNoFlowControl

constexpr uint16_t pw::channel::kNoFlowControl = std::numeric_limits<uint16_t>::max()

inlineconstexpr

If the number of available writes is set to this value, flow control is disabled.