# README
VNC Library for Go
go-vnc is a VNC library for Go, initially supporting VNC clients but with the goal of eventually implementing a VNC server.
This library implements RFC 6143.
RFCs
Implemented
- **RFC **: The Remote Framebuffer Protocol
Usage & Installation
The library is installable via standard go get. The package name is vnc.
$ go get github.com/mitchellh/go-vnc
Documentation is available on GoDoc: http://godoc.org/github.com/mitchellh/go-vnc
# Constants
All available button mask components.
All available button mask components.
All available button mask components.
All available button mask components.
All available button mask components.
All available button mask components.
All available button mask components.
All available button mask components.
# Structs
A ClientConfig structure is used to configure a ClientConn.
Color represents a single color in a color map.
FramebufferUpdateMessage consists of a sequence of rectangles of pixel data that the client should put into its framebuffer.
PasswordAuth is VNC authentication, 7.2.2.
PixelFormat describes the way a pixel is formatted for a VNC connection.
RawEncoding is raw pixel data sent by the server.
Rectangle represents a rectangle of pixel data.
ServerCutTextMessage indicates the server has new text in the cut buffer.
SetColorMapEntriesMessage is sent by the server to set values into the color map.
ZlibEncoding is raw pixel data sent by the server compressed by Zlib.
# Interfaces
A ClientAuth implements a method of authenticating with a remote server.
An Encoding implements a method for encoding pixel data that is sent by the server to the client.
A ServerMessage implements a message sent from the server to the client.
# Type aliases
Bell signals that an audible bell should be made on the client.
ButtonMask represents a mask of pointer presses/releases.
ClientAuthNone is the "none" authentication.