Learn how to evaluate and integrate the VNC SDK

We're here if you need help.

Server.h

Creates a VNC-compatible Server app for a computer you want to control. (more...)

Data structures

Modifier and Type Name and Description
struct

vnc_Server_ConnectionCallback

Callback receiving connection-related notifications for a Server.

struct

vnc_Server_SecurityCallback

Callback receiving security-related notifications for a Server.

struct

vnc_Server_AgentCallback

Callback receiving agent-related notifications for a Server.

Enums

Modifier and Type Name and Description
enum

vnc_Server_CaptureMethod

Enumeration of screen capture methods.

enum

vnc_Server_Permissions

Enumeration of session permissions that can be granted to a connecting Viewer.

enum

vnc_Server_DisconnectFlags

Enumeration of disconnection flags.

enum

vnc_Server_EncryptionLevel

Enumeration of encryption levels.

Functions

Modifier and Type Name and Description
function vnc_Server *

vnc_Server_create(const char *agentPath)

Creates a Server.

function vnc_Server *

vnc_Server_createService(const char *agentPath)

Creates a Server running as a service.

function void

vnc_Server_destroy(vnc_Server *server)

Destroys the Server.

function vnc_status_t

vnc_Server_setConnectionCallback(vnc_Server *server, const vnc_Server_ConnectionCallback *callback, void *userData)

Sets connection-related callbacks for the Server.

function int

vnc_Server_getConnectionCount(vnc_Server *server)

Returns the total number of Viewers currently connected to the Server.

function vnc_status_t

vnc_Server_setSecurityCallback(vnc_Server *server, const vnc_Server_SecurityCallback *callback, void *userData)

Sets security-related callbacks for the Server.

function vnc_status_t

vnc_Server_setPermissions(vnc_Server *server, vnc_Connection *connection, int perms)

Changes permissions for a Viewer mid-session.

function int

vnc_Server_getPermissions(vnc_Server *server, vnc_Connection *connection)

Gets the set of current permissions for a Viewer.

function vnc_status_t

vnc_Server_setAgentCallback(vnc_Server *server, const vnc_Server_AgentCallback *callback, void *userData)

Sets agent-related callbacks for the Server.

function vnc_bool_t

vnc_Server_isAgentReady(vnc_Server *server)

Determines if the vncagent process is ready and available to capture the display and inject input events.

function void

vnc_Server_setFriendlyName(vnc_Server *server, const char *name)

Specifies a friendly name for the Server, to send to connected Viewers.

function vnc_ConnectionHandler *

vnc_Server_getConnectionHandler(vnc_Server *server)

Obtains the Server’s vnc_ConnectionHandler for performing connection operations.

function vnc_status_t

vnc_Server_setCaptureMethod(vnc_Server *server, vnc_Server_CaptureMethod captureMethod)

Specifies the screen capture method used by the Server.

function const char *

vnc_Server_getPeerAddress(vnc_Server *server, vnc_Connection *connection)

Returns the address of a particular connected Viewer.

function void

vnc_Server_disconnect(vnc_Server *server, vnc_Connection *connection, const char *message, int flags)

Disconnects a particular Viewer, optionally specifying a message.

function void

vnc_Server_disconnectAll(vnc_Server *server, const char *message, int flags)

Disconnects all Viewers, optionally specifying a message.

function vnc_status_t

vnc_Server_setBlacklist(vnc_Server *server, int threshold, int timeout)

Specifies a blacklist threshold and timeout for the Server.

function void

vnc_Server_serviceControlHandlerEx(vnc_Server *server, int dwControl, int dwEventType, void *lpEventData)

Handles a Windows Service control event.

function vnc_AnnotationManager *

vnc_Server_getAnnotationManager(vnc_Server *server)

Obtains the Server’s vnc_AnnotationManager for handling annotation operations.

function vnc_MessagingManager *

vnc_Server_getMessagingManager(vnc_Server *server)

