Ensō 0.4.6
Software API reference
Loading...
Searching...
No Matches
pipe.h File Reference

Enso Pipe API. We define RX, TX, and RX/TX pipes as well as the Device class that manages them. All of these classes are quite coupled, so we define them all in this file. More...

#include <enso/consts.h>
#include <enso/helpers.h>
#include <enso/internals.h>
#include <array>
#include <cassert>
#include <functional>
#include <iostream>
#include <memory>
#include <string>
#include <vector>

Go to the source code of this file.

Classes

class  enso::Device
 A class that represents a device. More...
 
class  enso::RxPipe
 A class that represents an RX Enso Pipe. More...
 
class  enso::RxPipe::MessageBatch< T >
 A class that represents a batch of messages. More...
 
class  enso::TxPipe
 A class that represents a TX Enso Pipe. More...
 
class  enso::RxTxPipe
 A class that represents an RX/TX Enso Pipe. More...
 
class  enso::MessageIteratorBase< T >
 Base class to represent a message within a batch. More...
 
class  enso::PktIterator
 Packet iterator. More...
 
class  enso::PeekPktIterator
 Packet iterator that does not consume the packets from the pipe. More...
 

Functions

uint32_t enso::external_peek_next_batch_from_queue (struct RxEnsoPipeInternal *enso_pipe, struct NotificationBufPair *notification_buf_pair, void **buf)
 

Detailed Description

Enso Pipe API. We define RX, TX, and RX/TX pipes as well as the Device class that manages them. All of these classes are quite coupled, so we define them all in this file.

Author
Hugo Sadok sadok.nosp@m.@cmu.nosp@m..edu

Definition in file pipe.h.

Function Documentation

◆ external_peek_next_batch_from_queue()

uint32_t enso::external_peek_next_batch_from_queue ( struct RxEnsoPipeInternal enso_pipe,
struct NotificationBufPair notification_buf_pair,
void **  buf 
)

Definition at line 58 of file pipe.cpp.