#include <TincClient.hpp>

Inheritance diagram for tinc::TincClient:

Public Types
enum	{ CREATE_DATA_SLICE = 0x01 }

enum	Status { STATUS_UNKNOWN = 0x00 , STATUS_AVAILABLE = 0x01 , STATUS_BUSY = 0x02 }

Public Member Functions
	TincClient ()

bool	start (uint16_t serverPort=34450, const char *serverAddr="localhost") override
	start the TINC client More...

void	stop () override
	stop the connection More...

bool	sendTincMessage (void msg, al::Socket dst=nullptr, al::ValueSource *src=nullptr) override
	sendTincMessage More...

void	requestParameters ()

void	requestProcessors ()

void	requestDiskBuffers ()

void	requestDataPools ()

void	requestParameterSpaces ()

void	synchronize ()

void	sendMetadata ()

bool	barrier (uint32_t group=0, float timeoutsec=0.0) override
	Wait for lock, then wait for unlock. More...

Status	serverStatus ()
	Return latest status reported by server. More...

bool	waitForServer (float timeoutsec=0.0)
	return only when server status is STATUS_AVAILABLE More...

uint64_t	pingServer ()
	send a ping message to the tinc server More...

bool	waitForPong (uint64_t pingCode, float timeoutsec=30, al::Socket *src=nullptr)
	waitForPong More...

std::string	getWorkingPath ()

void	setVerbose (bool verbose=true)

bool	verbose ()

bool	registerParameter (al::ParameterMeta &param, al::Socket *src=nullptr)
	register a parameter with this Tinc node More...

bool	registerParameterSpaceDimension (ParameterSpaceDimension &psd, al::Socket *src=nullptr)
	register a parameter space dimencion with this Tinc node More...

bool	registerParameterSpace (ParameterSpace &ps, al::Socket *src=nullptr)
	register a parameter space with this Tinc node More...

bool	registerProcessor (Processor &processor, al::Socket *src=nullptr)
	register a processor with this Tinc node More...

bool	registerDiskBuffer (DiskBufferAbstract &db, al::Socket *src=nullptr)
	register a disk buffer with this Tinc node More...

bool	registerDataPool (DataPool &dp, al::Socket *src=nullptr)
	register a data pool with this Tinc node More...

TincProtocol &	operator<< (al::ParameterMeta &p)

TincProtocol &	operator<< (ParameterSpace &p)

TincProtocol &	operator<< (ParameterSpaceDimension &psd)

TincProtocol &	operator<< (Processor &p)

TincProtocol &	operator<< (DiskBufferAbstract &db)

TincProtocol &	operator<< (DataPool &dp)

void	requestParameters (al::Socket *dst)

void	requestParameterSpaces (al::Socket *dst)

void	requestProcessors (al::Socket *dst)

void	requestDiskBuffers (al::Socket *dst)

void	requestDataPools (al::Socket *dst)

void	removeParameter (std::string name, std::string group="", bool invoked=false, al::Socket *src=nullptr)

void	removeParameterSpace (std::string name, al::Socket *src=nullptr)

void	removeProcessor (std::string name, al::Socket *src=nullptr)

void	removeDiskbuffer (std::string name, al::Socket *src=nullptr)

void	removeDataPool (std::string name, al::Socket *src=nullptr)

ParameterSpaceDimension *	getDimension (std::string name, std::string group="")
	get a registered dimension in this Tinc node More...

al::ParameterMeta *	getParameter (std::string name, std::string group="")
	get a parameter from a registered dimension in this Tinc node More...

std::vector< ParameterSpaceDimension * >	dimensions ()

ParameterSpace *	getParameterSpace (std::string name)

std::vector< ParameterSpace * >	parameterSpaces ()

DiskBufferAbstract *	getDiskBuffer (std::string name)

DataPool *	getDataPool (std::string name)

virtual void	markBusy ()

virtual void	markAvailable ()

Status	getStatus ()

void	setRootMapEntry (std::string serverPath, std::string clientPath, std::string host="")
	setRootMapEntry More...

const std::map< std::string, std::vector< std::pair< std::string, std::string > > >	getRootPathMap ()

void	print (std::ostream &stream=std::cout)

Protected Member Functions
bool	processIncomingMessage (al::Message &message, al::Socket *src) override

void	processBarrierRequest (al::Socket *src, uint64_t barrierConsecutive)

void	processBarrierUnlock (al::Socket *src, uint64_t barrierConsecutive)

void	processStatusMessage (void *message)

void	processWorkingPathMessage (void *message)

void	connectParameterCallbacks (al::ParameterMeta &param)

void	connectDimensionCallbacks (ParameterSpaceDimension &psd)

void	readRequestMessage (int objectType, std::string objectId, al::Socket *src)

void	processRequestParameters (al::Socket *dst)

void	processRequestParameterSpaces (al::Socket *dst)

void	processRequestProcessors (al::Socket *dst)