Obtains the Server’s vnc_MessagingManager for handling messaging.

function vnc_DisplayManager *

vnc_Server_getDisplayManager(vnc_Server *server)

Obtains the Server’s vnc_DisplayManager, for managing the list of displays made available by the Server.

function vnc_status_t

vnc_Server_setEncryptionLevel(vnc_Server *server, vnc_Server_EncryptionLevel level)

Sets the desired encryption level of the session from the range of options enumerated by vnc_Server_EncryptionLevel.

function vnc_Server_EncryptionLevel

vnc_Server_getEncryptionLevel(vnc_Server *server, vnc_Connection *connection)

Returns the encryption level being used with an incoming connection, or the Server’s current encryption level if the connection is NULL.

function vnc_status_t

vnc_Server_setIdleTimeout(vnc_Server *server, int idleTimeout)

Sets the number of seconds to wait before disconnecting idle Viewers.

function int

vnc_Server_getIdleTimeout(vnc_Server *server)

Gets the current number of seconds to wait before disconnecting idle Viewers.

Detailed description

Creates a VNC-compatible Server app for a computer you want to control.

Capturing the device screen and injecting input is handled by vncagent, an executable provided with the SDK. You must bundle this executable with your Server; you can find it in the <vnc-sdk>/libs/<architecture> directory.

There are two ways in which a Server can operate: as a regular application, following a normal application lifecycle (i.e. exiting when the user logs out of the desktop session); or as a service, which can continue running across sessions and at the login screen. In either case, the SDK must first be initialized with a call to vnc_init().

To create a Server as a regular application, use vnc_Server_create(), and for a service, use vnc_Server_createService(). In either case, you can optionally specify a path to (or a new file name for) vncagent. Note you must also call one of the methods in DataStore.h to enable the Server to persist the automatically-generated RSA public/private key pair and other important information, and you can optionally call a method in Logger.h to set up logging. Note that methods in DataStore.h and Logger.h may be called before calling vnc_init().

Next, populate a vnc_Server_SecurityCallback structure with functions used to verify credentials presented by a connecting Viewer, and pass it into a call to vnc_Server_setSecurityCallback().

Typically, a Server joins VNC Cloud and listens for incoming connections from one or more Viewers. To start your Server listening, call vnc_Server_getConnectionHandler() to obtain a vnc_ConnectionHandler, and pass that into a call to vnc_CloudListener_create() along with a listen Cloud address and password.

(Note that you can reverse this methodology and have your Server connect to listening Viewers if you wish. To see how to do this, see Viewer.h.)

When a new viewer connection arrives at the server, any defined vnc_Server_SecurityCallback::verifyPeer callback will be called to allow the peer’s identity to be verified (in addition to the verification already carried out by VNC Cloud). Next, vnc_Server_SecurityCallback::isUserNameRequired and vnc_Server_SecurityCallback::isPasswordRequired will be called to determine what type of authentication credentials the viewer should be prompted for. Once the viewer provides credentials, vnc_Server_SecurityCallback::authenticateUser is called to allow the credentials to be verified, and appropriate vnc_Server_Permissions granted for the connection.

Note that by default a Viewer consistently failing to authenticate is blacklisted to guard against brute-force and dictionary attacks; call vnc_Server_setBlacklist() to configure frequency and timeouts.

Once authenticated, any defined vnc_Server_ConnectionCallback::connectionStarted callback is called, and the server starts remoting the display, and injecting input events received from the client. Text copied to the clipboard on the device is sent to the viewer, and any clipboard text sent by the viewer is made available to applications on the device’s clipboard (assuming the vnc_Server_PermClipboard permission has been granted).

The connection will end if vnc_Server_disconnect() or vnc_Server_disconnectAll() is called, or may end due to an action on the Viewer, or due to some other event such as a network failure. When the connection ends, the vnc_Server_ConnectionCallback::connectionEnded callback will be called.

