CIRCT  20.0.0git
Public Member Functions | List of all members
esi::services::SysInfo Class Referenceabstract

Information about the Accelerator system. More...

#include <Services.h>

Inheritance diagram for esi::services::SysInfo:
Inheritance graph
[legend]
Collaboration diagram for esi::services::SysInfo:
Collaboration graph
[legend]

Public Member Functions

virtual ~SysInfo ()=default
 
virtual std::string getServiceSymbol () const override
 
virtual uint32_t getEsiVersion () const =0
 Get the ESI version number to check version compatibility. More...
 
virtual std::string getJsonManifest () const
 Return the JSON-formatted system manifest. More...
 
virtual std::vector< uint8_t > getCompressedManifest () const =0
 Return the zlib compressed JSON system manifest. More...
 
- Public Member Functions inherited from esi::services::Service
virtual ~Service ()=default
 
virtual ServicegetChildService (AcceleratorConnection *conn, Service::Type service, AppIDPath id={}, std::string implName={}, ServiceImplDetails details={}, HWClientDetails clients={})
 Create a "child" service of this service. More...
 
virtual ServicePortgetPort (AppIDPath id, const BundleType *type, const std::map< std::string, ChannelPort & > &, AcceleratorConnection &) const
 Get specialized port for this service to attach to the given appid path. More...
 

Additional Inherited Members

- Public Types inherited from esi::services::Service
using Type = const std::type_info &
 

Detailed Description

Information about the Accelerator system.

Definition at line 93 of file Services.h.

Constructor & Destructor Documentation

◆ ~SysInfo()

virtual esi::services::SysInfo::~SysInfo ( )
virtualdefault

Member Function Documentation

◆ getCompressedManifest()

virtual std::vector<uint8_t> esi::services::SysInfo::getCompressedManifest ( ) const
pure virtual

Return the zlib compressed JSON system manifest.

Implemented in esi::services::MMIOSysInfo.

Referenced by getJsonManifest().

◆ getEsiVersion()

virtual uint32_t esi::services::SysInfo::getEsiVersion ( ) const
pure virtual

Get the ESI version number to check version compatibility.

Implemented in esi::services::MMIOSysInfo.

Referenced by main(), and PYBIND11_MODULE().

◆ getJsonManifest()

std::string SysInfo::getJsonManifest ( ) const
virtual

Return the JSON-formatted system manifest.

Get the compressed manifest, uncompress, and return it.

Definition at line 40 of file Services.cpp.

References getCompressedManifest(), and MAX_MANIFEST_SIZE.

Referenced by printHier(), and PYBIND11_MODULE().

◆ getServiceSymbol()

std::string SysInfo::getServiceSymbol ( ) const
overridevirtual

Implements esi::services::Service.

Definition at line 35 of file Services.cpp.


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