CIRCT  19.0.0git
Public Member Functions | Private Attributes | List of all members
esi::ChannelPort Class Reference

Unidirectional channels are the basic communication primitive between the host and accelerator. More...

#include <Ports.h>

Inheritance diagram for esi::ChannelPort:
Inheritance graph
[legend]
Collaboration diagram for esi::ChannelPort:
Collaboration graph
[legend]

Public Member Functions

 ChannelPort (const Type *type)
 
virtual ~ChannelPort ()=default
 
virtual void connect ()
 
virtual void disconnect ()
 
const TypegetType () const
 

Private Attributes

const Typetype
 

Detailed Description

Unidirectional channels are the basic communication primitive between the host and accelerator.

A 'ChannelPort' is the host side of a channel. It can be either read or write but not both. At this level, channels are untyped – just streams of bytes. They are not intended to be used directly by users but used by higher level APIs which add types.

Definition at line 31 of file Ports.h.

Constructor & Destructor Documentation

◆ ChannelPort()

esi::ChannelPort::ChannelPort ( const Type type)
inline

Definition at line 33 of file Ports.h.

◆ ~ChannelPort()

virtual esi::ChannelPort::~ChannelPort ( )
virtualdefault

Member Function Documentation

◆ connect()

virtual void esi::ChannelPort::connect ( )
inlinevirtual

Definition at line 36 of file Ports.h.

Referenced by PYBIND11_MODULE().

◆ disconnect()

virtual void esi::ChannelPort::disconnect ( )
inlinevirtual

Definition at line 37 of file Ports.h.

◆ getType()

const Type* esi::ChannelPort::getType ( ) const
inline

Definition at line 39 of file Ports.h.

References type.

Referenced by PYBIND11_MODULE().

Member Data Documentation

◆ type

const Type* esi::ChannelPort::type
private

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