To stop your Server listening and disconnect from VNC Cloud, call vnc_CloudListener_destroy(). To destroy your Server, call vnc_Server_destroy().

To make sure the SDK is shutdown and any resources are cleaned up, call vnc_shutdown().

Enums

enum vnc_Server_CaptureMethod

Enumeration of screen capture methods.

See
vnc_Server_setCaptureMethod()

Values:

vnc_Server_CaptureOptimal = 0

Use the optimal capture method for the platform.

This is the default.

vnc_Server_CaptureFallback

Use a fallback capture method under Windows and Linux.

This is likely to be slower, but may solve rendering glitches with certain third-party applications. Not supported under Mac OS X.

enum vnc_Server_Permissions

Enumeration of session permissions that can be granted to a connecting Viewer.

(Flags can be combined into a mask.)

See
vnc_Server_SecurityCallback::authenticateUser

Values:

vnc_Server_PermView = 0x01

Grants a Viewer permission to see the screen.

Rarely omitted.

vnc_Server_PermKeyboard = 0x02

Grants a Viewer permission to inject keyboard events.

vnc_Server_PermPointer = 0x04

Grants a Viewer permission to inject mouse and touch events.

vnc_Server_PermClipboard = 0x08

Grants a Viewer permission to copy and paste text to and from the Server.

vnc_Server_PermAnnotation = 0x10

Grants a Viewer permission to draw on the Server screen.

vnc_Server_PermAll = 0x7fffffff

Grants a Viewer a full set of permissions (that is, all of the above).

enum vnc_Server_DisconnectFlags

Enumeration of disconnection flags.

See
vnc_Server_disconnect(), vnc_Server_disconnectAll()
Since
1.1

Values:

vnc_Server_DisconnectAlert = 1

The disconnection message is deemed to be sufficiently important that the Viewer should alert the Viewer user.

vnc_Server_DisconnectReconnect = 2

Set the peer’s vnc_Viewer_CanReconnect flag, that is, the Server informs the Viewer that the server may start again soon.

enum vnc_Server_EncryptionLevel

Enumeration of encryption levels.

See
vnc_Server_setEncryptionLevel()

Values:

vnc_Server_EncryptionLevel_Default = 0

Use strong encryption.

This is the default.

vnc_Server_EncryptionLevel_Maximum

Use the strongest available encryption, possibly at the cost of speed.

Functions

vnc_Server *vnc_Server_create(const char *agentPath)

Creates a Server.

Note only one vnc_Server should exist in your application at a time.

The Server captures the current session, which may be switched-out or otherwise not visible on the console.

Return
A new vnc_Server or NULL on error, in which case call vnc_getLastError() to get the error code.
See
Use vnc_Server_createService() to create a Server which captures the console.
Parameters
  • agentPath -

    The full path to the vncagent executable, or NULL to specify that vncagent is in the same directory as the app binary at run-time. If you provide a directory, the executable must be called vncagent (vncagent.exe on Windows); if you have renamed vncagent then the filename must be provided.

Return Value
  • FileError -

    vncagent could not be found, or the file specified does not exist

  • AgentError -

    vncagent cannot be executed or its version number does not match that of the SDK

  • UnexpectedCall -

    A vnc_Server already exists in your application

vnc_Server *vnc_Server_createService(const char *agentPath)

Creates a Server running as a service.

Note only one vnc_Server should exist in your application at a time.

The Server captures the machine’s console, which may be a logged-in user session or a login prompt. Running as a service requires elevated privileges, and must be done from a Windows Service (Windows), a launch daemon (Mac), or a root process (Linux).

On Windows, the vncagent executable must be located within either the %ProgramFiles% or %ProgramFiles(x86)% directories in order to allow the injection of secure key sequences (e.g. Ctrl-Alt-Del).

On Mac OS X, an instance of vncagent must separately be run in each graphical session as a launch agent. The agentPath provided here must match the path of these launch agents in order that the SDK can communicate with them.

