rtctk::componentFramework::RtrClient Class Reference

This internal class implements the basic communication and commands toward the server. More...

Public Types
using	PathList = RepositoryIf::PathList
using	Headers = std::map<std::string, std::string>
using	UserFunc

Public Member Functions
	RtrClient (const std::string &ip, uint16_t port)
	~RtrClient ()
void	Create (const DataPointPath &dp, gsl::span< const std::byte > data, const Headers &headers)
void	CreateSymlink (const DataPointPath &target, const DataPointPath &link)
void	UpdateSymlink (const DataPointPath &target, const DataPointPath &link)
void	Write (const DataPointPath &dp, gsl::span< const std::byte > data, const Headers &headers_in, Headers &headers_out)
void	Patch (const DataPointPath &dp, gsl::span< const std::byte > data, const Headers &headers_in, Headers &headers_out)
void	Read (const DataPointPath &dp, Headers &headers, const UserFunc &get_buffer_view)
bool	Exists (const DataPointPath &dp)
void	Info (const DataPointPath &dp, Headers &headers_out)
void	Delete (const DataPointPath &dp)
std::pair< PathList, PathList >	GetChildren (const DataPointPath &dp, bool recurse)

Detailed Description

This internal class implements the basic communication and commands toward the server.

Member Typedef Documentation

Headers

using rtctk::componentFramework::RtrClient::Headers = std::map<std::string, std::string>

PathList

using rtctk::componentFramework::RtrClient::PathList = RepositoryIf::PathList

UserFunc

using rtctk::componentFramework::RtrClient::UserFunc

Initial value:

 
        std::function<gsl::span<std::byte>(const std::string&, const std::vector<size_t>&, size_t)>

Constructor & Destructor Documentation

RtrClient()

rtctk::componentFramework::RtrClient::RtrClient ( const std::string & ip, uint16_t port )

inline

~RtrClient()

rtctk::componentFramework::RtrClient::~RtrClient ( )

inline

Member Function Documentation

Create()

void rtctk::componentFramework::RtrClient::Create ( const DataPointPath & dp, gsl::span< const std::byte > data, const Headers & headers )

inline

CreateSymlink()

void rtctk::componentFramework::RtrClient::CreateSymlink ( const DataPointPath & target, const DataPointPath & link )

inline

Delete()

void rtctk::componentFramework::RtrClient::Delete ( const DataPointPath & dp )

inline

Exists()

bool rtctk::componentFramework::RtrClient::Exists ( const DataPointPath & dp )

inline

GetChildren()

std::pair< PathList, PathList > rtctk::componentFramework::RtrClient::GetChildren ( const DataPointPath & dp, bool recurse )

inline

Info()

void rtctk::componentFramework::RtrClient::Info ( const DataPointPath & dp, Headers & headers_out )

inline

Patch()

void rtctk::componentFramework::RtrClient::Patch ( const DataPointPath & dp, gsl::span< const std::byte > data, const Headers & headers_in, Headers & headers_out )

inline

Read()

void rtctk::componentFramework::RtrClient::Read ( const DataPointPath & dp, Headers & headers, const UserFunc & get_buffer_view )

inline

UpdateSymlink()

void rtctk::componentFramework::RtrClient::UpdateSymlink ( const DataPointPath & target, const DataPointPath & link )

inline

Write()

void rtctk::componentFramework::RtrClient::Write ( const DataPointPath & dp, gsl::span< const std::byte > data, const Headers & headers_in, Headers & headers_out )

inline

---

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

• componentFramework/services/runtimeRepo/src/runtimeRepoAdapter.cpp