void	processRequestDiskBuffers (al::Socket *dst)

void	processRequestDataPools (al::Socket *dst)

bool	readRegisterMessage (int objectType, void any, al::Socket src, bool forward=false)

bool	processRegisterParameter (void any, al::Socket src, bool forward=false)

bool	processRegisterParameterSpace (void any, al::Socket src, bool forward=false)

bool	processRegisterProcessor (void any, al::Socket src, bool forward=false)

bool	processRegisterDiskBuffer (void any, al::Socket src, bool forward=false)

bool	processRegisterDataPool (void any, al::Socket src, bool forward=false)

bool	processConfigureParameterMessage (void conf, ParameterSpaceDimension dim, al::Socket *src, bool forward=false)

void	sendRegisterMessage (ParameterSpaceDimension dim, al::Socket dst, al::Socket *src=nullptr)

void	sendRegisterMessage (ParameterSpace ps, al::Socket dst, al::Socket *src=nullptr)

void	sendRegisterMessage (Processor p, al::Socket dst, al::Socket *src=nullptr)

void	sendRegisterMessage (DiskBufferAbstract p, al::Socket dst, al::Socket *src=nullptr)

void	sendRegisterMessage (DataPool p, al::Socket dst, al::Socket *src=nullptr)

bool	readConfigureMessage (int objectType, void any, al::Socket src, bool forward=false)

bool	processConfigureParameter (void any, al::Socket src, bool forward=false)

bool	processConfigureParameterSpace (void any, al::Socket src, bool forward=false)

bool	processConfigureProcessor (void any, al::Socket src, bool forward=false)

bool	processConfigureDiskBuffer (void any, al::Socket src, bool forward=false)

bool	processConfigureDataPool (void any, al::Socket src, bool forward=false)

void	sendConfigureMessage (ParameterSpaceDimension dim, al::Socket dst, al::Socket *src=nullptr)

void	sendConfigureMessage (ParameterSpace ps, al::Socket dst, al::Socket *src=nullptr)

void	sendConfigureMessage (Processor p, al::Socket dst, al::Socket *src=nullptr)

void	sendConfigureMessage (DataPool p, al::Socket dst, al::Socket *src=nullptr)

void	sendConfigureMessage (DiskBufferAbstract p, al::Socket dst, al::Socket *src=nullptr)

void	sendConfigureParameterSpaceAddDimension (ParameterSpace ps, ParameterSpaceDimension dim, al::Socket dst, al::Socket src=nullptr)

void	sendConfigureParameterSpaceRemoveDimension (ParameterSpace ps, ParameterSpaceDimension dim, al::Socket dst, al::Socket src=nullptr)

bool	readRemoveMessage (int objectType, void any, al::Socket src)

bool	processRemoveParameter (void any, al::Socket src)

void	sendRemoveMessage (ParameterSpaceDimension dim, al::Socket dst, al::Socket *src=nullptr)

void	sendValueMessage (float value, std::string fullAddress, al::ValueSource *src=nullptr)

void	sendValueMessage (bool value, std::string fullAddress, al::ValueSource *src=nullptr)

void	sendValueMessage (int32_t value, std::string fullAddress, al::ValueSource *src=nullptr)

void	sendValueMessage (uint64_t value, std::string fullAddress, al::ValueSource *src=nullptr)

void	sendValueMessage (std::string value, std::string fullAddress, al::ValueSource *src=nullptr)

void	sendValueMessage (al::Vec3f value, std::string fullAddress, al::ValueSource *src=nullptr)

void	sendValueMessage (al::Vec4f value, std::string fullAddress, al::ValueSource *src=nullptr)

void	sendValueMessage (al::Color value, std::string fullAddress, al::ValueSource *src=nullptr)

void	sendValueMessage (al::Pose value, std::string fullAddress, al::ValueSource *src=nullptr)

bool	readPingMessage (int objectType, void any, al::Socket src)

bool	readCommandMessage (int objectType, void any, al::Socket src)

bool	sendCommandErrorMessage (uint64_t commandId, std::string objectId, std::string errorMessage, al::Socket *src)

bool	processCommandParameter (void any, al::Socket src)

bool	processCommandParameterSpace (void any, al::Socket src)

bool	processCommandDiskBuffer (void any, al::Socket src)

bool	processCommandDataPool (void any, al::Socket src)

bool	sendProtobufMessage (void message, al::Socket dst)

std::string	mapFromRemotePath (std::string path, al::Socket *src)

std::string	mapToRemotePath (std::string path, al::Socket *src)

Protected Attributes
std::vector< ParameterSpaceDimension * >	mParameterSpaceDimensions

std::vector< ParameterSpace * >	mParameterSpaces

std::vector< Processor * >	mProcessors

std::vector< DiskBufferAbstract * >	mDiskBuffers

std::vector< DataPool * >	mDataPools

std::vector< std::shared_ptr< ParameterSpaceDimension > >	mLocalPSDs