Return
A new vnc_Server or NULL on error, in which case call vnc_getLastError() to get the error code.
See
Use vnc_Server_create() to create a Server which captures the current session.
Since
1.1
Parameters
Return Value
  • AgentError -

    vncagent cannot be found or its version number does not match that of the SDK

  • UnexpectedCall -

    A vnc_Server already exists in your application

void vnc_Server_destroy(vnc_Server *server)

Destroys the Server.

Any Viewers still connected will be disconnected, and the peer’s vnc_Viewer_CanReconnect flag will be set, indicating that server may start again soon. If this is not desired, call vnc_Server_disconnectAll() without the vnc_Server_DisconnectReconnect flag before destroying the Server.

Parameters
  • server -

    The current Server.

vnc_status_t vnc_Server_setConnectionCallback(vnc_Server *server, const vnc_Server_ConnectionCallback *callback, void *userData)

Sets connection-related callbacks for the Server.

Return
vnc_true
Parameters
  • server -

    The current Server.

  • callback -

    The new connection event callback.

int vnc_Server_getConnectionCount(vnc_Server *server)

Returns the total number of Viewers currently connected to the Server.

Since
1.1

vnc_status_t vnc_Server_setSecurityCallback(vnc_Server *server, const vnc_Server_SecurityCallback *callback, void *userData)

Sets security-related callbacks for the Server.

Return
vnc_true
Parameters
  • server -

    The current Server.

  • callback -

    The new security event callback.

vnc_status_t vnc_Server_setPermissions(vnc_Server *server, vnc_Connection *connection, int perms)

Changes permissions for a Viewer mid-session.

Return
vnc_success or vnc_failure, in which case call vnc_getLastError() to get the error code.
Parameters
  • server -

    The current Server.

  • connection -

    The Viewer whose permissions to change.

  • perms -

    Any combination of the vnc_Server_Permissions flags, or 0 (no permissions) to render the session ineffective.

int vnc_Server_getPermissions(vnc_Server *server, vnc_Connection *connection)

Gets the set of current permissions for a Viewer.

Return
Zero or more of the vnc_Server_Permissions flags.
Parameters
  • server -

    The current Server.

  • connection -

    The Viewer whose permissions to get.

vnc_status_t vnc_Server_setAgentCallback(vnc_Server *server, const vnc_Server_AgentCallback *callback, void *userData)

Sets agent-related callbacks for the Server.

These are not used on Android.

Return
vnc_success or vnc_failure, in which case call vnc_getLastError() to get the error code.
Since
1.1
Parameters
  • server -

    The current Server.

  • callback -

    The new agent event callback.

vnc_bool_t vnc_Server_isAgentReady(vnc_Server *server)

Determines if the vncagent process is ready and available to capture the display and inject input events.

If the vncagent is not ready, then the display cannot be captured at present. This could be because it is starting up or being restarted due to a user logout, or an error. On Linux, this can also indicate that the X server is not running. On Android, vncagent is not used and this function will always return vnc_true.

See vnc_Server_setAgentCallback() for receiving callbacks when the agent process starts and stops.

Since
1.1
Parameters
  • server -

    The current Server.

Return Value
  • vnc_true -

    The vncagent process is ready

  • vnc_false -

    The vncagent process is not ready or not running.

void vnc_Server_setFriendlyName(vnc_Server *server, const char *name)

Specifies a friendly name for the Server, to send to connected Viewers.

By default, this is the device’s hostname, plus the display number where appropriate.

Parameters
  • server -

    The current Server.

  • name -

    The UTF-8-encoded friendly name.

vnc_ConnectionHandler *vnc_Server_getConnectionHandler(vnc_Server *server)

Obtains the Server’s vnc_ConnectionHandler for performing connection operations.

Typically, a vnc_ConnectionHandler is passed to vnc_CloudListener_create() to start the Server listening for connections. However, you can reverse this methodology and pass it to vnc_CloudConnector_create() instead in order to connect to listening Viewers if you want (see Viewer.h for more information).

