The VncServerSession type exposes the following members.
Back to Top
Back to Top
Back to Top
Back to Top
Constructors
| Name | Description | |
|---|---|---|
 | VncServerSession |
Initializes a new instance of the VncServerSession class.
|
Methods
| Name | Description | |
|---|---|---|
| Bell |
Tells the client to play a bell sound.
|
| Close |
Closes the connection with the remote client.
|
| Connect |
Starts a session with a VNC client.
|
| FramebufferChanged |
Notifies the framebuffer update thread to check for recent changes.
|
| FramebufferManualBeginUpdate |
Begins a manual framebuffer update.
Do not call this method without holding FramebufferUpdateRequestLock.
|
| FramebufferManualCopyRegion |
Queues an update corresponding to one region of the framebuffer being copide to another.
Do not call this method without holding FramebufferUpdateRequestLock.
|
| FramebufferManualEndUpdate |
Completes a manual framebuffer update.
Do not call this method without holding FramebufferUpdateRequestLock.
|
| FramebufferManualInvalidate(VncRectangle) |
Queues an update for the specified region.
Do not call this method without holding FramebufferUpdateRequestLock.
|
| FramebufferManualInvalidate( VncRectangle ) |
Queues an update for each of the specified regions.
Do not call this method without holding FramebufferUpdateRequestLock.
|
| FramebufferManualInvalidateAll |
Queues an update for the entire framebuffer.
Do not call this method without holding FramebufferUpdateRequestLock.
|
| SendLocalClipboardChange |
Notifies the client that the local clipboard has changed.
If you are implementing clipboard integration, use this to set the remote clipboard.
|
| SetFramebufferSource |
Sets the framebuffer source.
|
Properties
| Name | Description | |
|---|---|---|
 | ClientVersion |
The protocol version of the client.
|
| Framebuffer |
The framebuffer for the VNC session.
|
| FramebufferUpdateRequest |
Information about the client's most recent framebuffer update request.
This may be null if the client has no framebuffer request queued.
|
| FramebufferUpdateRequestLock |
Lock this before performing any framebuffer updates.
|
| IsConnected | true if the server is connected to a client.
|
| MaxUpdateRate |
The max rate to send framebuffer updates at, in frames per second.
The default is 15.
|
| UserData |
Store anything you want here.
|
Events
| Name | Description | |
|---|---|---|
 | Closed |
Occurs when the VNC client is disconnected.
|
| Connected |
Occurs when the VNC client has successfully connected to the server.
|
| ConnectionFailed |
Occurs when the VNC client has failed to connect to the server.
|
| CreatingDesktop |
Occurs when the client requests access to the desktop.
It may request exclusive or shared access -- this event will relay that information.
|
| FramebufferCapturing |
Occurs when the framebuffer needs to be captured.
If you have not called SetFramebufferSource(IVncFramebufferSource), alter the framebuffer
in response to this event.
FramebufferUpdateRequestLock is held automatically while this event is raised.
|
| FramebufferUpdating |
Occurs when the framebuffer needs to be updated.
If you do not set  Handled on FramebufferUpdatingEventArgs,
VncServerSession will determine the updated regions itself.
FramebufferUpdateRequestLock is held automatically while this event is raised.
|
| KeyChanged |
Occurs when a key has been pressed or released.
|
| PasswordProvided |
Occurs when the VNC client provides a password.
Respond to this event by accepting or rejecting the password.
|
| PointerChanged |
Occurs on a mouse movement, button click, etc.
|
| RemoteClipboardChanged |
Occurs when the clipboard changes on the remote client.
If you are implementing clipboard integration, use this to set the local clipboard.
|
See Also