CIRCT 24.0.0git
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
esi::TypedReadPort< void > Class Reference

Specialization for void — read discards data and returns nothing. More...

#include <TypedPorts.h>

Collaboration diagram for esi::TypedReadPort< void >:
Collaboration graph
[legend]

Public Member Functions

 TypedReadPort (ReadChannelPort &port)
 
 TypedReadPort (ReadChannelPort *port)
 
 TypedReadPort (const TypedReadPort &)=delete
 
TypedReadPortoperator= (const TypedReadPort &)=delete
 
 TypedReadPort (TypedReadPort &&)=delete
 
TypedReadPortoperator= (TypedReadPort &&)=delete
 
 ~TypedReadPort ()
 
void connect (const ChannelPort::ConnectOptions &opts={std::nullopt, false})
 
void connect (std::function< bool()> callback, const ChannelPort::ConnectOptions &opts={std::nullopt, false})
 
void read ()
 
std::future< void > readAsync ()
 
void disconnect ()
 
bool isConnected () const
 
ReadChannelPortraw ()
 
const ReadChannelPortraw () const
 

Private Attributes

ReadChannelPortinner
 

Detailed Description

Specialization for void — read discards data and returns nothing.

Definition at line 893 of file TypedPorts.h.

Constructor & Destructor Documentation

◆ TypedReadPort() [1/4]

esi::TypedReadPort< void >::TypedReadPort ( ReadChannelPort port)
inlineexplicit

Definition at line 895 of file TypedPorts.h.

◆ TypedReadPort() [2/4]

esi::TypedReadPort< void >::TypedReadPort ( ReadChannelPort port)
inline

Definition at line 897 of file TypedPorts.h.

◆ TypedReadPort() [3/4]

esi::TypedReadPort< void >::TypedReadPort ( const TypedReadPort< void > &  )
delete

◆ TypedReadPort() [4/4]

esi::TypedReadPort< void >::TypedReadPort ( TypedReadPort< void > &&  )
delete

◆ ~TypedReadPort()

esi::TypedReadPort< void >::~TypedReadPort ( )
inline

Member Function Documentation

◆ connect() [1/2]

void esi::TypedReadPort< void >::connect ( const ChannelPort::ConnectOptions opts = {std::nullopt, false})
inline

Definition at line 908 of file TypedPorts.h.

◆ connect() [2/2]

void esi::TypedReadPort< void >::connect ( std::function< bool()>  callback,
const ChannelPort::ConnectOptions opts = {std::nullopt, false} 
)
inline

Definition at line 916 of file TypedPorts.h.

◆ disconnect()

void esi::TypedReadPort< void >::disconnect ( )
inline

◆ isConnected()

bool esi::TypedReadPort< void >::isConnected ( ) const
inline

◆ operator=() [1/2]

TypedReadPort & esi::TypedReadPort< void >::operator= ( const TypedReadPort< void > &  )
delete

◆ operator=() [2/2]

TypedReadPort & esi::TypedReadPort< void >::operator= ( TypedReadPort< void > &&  )
delete

◆ raw() [1/2]

ReadChannelPort & esi::TypedReadPort< void >::raw ( )
inline

Definition at line 941 of file TypedPorts.h.

References esi::TypedReadPort< T, SkipTypeCheck >::inner.

◆ raw() [2/2]

const ReadChannelPort & esi::TypedReadPort< void >::raw ( ) const
inline

Definition at line 942 of file TypedPorts.h.

References esi::TypedReadPort< T, SkipTypeCheck >::inner.

◆ read()

void esi::TypedReadPort< void >::read ( )
inline

◆ readAsync()

std::future< void > esi::TypedReadPort< void >::readAsync ( )
inline

Member Data Documentation

◆ inner

ReadChannelPort* esi::TypedReadPort< void >::inner
private

Definition at line 945 of file TypedPorts.h.


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