std::vector< std::shared_ptr< ParameterSpace > >	mLocalPSs

std::vector< std::shared_ptr< DiskBufferAbstract > >	mLocalDBs

std::vector< std::shared_ptr< DataPool > >	mLocalDPs

int	barrierWaitGranularTimeMs = 20

std::mutex	mBusyCountLock

uint32_t	mBusyCount = 0

std::map< std::string, std::vector< std::pair< std::string, std::string > > >	mRootPathMap

std::map< al::Socket *, std::string >	mClientHostnames

std::map< al::Socket *, std::vector< uint64_t > >	mPongsReceived

std::mutex	mPongLock

bool	mVerbose {false}

Detailed Description

The TincClient class.

A TincClient connects to a TincServer to share TINC objects.

Definition at line 55 of file TincClient.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

inherited

Enumerator
CREATE_DATA_SLICE

Definition at line 74 of file TincProtocol.hpp.

◆ Status

enum tinc::TincProtocol::Status

inherited

Enumerator
STATUS_UNKNOWN
STATUS_AVAILABLE
STATUS_BUSY

Definition at line 76 of file TincProtocol.hpp.

Constructor & Destructor Documentation

◆ TincClient()

tinc::TincClient::TincClient ( )

Member Function Documentation

◆ barrier()

bool tinc::TincClient::barrier	(	uint32_t	group = `0`,
		float	timeoutsec = `0.0`
	)

overridevirtual

Wait for lock, then wait for unlock.

Parameters

group	group to make the barrier for. 0 is all.
timeoutsec	timeout time im seconds

Returns: true if not timed out

Implements tinc::TincProtocol.

◆ connectDimensionCallbacks()

void tinc::TincProtocol::connectDimensionCallbacks ( ParameterSpaceDimension & psd )

protectedinherited

◆ connectParameterCallbacks()

void tinc::TincProtocol::connectParameterCallbacks ( al::ParameterMeta & param )

protectedinherited

◆ dimensions()

std::vector<ParameterSpaceDimension *> tinc::TincProtocol::dimensions ( )

inlineinherited

Definition at line 206 of file TincProtocol.hpp.

◆ getDataPool()

DataPool* tinc::TincProtocol::getDataPool ( std::string name )

inherited

◆ getDimension()

ParameterSpaceDimension* tinc::TincProtocol::getDimension	(	std::string	name,
		std::string	group = `""`
	)

inherited

get a registered dimension in this Tinc node

Parameters

name	name (id) of the dimension
group

Returns: a pointer to the dimension or nullptr if not found

If group is empty, the first matching name in any group is returned

It is recommended that you always call this function instead of storing the pointer, as the dimension might be free in some cases, for example if it was created by a network REGISTER command and then destroyed through a network REMOVE command.

◆ getDiskBuffer()

DiskBufferAbstract* tinc::TincProtocol::getDiskBuffer ( std::string name )

inherited

◆ getParameter()

al::ParameterMeta* tinc::TincProtocol::getParameter	(	std::string	name,
		std::string	group = `""`
	)

inherited

get a parameter from a registered dimension in this Tinc node

Parameters

name	name (id) of the parameter
group

Returns: a pointer to the parameter or nullptr if not found

If group is empty, the first matching name in any group is returned

It is recommended that you always call this function instead of storing the pointer, as the dimension might be free in some cases, for example if it was created by a network REGISTER command and then destroyed through a network REMOVE command.

◆ getParameterSpace()

ParameterSpace* tinc::TincProtocol::getParameterSpace ( std::string name )

inherited

◆ getRootPathMap()

const std::map<std::string, std::vector<std::pair<std::string, std::string> > > tinc::TincProtocol::getRootPathMap ( )

inlineinherited

Definition at line 255 of file TincProtocol.hpp.

◆ getStatus()

Status tinc::TincProtocol::getStatus ( )

inherited

◆ getWorkingPath()

std::string tinc::TincClient::getWorkingPath ( )

◆ mapFromRemotePath()

std::string tinc::TincProtocol::mapFromRemotePath	(	std::string	path,
		al::Socket *	src
	)

protectedinherited

◆ mapToRemotePath()

std::string tinc::TincProtocol::mapToRemotePath	(	std::string	path,
		al::Socket *	src
	)

protectedinherited

◆ markAvailable()

virtual void tinc::TincProtocol::markAvailable ( )

virtualinherited

Reimplemented in tinc::TincServer.

◆ markBusy()

virtual void tinc::TincProtocol::markBusy ( )

virtualinherited

Reimplemented in tinc::TincServer.

◆ operator<<() [1/6]

TincProtocol& tinc::TincProtocol::operator<< ( al::ParameterMeta & p )

inherited

◆ operator<<() [2/6]

TincProtocol& tinc::TincProtocol::operator<< ( DataPool & dp )

inherited

◆ operator<<() [3/6]

TincProtocol& tinc::TincProtocol::operator<< ( DiskBufferAbstract & db )

