mm::comm::spoe::SpoeConnection Class Reference

#include <spoe_connection.h>

Classes
struct	Impl

Public Member Functions
	SpoeConnection ()
	~SpoeConnection ()
	SpoeConnection (const SpoeConnection &)=delete
SpoeConnection &	operator= (const SpoeConnection &)=delete
std::expected< void, std::string >	connect (const std::string &host, uint16_t port, std::chrono::milliseconds timeout)
	Opens the connection. An open connection is closed first.
void	close ()
	Closes the connection. Waits for a request in progress to finish first.
bool	isOpen () const
std::expected< Frame, ConnectionError >	request (MessageType type, uint16_t status, std::span< const uint8_t > data, std::chrono::milliseconds timeout)
	Sends one request and waits up to timeout for its reply.
uint64_t	discardedReplies () const
	The replies discarded because they matched no request in progress.

Constructor & Destructor Documentation

SpoeConnection() [1/2]

mm::comm::spoe::SpoeConnection::SpoeConnection

(

)

~SpoeConnection()

mm::comm::spoe::SpoeConnection::~SpoeConnection

(

)

SpoeConnection() [2/2]

mm::comm::spoe::SpoeConnection::SpoeConnection ( const SpoeConnection &  )

delete

Member Function Documentation

close()

void mm::comm::spoe::SpoeConnection::close

(

)

Closes the connection. Waits for a request in progress to finish first.

connect()

std::expected< void, std::string > mm::comm::spoe::SpoeConnection::connect	(	const std::string &	host,
		uint16_t	port,
		std::chrono::milliseconds	timeout
	)

Opens the connection. An open connection is closed first.

discardedReplies()

uint64_t mm::comm::spoe::SpoeConnection::discardedReplies

(

)

const

The replies discarded because they matched no request in progress.

isOpen()

bool mm::comm::spoe::SpoeConnection::isOpen

(

)

const

operator=()

SpoeConnection & mm::comm::spoe::SpoeConnection::operator= ( const SpoeConnection &  )

delete

request()

std::expected< Frame, ConnectionError > mm::comm::spoe::SpoeConnection::request	(	MessageType	type,
		uint16_t	status,
		std::span< const uint8_t >	data,
		std::chrono::milliseconds	timeout
	)

Sends one request and waits up to timeout for its reply.

---

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

• libs/comm/spoe_connection.h
• libs/comm/spoe_connection.cc