Return
A vnc_ConnectionHandler, valid for the lifetime of the Server.
Parameters
  • server -

    The current Server.

vnc_status_t vnc_Server_setCaptureMethod(vnc_Server *server, vnc_Server_CaptureMethod captureMethod)

Specifies the screen capture method used by the Server.

By default, an optimal method is chosen for each platform. In the unlikely event you experience screen capture issues under Windows or Linux, try the fallback method (this is not supported under Mac OS X).

Return
vnc_success or vnc_failure, in which case call vnc_getLastError() to get the error code.
Parameters
Return Value
  • NotSupported -

    captureMethod is not supported on this platform.

const char *vnc_Server_getPeerAddress(vnc_Server *server, vnc_Connection *connection)

Returns the address of a particular connected Viewer.

The format of the null-terminated string is [vnccloud:<cloud-address>]:<id> Note the string is only guaranteed to be valid until the next method call.

Return
A NULL-terminated string in the format [vnccloud:<cloud-address>]:<id>.
Parameters

void vnc_Server_disconnect(vnc_Server *server, vnc_Connection *connection, const char *message, int flags)

Disconnects a particular Viewer, optionally specifying a message.

See
vnc_Viewer_getDisconnectMessage()
Parameters

void vnc_Server_disconnectAll(vnc_Server *server, const char *message, int flags)

Disconnects all Viewers, optionally specifying a message.

See
vnc_Viewer_getDisconnectMessage()
Parameters
  • server -

    The current Server.

  • message -

    The message to send to all Viewers.

  • flags -

    Zero or more of the vnc_Server_DisconnectFlags flags.

vnc_status_t vnc_Server_setBlacklist(vnc_Server *server, int threshold, int timeout)

Specifies a blacklist threshold and timeout for the Server.

By default, the threshold is 5, which means that a Viewer failing to authenticate five times in a row is blacklisted for the default timeout of 10 seconds. This guards against brute-force and dictionary attacks.

To completely disable blacklisting, set threshold and timeout to 0. For security reasons this is not recommended.

Return
vnc_success or vnc_failure, in which case call vnc_getLastError() to get the error code.
Parameters
  • server -

    The current Server.

  • threshold -

    A number of unsuccessful authentication attempts before blacklisting.

  • timeout -

    A number of seconds before a blacklisted Viewer can attempt to authenticate again.

Return Value
  • InvalidArgument -

    timeout is zero or negative

void vnc_Server_serviceControlHandlerEx(vnc_Server *server, int dwControl, int dwEventType, void *lpEventData)

Handles a Windows Service control event.

When Server has been created via vnc_Server_createService(), then Windows Service control events must be forwarded to the Server so that active session can be determined. See the Win32 function RegisterServiceCtrlHandlerEx and the HandlerEx callback for more information.

This function can be called for all notifications received via your HandlerEx callback, but in particular it must be called for notifications where the control code (dwControl) is SERVICE_CONTROL_SESSIONCHANGE.

This method is designed to be called from the Service Control Dispatcher thread, rather than the thread which called vnc_init().

Since
1.1
Parameters
  • dwControl -

    The control code passed to HandlerEx

  • dwEventType -

    The type of event passed to HandlerEx

  • lpEventData -

    The event data passed to HandlerEx

vnc_AnnotationManager *vnc_Server_getAnnotationManager(vnc_Server *server)

Obtains the Server’s vnc_AnnotationManager for handling annotation operations.

Return
A vnc_AnnotationManager, valid for the lifetime of the Server.
Since
1.4
Parameters
  • server -

    The current Server.

vnc_MessagingManager *vnc_Server_getMessagingManager(vnc_Server *server)

Obtains the Server’s vnc_MessagingManager for handling messaging.

Return
A vnc_MessagingManager or NULL on error, in which case call vnc_getLastError() to get the error code.
Since
1.5
Return Value
  • NotEnabled -

    The Messaging feature is not enabled for this Server.