inherited

◆ operator<<() [4/6]

TincProtocol& tinc::TincProtocol::operator<< ( ParameterSpace & p )

inherited

◆ operator<<() [5/6]

TincProtocol& tinc::TincProtocol::operator<< ( ParameterSpaceDimension & psd )

inherited

◆ operator<<() [6/6]

TincProtocol& tinc::TincProtocol::operator<< ( Processor & p )

inherited

◆ parameterSpaces()

std::vector<ParameterSpace *> tinc::TincProtocol::parameterSpaces ( )

inlineinherited

Definition at line 213 of file TincProtocol.hpp.

◆ pingServer()

uint64_t tinc::TincClient::pingServer ( )

send a ping message to the tinc server

Returns: a number that identifies the ping

The server will return a pong message with the number recieved.

◆ print()

void tinc::TincProtocol::print ( std::ostream & stream = std::cout )

inherited

◆ processBarrierRequest()

void tinc::TincClient::processBarrierRequest	(	al::Socket *	src,
		uint64_t	barrierConsecutive
	)

protected

◆ processBarrierUnlock()

void tinc::TincClient::processBarrierUnlock	(	al::Socket *	src,
		uint64_t	barrierConsecutive
	)

protected

◆ processCommandDataPool()

bool tinc::TincProtocol::processCommandDataPool	(	void *	any,
		al::Socket *	src
	)

protectedinherited

◆ processCommandDiskBuffer()

bool tinc::TincProtocol::processCommandDiskBuffer	(	void *	any,
		al::Socket *	src
	)

protectedinherited

◆ processCommandParameter()

bool tinc::TincProtocol::processCommandParameter	(	void *	any,
		al::Socket *	src
	)

protectedinherited

◆ processCommandParameterSpace()

bool tinc::TincProtocol::processCommandParameterSpace	(	void *	any,
		al::Socket *	src
	)

protectedinherited

◆ processConfigureDataPool()

bool tinc::TincProtocol::processConfigureDataPool	(	void *	any,
		al::Socket *	src,
		bool	forward = `false`
	)

protectedinherited

◆ processConfigureDiskBuffer()

bool tinc::TincProtocol::processConfigureDiskBuffer	(	void *	any,
		al::Socket *	src,
		bool	forward = `false`
	)

protectedinherited

◆ processConfigureParameter()

bool tinc::TincProtocol::processConfigureParameter	(	void *	any,
		al::Socket *	src,
		bool	forward = `false`
	)

protectedinherited

◆ processConfigureParameterMessage()

bool tinc::TincProtocol::processConfigureParameterMessage	(	void *	conf,
		ParameterSpaceDimension *	dim,
		al::Socket *	src,
		bool	forward = `false`
	)

protectedinherited

◆ processConfigureParameterSpace()

bool tinc::TincProtocol::processConfigureParameterSpace	(	void *	any,
		al::Socket *	src,
		bool	forward = `false`
	)

protectedinherited

◆ processConfigureProcessor()

bool tinc::TincProtocol::processConfigureProcessor	(	void *	any,
		al::Socket *	src,
		bool	forward = `false`
	)

protectedinherited

◆ processIncomingMessage()

bool tinc::TincClient::processIncomingMessage	(	al::Message &	message,
		al::Socket *	src
	)

overrideprotected

◆ processRegisterDataPool()

bool tinc::TincProtocol::processRegisterDataPool	(	void *	any,
		al::Socket *	src,
		bool	forward = `false`
	)

protectedinherited

◆ processRegisterDiskBuffer()

bool tinc::TincProtocol::processRegisterDiskBuffer	(	void *	any,
		al::Socket *	src,
		bool	forward = `false`
	)

protectedinherited

◆ processRegisterParameter()

bool tinc::TincProtocol::processRegisterParameter	(	void *	any,
		al::Socket *	src,
		bool	forward = `false`
	)

protectedinherited

◆ processRegisterParameterSpace()

bool tinc::TincProtocol::processRegisterParameterSpace	(	void *	any,
		al::Socket *	src,
		bool	forward = `false`
	)

protectedinherited

◆ processRegisterProcessor()

bool tinc::TincProtocol::processRegisterProcessor	(	void *	any,
		al::Socket *	src,
		bool	forward = `false`
	)

protectedinherited

◆ processRemoveParameter()

bool tinc::TincProtocol::processRemoveParameter	(	void *	any,
		al::Socket *	src
	)

protectedinherited

◆ processRequestDataPools()

void tinc::TincProtocol::processRequestDataPools ( al::Socket * dst )

protectedinherited

◆ processRequestDiskBuffers()

void tinc::TincProtocol::processRequestDiskBuffers ( al::Socket * dst )

protectedinherited

◆ processRequestParameters()

void tinc::TincProtocol::processRequestParameters ( al::Socket * dst )

protectedinherited

◆ processRequestParameterSpaces()

