Defines

vnc_init¶

Initializes the SDK with the default vnc_EventLoopType for the platform.

Only call functions in vnc/DataStore.h or vnc/Logger.h before you call this function.

Return

vnc_success or vnc_failure, in which case call vnc_getLastError() to get the error code.

Return Value

• VersionError -

  majorVersion or minorVersion do not match the run-time version.

vnc_initWithLoopType(eventLoopType)¶

Initializes the SDK, as for vnc_init().

This is used in the case where the default event loop type is not desired, for example to create a file-descriptor event loop on OS X for the purpose of integrating with a third-party event loop such as Qt.

Enums

enum vnc_EventLoopType¶

Enumeration of types of event loop used by the SDK.

Values:

vnc_EventLoopType_Default = 0¶

The default event loop is a Windows event loop on Windows, a file-descriptor event loop on Linux, a Core Foundation event loop on OS X and iOS, and an Android event loop on Android.

There is no event loop in HTML5.

vnc_EventLoopType_Win¶

The Windows event loop is only available on Windows.

vnc_EventLoopType_Fd¶

The file-descriptor event loop is available on Linux, OS X, iOS, and Android.

vnc_EventLoopType_Cf¶

The Core Foundation event loop is available on OS X and iOS.

vnc_EventLoopType_Android¶

The Android “Looper” event loop is only available on Android.

Functions

vnc_status_t vnc_shutdown(void)¶

Shuts down the SDK, ensuring that any resources are cleared up.

It is necessary to call this function prior to unloading the DLL, if the SDK’s thread has not yet exited.

When called via certain bindings, the SDK DLL may additionally be unloaded.

This function should be called on the thread that called vnc_init(); or, if called on another thread, the SDK thread must have already exited. It is not legal to call this from within any SDK callback. No other SDK functions may be called after vnc_shutdown().