vnc_DisplayManager *vnc_Server_getDisplayManager(vnc_Server *server)

Obtains the Server’s vnc_DisplayManager, for managing the list of displays made available by the Server.

Return
A vnc_DisplayManager or NULL on error, in which case call vnc_getLastError() to get the error code.
Since
1.5
Parameters
  • server -

    The current Server.

Return Value
  • NotSupported -

    Display management is not supported on this platform.

vnc_status_t vnc_Server_setEncryptionLevel(vnc_Server *server, vnc_Server_EncryptionLevel level)

Sets the desired encryption level of the session from the range of options enumerated by vnc_Server_EncryptionLevel.

This will not affect the encryption level of established connections.

If a Viewer and Server select different encryption levels, connections between them take place at the higher of their selected levels.

Return
vnc_success or vnc_failure, in which case call vnc_getLastError() to get the error code.
Parameters
  • server -

    The current Server.

  • level -

    The new encryption level.

Return Value
  • InvalidArgument -

    The encryption level is invalid

vnc_Server_EncryptionLevel vnc_Server_getEncryptionLevel(vnc_Server *server, vnc_Connection *connection)

Returns the encryption level being used with an incoming connection, or the Server’s current encryption level if the connection is NULL.

Parameters
  • server -

    The current Server.

  • connection -

    The incoming connection or NULL.

vnc_status_t vnc_Server_setIdleTimeout(vnc_Server *server, int idleTimeout)

Sets the number of seconds to wait before disconnecting idle Viewers.

To turn off the idle timeout, use a value of 0.

Return
vnc_success or vnc_failure, in which case call vnc_getLastError() to get the error code.
Parameters
  • server -

    The current Server.

  • idleTimeout -

    The idle timeout in seconds.

Return Value
  • InvalidArgument -

    The idle timeout is invalid

int vnc_Server_getIdleTimeout(vnc_Server *server)

Gets the current number of seconds to wait before disconnecting idle Viewers.

A value of 0 indicates no timeout is set.

Parameters
  • server -

    The current Server.

struct vnc_Server_ConnectionCallback
#include <Server.h>

Callback receiving connection-related notifications for a Server.

See
vnc_Server_setConnectionCallback().

Public Members

void(* vnc_Server_ConnectionCallback::connectionStarted)(void *userData, vnc_Server *server, vnc_Connection *connection)

Notification that a connection has successfully started.

This callback is notified when a Viewer has successfully authenticated and been granted a set of session permissions.

It is optional to define a callback function of this type. Note that this callback is the only way to obtain a pointer to the vnc_Connection object identifying this Viewer, required by some method calls.

This vnc_Connection object is guaranteed to be valid until vnc_Server_ConnectionCallback::connectionEnded notifies you that it has been destroyed.

The connection count, as returned by vnc_Server_getConnectionCount(), is incremented before this callback is called.

Parameters
  • connection -

    The new connection.

void(* vnc_Server_ConnectionCallback::connectionEnded)(void *userData, vnc_Server *server, vnc_Connection *connection)

Notification that a connection has ended.

A callback of this type is made when a Viewer explicitly disconnects from the Server, or a VNC Cloud or other network error has occurred.

Note this callback function is called even if you call vnc_Server_disconnect() or vnc_Server_disconnectAll() to terminate connections yourself.

Only connections which have successfully authenticated and received a vnc_Server_ConnectionCallback::connectionStarted notification are notified throw this ended notification.

It is optional to define a callback function of this type, but note that memory corruption will occur if you call vnc_Server_disconnect() on a freed vnc_Connection, so you must use this callback if you maintain a list of connected viewers.

The connection count, as returned by vnc_Server_getConnectionCount(), is decremented after this callback is called.

Parameters
  • connection -

    The viewer connection which has ended.

struct vnc_Server_SecurityCallback
#include <Server.h>