void tinc::TincProtocol::processRequestParameterSpaces ( al::Socket * dst )

protectedinherited

◆ processRequestProcessors()

void tinc::TincProtocol::processRequestProcessors ( al::Socket * dst )

protectedinherited

◆ processStatusMessage()

void tinc::TincClient::processStatusMessage ( void * message )

protected

◆ processWorkingPathMessage()

void tinc::TincClient::processWorkingPathMessage ( void * message )

protected

◆ readCommandMessage()

bool tinc::TincProtocol::readCommandMessage	(	int	objectType,
		void *	any,
		al::Socket *	src
	)

protectedinherited

◆ readConfigureMessage()

bool tinc::TincProtocol::readConfigureMessage	(	int	objectType,
		void *	any,
		al::Socket *	src,
		bool	forward = `false`
	)

protectedinherited

◆ readPingMessage()

bool tinc::TincProtocol::readPingMessage	(	int	objectType,
		void *	any,
		al::Socket *	src
	)

protectedinherited

◆ readRegisterMessage()

bool tinc::TincProtocol::readRegisterMessage	(	int	objectType,
		void *	any,
		al::Socket *	src,
		bool	forward = `false`
	)

protectedinherited

◆ readRemoveMessage()

bool tinc::TincProtocol::readRemoveMessage	(	int	objectType,
		void *	any,
		al::Socket *	src
	)

protectedinherited

◆ readRequestMessage()

void tinc::TincProtocol::readRequestMessage	(	int	objectType,
		std::string	objectId,
		al::Socket *	src
	)

protectedinherited

◆ registerDataPool()

bool tinc::TincProtocol::registerDataPool	(	DataPool &	dp,
		al::Socket *	src = `nullptr`
	)

inherited

register a data pool with this Tinc node

Parameters

dp	the data pool to register
src	the source socket of the request

If src is not nullptr, network notification of registration will be blocked for that destination.

◆ registerDiskBuffer()

bool tinc::TincProtocol::registerDiskBuffer	(	DiskBufferAbstract &	db,
		al::Socket *	src = `nullptr`
	)

inherited

register a disk buffer with this Tinc node

Parameters

db	the disk buffer to register
src	the source socket of the request

If src is not nullptr, network notification of registration will be blocked for that destination.

◆ registerParameter()

bool tinc::TincProtocol::registerParameter	(	al::ParameterMeta &	param,
		al::Socket *	src = `nullptr`
	)

inherited

register a parameter with this Tinc node

Parameters

param	the parameter to register
src	the source socket of the request

Returns: true if successfully registered

If src is not nullptr, network notification of registration will be blocked for that destination. This is equivalent to registerParameterSpaceDimension() and will internally wrap the parameter in a dimension. TincClient does not take ownership of the param object, and does not free it when destroyed.

◆ registerParameterSpace()

bool tinc::TincProtocol::registerParameterSpace	(	ParameterSpace &	ps,
		al::Socket *	src = `nullptr`
	)

inherited

register a parameter space with this Tinc node

Parameters

psd	the parameter space dimension to register
src	the source socket of the request

Returns: true if successfully registered

If src is not nullptr, network notification of registration will be blocked for that destination.

◆ registerParameterSpaceDimension()

bool tinc::TincProtocol::registerParameterSpaceDimension	(	ParameterSpaceDimension &	psd,
		al::Socket *	src = `nullptr`
	)

inherited

register a parameter space dimencion with this Tinc node

Parameters

ps	the parameter space to register
src	the source socket of the request

Returns: true if successfully registered dimension

If src is not nullptr, network notification of registration will be blocked for that destination. TincClient does not take ownership of the psd object, and does not free it when destroyed.

◆ registerProcessor()

bool tinc::TincProtocol::registerProcessor	(	Processor &	processor,
		al::Socket *	src = `nullptr`
	)

inherited

register a processor with this Tinc node

Parameters

processor	the processor to register
src	the source socket of the request

If src is not nullptr, network notification of registration will be blocked for that destination.

◆ removeDataPool()

void tinc::TincProtocol::removeDataPool	(	std::string	name,
		al::Socket *	src = `nullptr`
	)

inherited

◆ removeDiskbuffer()

void tinc::TincProtocol::removeDiskbuffer	(	std::string	name,
		al::Socket *	src = `nullptr`
	)

inherited

◆ removeParameter()

void tinc::TincProtocol::removeParameter	(	std::string	name,
		std::string	group = `""`,
		bool	invoked = `false`,
		al::Socket *	src = `nullptr`
	)

inherited

◆ removeParameterSpace()

void tinc::TincProtocol::removeParameterSpace	(	std::string	name,
		al::Socket *	src = `nullptr`
	)

inherited

◆ removeProcessor()

void tinc::TincProtocol::removeProcessor	(	std::string	name,
		al::Socket *	src = `nullptr`
	)

inherited

◆ requestDataPools() [1/2]

void tinc::TincClient::requestDataPools ( )

