Learn how to evaluate and integrate the VNC SDK

We're here if you need help.

Server

class Server

A VNC-compatible Server enabling a computer to be remotely controlled.

For more information, see vnc_Server in the C API documentation.

Nested classes

Constructor summary

Modifier and Type Method and Description
Server

Server(String)

Creates a Server.

Method summary

Modifier and Type Method and Description
Server

Server.CreateService(String)

Creates a Server running as a service.

void

Server.Dispose()

Destroys the Server.

void

Server.SetConnectionCallback(Server.ConnectionCallback)

Sets connection-related callbacks for the Server.

Int32

Server.GetConnectionCount()

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

void

Server.SetSecurityCallback(Server.SecurityCallback)

Sets security-related callbacks for the Server.

void

Server.SetPermissions(Connection, Server.Permissions)

Changes permissions for a Viewer mid-session.

Permissions

Server.GetPermissions(Connection)

Gets the set of current permissions for a Viewer.

void

Server.SetAgentCallback(Server.AgentCallback)

Sets agent-related callbacks for the Server.

Boolean

Server.IsAgentReady()

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

void

Server.SetFriendlyName(String)

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

ConnectionHandler

Server.GetConnectionHandler()

Obtains the Server’s ConnectionHandler for performing connection operations.

void

Server.SetCaptureMethod(Server.CaptureMethod)

Specifies the screen capture method used by the Server.

String

Server.GetPeerAddress(Connection)

Returns the address of a particular connected Viewer.

void

Server.Disconnect(Connection, String, Server.DisconnectFlags)

Disconnects a particular Viewer, optionally specifying a message.

void

Server.DisconnectAll(String, Server.DisconnectFlags)

Disconnects all Viewers, optionally specifying a message.

void

Server.SetBlacklist(Int32, Int32)

Specifies a blacklist threshold and timeout for the Server.

AnnotationManager

Server.GetAnnotationManager()

Obtains the Server’s AnnotationManager for handling annotation operations.

MessagingManager

Server.GetMessagingManager()

Obtains the Server’s MessagingManager for handling messaging.

DisplayManager

Server.GetDisplayManager()

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

void

Server.SetEncryptionLevel(Server.EncryptionLevel)

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

EncryptionLevel

Server.GetEncryptionLevel(Connection)

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

void

Server.SetIdleTimeout(Int32)

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

Int32

Server.GetIdleTimeout()

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

Constructors

Server (String a)

Creates a Server.

For more information, see vnc_Server_create() in the C API documentation.

Methods

Server Server.CreateService (String a)

Creates a Server running as a service.

For more information, see vnc_Server_createService() in the C API documentation.

void Server.Dispose ()

Destroys the Server.

For more information, see vnc_Server_destroy() in the C API documentation.

void Server.SetConnectionCallback (Server.ConnectionCallback a)

Sets connection-related callbacks for the Server.

For more information, see vnc_Server_setConnectionCallback() in the C API documentation.

Int32 Server.GetConnectionCount ()

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

For more information, see vnc_Server_getConnectionCount() in the C API documentation.

void Server.SetSecurityCallback (Server.SecurityCallback a)

Sets security-related callbacks for the Server.

For more information, see vnc_Server_setSecurityCallback() in the C API documentation.

void Server.SetPermissions (Connection a, Server.Permissions b)

Changes permissions for a Viewer mid-session.

For more information, see vnc_Server_setPermissions() in the C API documentation.

Permissions Server.GetPermissions (Connection a)

Gets the set of current permissions for a Viewer.

For more information, see vnc_Server_getPermissions() in the C API documentation.

void Server.SetAgentCallback (Server.AgentCallback a)

Sets agent-related callbacks for the Server.

For more information, see vnc_Server_setAgentCallback() in the C API documentation.

Boolean Server.IsAgentReady ()

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

For more information, see vnc_Server_isAgentReady() in the C API documentation.

void Server.SetFriendlyName (String a)

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

For more information, see vnc_Server_setFriendlyName() in the C API documentation.

ConnectionHandler Server.GetConnectionHandler ()

Obtains the Server’s ConnectionHandler for performing connection operations.

For more information, see vnc_Server_getConnectionHandler() in the C API documentation.

void Server.SetCaptureMethod (Server.CaptureMethod a)

Specifies the screen capture method used by the Server.

For more information, see vnc_Server_setCaptureMethod() in the C API documentation.

String Server.GetPeerAddress (Connection a)

Returns the address of a particular connected Viewer.

For more information, see vnc_Server_getPeerAddress() in the C API documentation.

void Server.Disconnect (Connection a, String b, Server.DisconnectFlags c)

Disconnects a particular Viewer, optionally specifying a message.

For more information, see vnc_Server_disconnect() in the C API documentation.

void Server.DisconnectAll (String a, Server.DisconnectFlags b)

Disconnects all Viewers, optionally specifying a message.

For more information, see vnc_Server_disconnectAll() in the C API documentation.

void Server.SetBlacklist (Int32 a, Int32 b)

Specifies a blacklist threshold and timeout for the Server.

For more information, see vnc_Server_setBlacklist() in the C API documentation.

AnnotationManager Server.GetAnnotationManager ()

Obtains the Server’s AnnotationManager for handling annotation operations.

For more information, see vnc_Server_getAnnotationManager() in the C API documentation.

MessagingManager Server.GetMessagingManager ()

Obtains the Server’s MessagingManager for handling messaging.

For more information, see vnc_Server_getMessagingManager() in the C API documentation.

DisplayManager Server.GetDisplayManager ()

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

For more information, see vnc_Server_getDisplayManager() in the C API documentation.

void Server.SetEncryptionLevel (Server.EncryptionLevel a)

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

For more information, see vnc_Server_setEncryptionLevel() in the C API documentation.

EncryptionLevel Server.GetEncryptionLevel (Connection a)

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

For more information, see vnc_Server_getEncryptionLevel() in the C API documentation.

void Server.SetIdleTimeout (Int32 a)

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

For more information, see vnc_Server_setIdleTimeout() in the C API documentation.

Int32 Server.GetIdleTimeout ()

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

For more information, see vnc_Server_getIdleTimeout() in the C API documentation.

×