Callback receiving security-related notifications for a Server.

See
vnc_Server_setSecurityCallback()

Public Members

vnc_bool_t(* vnc_Server_SecurityCallback::verifyPeer)(void *userData, vnc_Server *server, vnc_Connection *connection, const char *viewerHexFingerprint, const vnc_DataBuffer *viewerRsaPublic)

Verify a Viewer’s cryptographic identity.

This callback is made when a Viewer makes a connection, but before authentication.

It is optional to define a callback function of this type. Note that VNC Cloud mutually verifies peer identities for you, so this check is for peace-of-mind only (and only likely to be useful if you have out-of-band access to a list of all potential Viewer identities).

Return
vnc_true to continue the connection or vnc_false to terminate it.
Parameters
  • connection -

    The new connection. Note that if the connection does not subsequently authenticate itself, then the vnc_Server_ConnectionCallback::connectionEnded notification will not be called, therefore you should not cache or store the vnc_Connection pointer at this stage.

  • viewerHexFingerprint -

    A human-readable hexadecimal representation of a 2048-bit RSA public key hash.

  • viewerRsaPublic -

    The Viewer’s public key. See vnc_RsaKey_Callback::detailsReady for the format.

vnc_bool_t(* vnc_Server_SecurityCallback::isUserNameRequired)(void *userData, vnc_Server *server, vnc_Connection *connection)

Decide if a connecting Viewer is required to provide a user name.

This callback is made when a Viewer makes a connection, after peer identity verification has succeeded.

It is optional to define a callback function of this type, but note that if you do not, a connecting Viewer is required to provide a user name.

In your implementation, you should return vnc_false if there is no need for a Viewer to provide a user name, and vnc_true if there is.

Return
vnc_false if a user name is not required, else vnc_true.
Parameters

vnc_bool_t(* vnc_Server_SecurityCallback::isPasswordRequired)(void *userData, vnc_Server *server, vnc_Connection *connection)

Decide if a connecting Viewer is required to provide a password.

This callback is made when a Viewer makes a connection, after peer identity verification has succeeded.

It is optional to define a callback function of this type, but note that if you do not, a connecting Viewer is required to provide a password.

In your implementation, you should return vnc_false if there is no need for a Viewer to provide a password, and vnc_true if there is.

Return
vnc_false if a password is not required, else vnc_true.
Parameters

int(* vnc_Server_SecurityCallback::authenticateUser)(void *userData, vnc_Server *server, vnc_Connection *connection, const char *username, const char *password)

Authenticate credentials presented by a Viewer.

This callback is made when a Viewer has sent credentials to be authenticated, after the Server has requested the details returned by the vnc_Server_SecurityCallback::isUserNameRequired and vnc_Server_SecurityCallback::isPasswordRequired callbacks.

It is mandatory to define this callback function.

In your implementation, you should authenticate username and password, and either return 0 to terminate the connection, or any combination of the vnc_Server_Permissions flags to simultaneously approve the connection and grant a set of session permissions.

Please see the CERT Coding Standards for guidelines on handling passwords in reusable memory, in particular sections MSC18-C and MEM03-C.

Return
Any combination of the vnc_Server_Permissions flags, or 0 (no permissions) to reject the connection.
Parameters

struct vnc_Server_AgentCallback
#include <Server.h>

Callback receiving agent-related notifications for a Server.

See
vnc_Server_setAgentCallback().
Since
1.1

Public Members

void(* vnc_Server_AgentCallback::agentStarted)(void *userData, vnc_Server *server)

Notification that the agent has started.

Note that the agent is normally started automatically as soon as the server is created via vnc_Server_create() or vnc_Server_createService().

This callback is optional.

void(* vnc_Server_AgentCallback::agentStopped)(void *userData, vnc_Server *server)

Notification that the agent has stopped.

This may indicate that the user has logged out or (on Linux) the X server has stopped.

This callback is optional.

×