inline

◆ requestDataPools() [2/2]

void tinc::TincProtocol::requestDataPools ( al::Socket * dst )

inherited

◆ requestDiskBuffers() [1/2]

void tinc::TincClient::requestDiskBuffers ( )

inline

◆ requestDiskBuffers() [2/2]

void tinc::TincProtocol::requestDiskBuffers ( al::Socket * dst )

inherited

◆ requestParameters() [1/2]

void tinc::TincClient::requestParameters ( )

inline

◆ requestParameters() [2/2]

void tinc::TincProtocol::requestParameters ( al::Socket * dst )

inherited

◆ requestParameterSpaces() [1/2]

void tinc::TincClient::requestParameterSpaces ( )

inline

◆ requestParameterSpaces() [2/2]

void tinc::TincProtocol::requestParameterSpaces ( al::Socket * dst )

inherited

◆ requestProcessors() [1/2]

void tinc::TincClient::requestProcessors ( )

inline

◆ requestProcessors() [2/2]

void tinc::TincProtocol::requestProcessors ( al::Socket * dst )

inherited

◆ sendCommandErrorMessage()

bool tinc::TincProtocol::sendCommandErrorMessage	(	uint64_t	commandId,
		std::string	objectId,
		std::string	errorMessage,
		al::Socket *	src
	)

protectedinherited

◆ sendConfigureMessage() [1/5]

void tinc::TincProtocol::sendConfigureMessage	(	DataPool *	p,
		al::Socket *	dst,
		al::Socket *	src = `nullptr`
	)

protectedinherited

◆ sendConfigureMessage() [2/5]

void tinc::TincProtocol::sendConfigureMessage	(	DiskBufferAbstract *	p,
		al::Socket *	dst,
		al::Socket *	src = `nullptr`
	)

protectedinherited

◆ sendConfigureMessage() [3/5]

void tinc::TincProtocol::sendConfigureMessage	(	ParameterSpace *	ps,
		al::Socket *	dst,
		al::Socket *	src = `nullptr`
	)

protectedinherited

◆ sendConfigureMessage() [4/5]

void tinc::TincProtocol::sendConfigureMessage	(	ParameterSpaceDimension *	dim,
		al::Socket *	dst,
		al::Socket *	src = `nullptr`
	)

protectedinherited

◆ sendConfigureMessage() [5/5]

void tinc::TincProtocol::sendConfigureMessage	(	Processor *	p,
		al::Socket *	dst,
		al::Socket *	src = `nullptr`
	)

protectedinherited

◆ sendConfigureParameterSpaceAddDimension()

void tinc::TincProtocol::sendConfigureParameterSpaceAddDimension	(	ParameterSpace *	ps,
		ParameterSpaceDimension *	dim,
		al::Socket *	dst,
		al::Socket *	src = `nullptr`
	)

protectedinherited

◆ sendConfigureParameterSpaceRemoveDimension()

void tinc::TincProtocol::sendConfigureParameterSpaceRemoveDimension	(	ParameterSpace *	ps,
		ParameterSpaceDimension *	dim,
		al::Socket *	dst,
		al::Socket *	src = `nullptr`
	)

protectedinherited

◆ sendMetadata()

void tinc::TincClient::sendMetadata ( )

◆ sendProtobufMessage()

bool tinc::TincProtocol::sendProtobufMessage	(	void *	message,
		al::Socket *	dst
	)

protectedinherited

◆ sendRegisterMessage() [1/5]

void tinc::TincProtocol::sendRegisterMessage	(	DataPool *	p,
		al::Socket *	dst,
		al::Socket *	src = `nullptr`
	)

protectedinherited

◆ sendRegisterMessage() [2/5]

void tinc::TincProtocol::sendRegisterMessage	(	DiskBufferAbstract *	p,
		al::Socket *	dst,
		al::Socket *	src = `nullptr`
	)

protectedinherited

◆ sendRegisterMessage() [3/5]

void tinc::TincProtocol::sendRegisterMessage	(	ParameterSpace *	ps,
		al::Socket *	dst,
		al::Socket *	src = `nullptr`
	)

protectedinherited

◆ sendRegisterMessage() [4/5]

void tinc::TincProtocol::sendRegisterMessage	(	ParameterSpaceDimension *	dim,
		al::Socket *	dst,
		al::Socket *	src = `nullptr`
	)

protectedinherited

◆ sendRegisterMessage() [5/5]

void tinc::TincProtocol::sendRegisterMessage	(	Processor *	p,
		al::Socket *	dst,
		al::Socket *	src = `nullptr`
	)

protectedinherited

◆ sendRemoveMessage()

void tinc::TincProtocol::sendRemoveMessage	(	ParameterSpaceDimension *	dim,
		al::Socket *	dst,
		al::Socket *	src = `nullptr`
	)

protectedinherited

◆ sendTincMessage()

