cargo::FDStore Class Reference

#include <fdstore.hpp>

Public Member Functions
	FDStore (int fd=-1)
	Constructor. More...
	FDStore (const FDStore &store)
	~FDStore ()
void	write (const void *bufferPtr, const size_t size, const unsigned int timeoutMS=maxTimeout)
	Write data using the file descriptor. More...
void	read (void *bufferPtr, const size_t size, const unsigned int timeoutMS=maxTimeout)
	Reads a value of the given type. More...
void	sendFD (int fd, const unsigned int timeoutMS=maxTimeout)
int	receiveFD (const unsigned int timeoutMS=maxTimeout)

Private Attributes
int	mFD

Constructor & Destructor Documentation

cargo::FDStore::FDStore

(

int

fd = -1

)

Constructor.

One can pass any kind of file descriptor. Serialization is NOT written for network purposes, rather local communication.

Parameters

fd	file descriptor

cargo::FDStore::FDStore

(

const FDStore &

store

)

cargo::FDStore::~FDStore

(

)

Member Function Documentation

void cargo::FDStore::read	(	void *	bufferPtr,
		const size_t	size,
		const unsigned int	timeoutMS = maxTimeout
	)

Reads a value of the given type.

Parameters

bufferPtr	buffer with the data
size	size of the buffer
timeoutMS	timeout in milliseconds

int cargo::FDStore::receiveFD

(

const unsigned int

timeoutMS = maxTimeout

)

void cargo::FDStore::sendFD	(	int	fd,
		const unsigned int	timeoutMS = maxTimeout
	)

void cargo::FDStore::write	(	const void *	bufferPtr,
		const size_t	size,
		const unsigned int	timeoutMS = maxTimeout
	)

Write data using the file descriptor.

Parameters

bufferPtr	buffer with the data
size	size of the buffer
timeoutMS	timeout in milliseconds

Member Data Documentation

int cargo::FDStore::mFD

private

---

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

• libs/cargo-fd/fdstore.hpp
• libs/cargo-fd/fdstore.cpp