Corelink::DLLInit Class Reference

#include <CorelinkClasses.h>

Static Public Member Functions
static void	Init ()
static int	getInitState ()
static void	setInitState (int state)
static std::string	getLocalCertPath ()
static void	setLocalCertPath (const char *path, int len)
static void	setLocalCertPath (const std::string &path)
static std::string	getServerCertPath ()
static void	setServerCertPath (const char *path, int len)
static void	setServerCertPath (const std::string &path)
static void	setServerCredentials (const std::string &username, const std::string &password)
static void	setOnDrop (void(*func)(const STREAM_ID &))
static void	setOnStale (void(*func)(const STREAM_ID &))
static void	setOnSubscribe (void(*func)(const STREAM_ID &, const STREAM_ID &))
static void	setOnUpdate (void(*func)(const STREAM_ID &, const STREAM_ID &))

Detailed Description

Definition at line 52 of file CorelinkClasses.h.

Member Function Documentation

getInitState()

int Corelink::DLLInit::getInitState ( )

inlinestatic

Gets the state for components the client will initialize with.

Returns

Currently assigned state value.

Definition at line 22 of file CorelinkInit.h.

getLocalCertPath()

std::string Corelink::DLLInit::getLocalCertPath ( )

inlinestatic

Gets the certificate path for the local server.

Returns

Local certificate path.

Definition at line 32 of file CorelinkInit.h.

getServerCertPath()

std::string Corelink::DLLInit::getServerCertPath ( )

inlinestatic

Gets the certificate path for the server.

Returns

Server certificate path.

Definition at line 60 of file CorelinkInit.h.

Init()

void Corelink::DLLInit::Init ( )

inlinestatic

Initializes DLL.

Definition at line 14 of file CorelinkInit.h.

setInitState()

void Corelink::DLLInit::setInitState ( int  state )

inlinestatic

Sets the state for components the client will initialize with.

Parameters

state

State determining which components to use.

Exceptions

ERROR_CODE_VALUE

if state value is invalid.

Definition at line 26 of file CorelinkInit.h.

setLocalCertPath() [1/2]

void Corelink::DLLInit::setLocalCertPath ( const char *  path, int  len  )

inlinestatic

Sets the local server certificate path.

Parameters

path	New path value.
len	Length of the path to copy.

Definition at line 52 of file CorelinkInit.h.

setLocalCertPath() [2/2]

void Corelink::DLLInit::setLocalCertPath ( const std::string &  path )

inlinestatic

Sets the local server certificate path.

Parameters

path	New path value.

Definition at line 56 of file CorelinkInit.h.

setOnDrop()

void Corelink::DLLInit::setOnDrop ( void(*)(const STREAM_ID &)  func )

inlinestatic

Sets the callback for the drop function (subscriber listening to client stream destroyed). Assume that the receiver is already discarded from the client and server when called. May be called multiple times consecutively.
DataOrder:
-const int& sender streamid.

Definition at line 92 of file CorelinkInit.h.

setOnStale()

void Corelink::DLLInit::setOnStale ( void(*)(const STREAM_ID &)  func )

inlinestatic

Sets the callback for the stale function. Assume that the stream is already discarded from the client and server when called. May be called multiple times consecutively.
DataOrder:
-const int& receiver streamid.

Definition at line 96 of file CorelinkInit.h.

setOnSubscribe()

void Corelink::DLLInit::setOnSubscribe ( void(*)(const STREAM_ID &, const STREAM_ID &)  func )

inlinestatic

Sets the callback for the subscribe function (new subscriber listening to client sender). May be called multiple times consecutively if client has multiple senders.
DataOrder:
-const int& senderID.
-const int& receiver stream. May be replaced with StreamData in future update.

Definition at line 100 of file CorelinkInit.h.

setOnUpdate()

void Corelink::DLLInit::setOnUpdate ( void(*)(const STREAM_ID &, const STREAM_ID &)  func )

inlinestatic

Sets the callback for the update function (new sender stream that client can listen to). May be called multiple times consecutively if client has multiple receiver.
DataOrder:
-const int& receiverID.
-const int& sender stream. May be replaced with StreamData in future update.

Definition at line 104 of file CorelinkInit.h.

setServerCertPath() [1/2]

void Corelink::DLLInit::setServerCertPath ( const char *  path, int  len  )

inlinestatic

Sets the server certificate path.

Parameters

path	New path value.
len	Length of the path to copy.

Definition at line 80 of file CorelinkInit.h.

setServerCertPath() [2/2]

void Corelink::DLLInit::setServerCertPath ( const std::string &  path )

inlinestatic

Sets the server certificate path.

Parameters

path	New path value.

Definition at line 84 of file CorelinkInit.h.

setServerCredentials()

void Corelink::DLLInit::setServerCredentials ( const std::string &  username, const std::string &  password  )

inlinestatic

Sets the Corelink server login credentials.

Parameters

username	Corelink username credentials.
password	Corelink password credentials.

Definition at line 88 of file CorelinkInit.h.

---

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

• clients/cpp/CorelinkClasses.h
• clients/cpp/CorelinkInit.h