bool tinc::TincClient::sendTincMessage	(	void *	msg,
		al::Socket *	dst = `nullptr`,
		al::ValueSource *	src = `nullptr`
	)

overridevirtual

sendTincMessage

Parameters

msg	The encoded message to send
dst	the socket to send meessage to. If nullptr send to all
src	information of source. If passed block sending to this location.

Returns: true on succesful send.

Reimplemented from tinc::TincProtocol.

◆ sendValueMessage() [1/9]

void tinc::TincProtocol::sendValueMessage	(	al::Color	value,
		std::string	fullAddress,
		al::ValueSource *	src = `nullptr`
	)

protectedinherited

◆ sendValueMessage() [2/9]

void tinc::TincProtocol::sendValueMessage	(	al::Pose	value,
		std::string	fullAddress,
		al::ValueSource *	src = `nullptr`
	)

protectedinherited

◆ sendValueMessage() [3/9]

void tinc::TincProtocol::sendValueMessage	(	al::Vec3f	value,
		std::string	fullAddress,
		al::ValueSource *	src = `nullptr`
	)

protectedinherited

◆ sendValueMessage() [4/9]

void tinc::TincProtocol::sendValueMessage	(	al::Vec4f	value,
		std::string	fullAddress,
		al::ValueSource *	src = `nullptr`
	)

protectedinherited

◆ sendValueMessage() [5/9]

void tinc::TincProtocol::sendValueMessage	(	bool	value,
		std::string	fullAddress,
		al::ValueSource *	src = `nullptr`
	)

protectedinherited

◆ sendValueMessage() [6/9]

void tinc::TincProtocol::sendValueMessage	(	float	value,
		std::string	fullAddress,
		al::ValueSource *	src = `nullptr`
	)

protectedinherited

◆ sendValueMessage() [7/9]

void tinc::TincProtocol::sendValueMessage	(	int32_t	value,
		std::string	fullAddress,
		al::ValueSource *	src = `nullptr`
	)

protectedinherited

◆ sendValueMessage() [8/9]

void tinc::TincProtocol::sendValueMessage	(	std::string	value,
		std::string	fullAddress,
		al::ValueSource *	src = `nullptr`
	)

protectedinherited

◆ sendValueMessage() [9/9]

void tinc::TincProtocol::sendValueMessage	(	uint64_t	value,
		std::string	fullAddress,
		al::ValueSource *	src = `nullptr`
	)

protectedinherited

◆ serverStatus()

Status tinc::TincClient::serverStatus ( )

Return latest status reported by server.

◆ setRootMapEntry()

void tinc::TincProtocol::setRootMapEntry	(	std::string	serverPath,
		std::string	clientPath,
		std::string	host = `""`
	)

inlineinherited

setRootMapEntry

Parameters

serverPath
clientPath
host	This function is only generally useful if set for the server.

Definition at line 248 of file TincProtocol.hpp.

◆ setVerbose()

void tinc::TincClient::setVerbose ( bool verbose = true )

◆ start()

bool tinc::TincClient::start	(	uint16_t	serverPort = `34450`,
		const char *	serverAddr = `"localhost"`
	)

override

start the TINC client

Parameters

serverPort
serverAddr

Returns: true if connection was succesful

◆ stop()

void tinc::TincClient::stop ( )

override

stop the connection

Closes listening thread and cleans up connections.

Any state received from the server remains on the client, but any actions will not affect the server and will be overriden if reconnected.

◆ synchronize()

void tinc::TincClient::synchronize ( )

inline

◆ verbose()

bool tinc::TincClient::verbose ( )

inline

Definition at line 135 of file TincClient.hpp.

◆ waitForPong()

bool tinc::TincClient::waitForPong	(	uint64_t	pingCode,
		float	timeoutsec = `30`,
		al::Socket *	src = `nullptr`
	)

waitForPong

Parameters

pingCode
timeoutsec
src	Source of pong message (use nullptr for server)

Returns: true if pong was received before timeout

This function clears mPongsReceived for src if pong was received before time out.

◆ waitForServer()

bool tinc::TincClient::waitForServer ( float timeoutsec = 0.0 )

return only when server status is STATUS_AVAILABLE

Parameters

timeoutsec

Returns: false if timeout instead of STATUS_AVAILABLE

Member Data Documentation

◆ barrierWaitGranularTimeMs

int tinc::TincProtocol::barrierWaitGranularTimeMs = 20

protectedinherited

Definition at line 414 of file TincProtocol.hpp.

◆ mBusyCount

uint32_t tinc::TincProtocol::mBusyCount = 0

protectedinherited

Definition at line 417 of file TincProtocol.hpp.

◆ mBusyCountLock

std::mutex tinc::TincProtocol::mBusyCountLock

protectedinherited

Definition at line 416 of file TincProtocol.hpp.

◆ mClientHostnames

std::map<al::Socket *, std::string> tinc::TincProtocol::mClientHostnames

protectedinherited

Definition at line 422 of file TincProtocol.hpp.

