Coldwave Documentation

Appearance

class flake::Connection ​

More...

#include <Connection.h>

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
Connect to the router.
virtual [int]registerObject(ObjectDelegate * srv, [uniqueId_t] & uuid, [bool] requires_auth =[false]) =0
virtual [int]queryObjects([uniqueId_t] type, Object ** objects, [int] maxCount) =0
virtual [uint16_t]getMTU() const =0
virtual ConnectionImpl *impl() =0

Protected Functions ​

Name
virtual~Connection() =default

Detailed Description ​

cpp
class flake::Connection;

Document me

Public Functions Documentation ​

function connect ​

cpp
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 ​

cpp
virtual int connect(
    PropArray & props
) =0

function disconnect ​

cpp
virtual void disconnect() =0

Disconnect from the router.

function connected ​

cpp
virtual bool connected() =0

Connect to the router.

function registerObject ​

cpp
virtual int registerObject(
    ObjectDelegate * srv,
    uniqueId_t & uuid,
    bool requires_auth =false
) =0

Parameters:

  • srv
  • uuid
  • requires_auth

Return:

function queryObjects ​

cpp
virtual int queryObjects(
    uniqueId_t type,
    Object ** objects,
    int maxCount
) =0

Parameters:

  • type the type of the service (the service-class)
  • objects array of objects, allocated by the caller
  • maxCount max number of objects in the buffer

Return: total number of objects

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

function getMTU ​

cpp
virtual uint16_t getMTU() const =0

Return:

function impl ​

cpp
virtual ConnectionImpl * impl() =0

Protected Functions Documentation ​

function ~Connection ​

cpp
virtual ~Connection() =default