class flake::Connection

More...

#include <Connection.h>

Inherits from flake::ConnectedObject, flake::IndicationSink, flake::ConfirmationSink

Public Functions

	Name
virtual int	connect(AuthenticationSink * authentication_sink) =0
virtual int	connect(PropArray & props) =0
virtual void	disconnect() =0 Disconnect from the router.
virtual bool	connected() =0
virtual int8_t	registerService(Service * srv, uniqueId_t & uuid, bool requires_auth =false) =0
virtual int8_t	createObject(uniqueId_t & objectType, PropArray & properties, Object ** object) =0
virtual void	queryObjects(uniqueId_t type, int * numObjects, Object ** objects[]) =0

Protected Functions

	Name
	~Connection() =default

Additional inherited members

Public Functions inherited from flake::ConnectedObject

	Name
virtual addr_t	addr() const =0
virtual addr_t	broadcastAddr() const =0
virtual void	ref() =0
virtual void	unref() =0

Protected Functions inherited from flake::ConnectedObject

	Name
	~ConnectedObject() =default

Public Attributes inherited from flake::ConnectedObject

	Name
const addr_t	EMPTY_ADDR

Public Functions inherited from flake::IndicationSink

	Name
virtual void	onIndication(Indication & indication) =0

Protected Functions inherited from flake::IndicationSink

	Name
	~IndicationSink() =default

Public Functions inherited from flake::ConfirmationSink

	Name
virtual void	onConfirmation(Confirmation & confirmation) =0

Protected Functions inherited from flake::ConfirmationSink

	Name
	~ConfirmationSink() =default

Detailed Description

class flake::Connection;

Document me

Public Functions Documentation

function connect

virtual int connect(
    AuthenticationSink * authentication_sink
) =0

Return: E_OK if the connection has been established or an error if it failed

Establish a connection to the router

function connect

virtual int connect(
    PropArray & props
) =0

function disconnect

virtual void disconnect() =0

Disconnect from the router.

function connected

virtual bool connected() =0

function registerService

virtual int8_t registerService(
    Service * srv,
    uniqueId_t & uuid,
    bool requires_auth =false
) =0

function createObject

virtual int8_t createObject(
    uniqueId_t & objectType,
    PropArray & properties,
    Object ** object
) =0

function queryObjects

virtual void queryObjects(
    uniqueId_t type,
    int * numObjects,
    Object ** objects[]
) =0

Parameters:

• type the type of the service (the service-class)
• numObjects number of found objects
• objects array of objects

Queries the router for exisiting service-objects. it is important to call 'unref()' on any returned object, that the caller doesn't want to use

Protected Functions Documentation

function ~Connection

~Connection() =default

---