◆ mDataPools

std::vector<DataPool *> tinc::TincProtocol::mDataPools

protectedinherited

Definition at line 405 of file TincProtocol.hpp.

◆ mDiskBuffers

std::vector<DiskBufferAbstract *> tinc::TincProtocol::mDiskBuffers

protectedinherited

Definition at line 404 of file TincProtocol.hpp.

◆ mLocalDBs

std::vector<std::shared_ptr<DiskBufferAbstract> > tinc::TincProtocol::mLocalDBs

protectedinherited

Definition at line 410 of file TincProtocol.hpp.

◆ mLocalDPs

std::vector<std::shared_ptr<DataPool> > tinc::TincProtocol::mLocalDPs

protectedinherited

Definition at line 411 of file TincProtocol.hpp.

◆ mLocalPSDs

std::vector<std::shared_ptr<ParameterSpaceDimension> > tinc::TincProtocol::mLocalPSDs

protectedinherited

Definition at line 408 of file TincProtocol.hpp.

◆ mLocalPSs

std::vector<std::shared_ptr<ParameterSpace> > tinc::TincProtocol::mLocalPSs

protectedinherited

Definition at line 409 of file TincProtocol.hpp.

◆ mParameterSpaceDimensions

std::vector<ParameterSpaceDimension *> tinc::TincProtocol::mParameterSpaceDimensions

protectedinherited

Definition at line 401 of file TincProtocol.hpp.

◆ mParameterSpaces

std::vector<ParameterSpace *> tinc::TincProtocol::mParameterSpaces

protectedinherited

Definition at line 402 of file TincProtocol.hpp.

◆ mPongLock

std::mutex tinc::TincProtocol::mPongLock

protectedinherited

Definition at line 426 of file TincProtocol.hpp.

◆ mPongsReceived

std::map<al::Socket *, std::vector<uint64_t> > tinc::TincProtocol::mPongsReceived

protectedinherited

Definition at line 425 of file TincProtocol.hpp.

◆ mProcessors

std::vector<Processor *> tinc::TincProtocol::mProcessors

protectedinherited

Definition at line 403 of file TincProtocol.hpp.

◆ mRootPathMap

std::map<std::string, std::vector<std::pair<std::string, std::string> > > tinc::TincProtocol::mRootPathMap

protectedinherited

Definition at line 421 of file TincProtocol.hpp.

◆ mVerbose

bool tinc::TincProtocol::mVerbose {false}

protectedinherited

Definition at line 428 of file TincProtocol.hpp.

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

C:/Users/Andres/source/repos/casm_viewer/external/tinc/include/tinc/TincClient.hpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ Status

Constructor & Destructor Documentation

◆ TincClient()

Member Function Documentation

◆ barrier()

◆ connectDimensionCallbacks()

◆ connectParameterCallbacks()

◆ dimensions()

◆ getDataPool()

◆ getDimension()

◆ getDiskBuffer()

◆ getParameter()

◆ getParameterSpace()

◆ getRootPathMap()

◆ getStatus()

◆ getWorkingPath()

◆ mapFromRemotePath()

◆ mapToRemotePath()

◆ markAvailable()

◆ markBusy()

◆ operator<<() [1/6]

◆ operator<<() [2/6]

◆ operator<<() [3/6]

◆ operator<<() [4/6]

◆ operator<<() [5/6]

◆ operator<<() [6/6]

◆ parameterSpaces()

◆ pingServer()

◆ print()

◆ processBarrierRequest()

◆ processBarrierUnlock()

◆ processCommandDataPool()

◆ processCommandDiskBuffer()

◆ processCommandParameter()

◆ processCommandParameterSpace()

◆ processConfigureDataPool()

◆ processConfigureDiskBuffer()

◆ processConfigureParameter()

◆ processConfigureParameterMessage()

◆ processConfigureParameterSpace()

◆ processConfigureProcessor()

◆ processIncomingMessage()

◆ processRegisterDataPool()

◆ processRegisterDiskBuffer()

◆ processRegisterParameter()

◆ processRegisterParameterSpace()

◆ processRegisterProcessor()

◆ processRemoveParameter()

◆ processRequestDataPools()

◆ processRequestDiskBuffers()

◆ processRequestParameters()

◆ processRequestParameterSpaces()

◆ processRequestProcessors()

◆ processStatusMessage()

◆ processWorkingPathMessage()

◆ readCommandMessage()

◆ readConfigureMessage()

◆ readPingMessage()

◆ readRegisterMessage()

◆ readRemoveMessage()

◆ readRequestMessage()

◆ registerDataPool()

◆ registerDiskBuffer()

◆ registerParameter()

◆ registerParameterSpace()

◆ registerParameterSpaceDimension()

◆ registerProcessor()

◆ removeDataPool()

◆ removeDiskbuffer()

◆ removeParameter()

◆ removeParameterSpace()

◆ removeProcessor()

◆ requestDataPools() [1/2]