gorfb

README

This aims to become a full blown RFB (VNC) server library written in go.

The current code design tries to avoid blocking as much as possible.
But, at the moment encoding of dirty rectangles is still serialized into
a single goroutine :(
Only raw encoding is supported so far, and no authentication mechanism is
supported.
Tracking of dirty regions uses only up to two rectangles at a time.

Documentation

Index

• type CutEvent
• type Dirty
• type InputEvent
• type PixelFormat
• type RfbClient
• type RfbServer
  • func ServeDumbFb(port string, w uint16, h uint16) (*RfbServer, error)
  • func Server(port string, img draw.Image) (*RfbServer, error)
  • func (serv *RfbServer) Shutdown()
  • func (serv *RfbServer) Wait()

Types

type CutEvent

type CutEvent struct {
	Txt string
}

type Dirty

type Dirty struct {
	// contains filtered or unexported fields
}

type InputEvent

type InputEvent struct {
	T    int
	Key  uint32
	Pos  image.Point
	Mask uint8
}

type PixelFormat

type PixelFormat struct {
	// contains filtered or unexported fields
}

type RfbClient

type RfbClient struct {
	// contains filtered or unexported fields
}

type RfbServer

type RfbServer struct {
	Input chan InputEvent
	Txt   chan CutEvent
	Getfb chan draw.Image
	Relfb chan []image.Rectangle
	// contains filtered or unexported fields
}

func ServeDumbFb

func ServeDumbFb(port string, w uint16, h uint16) (*RfbServer, error)

func Server

func Server(port string, img draw.Image) (*RfbServer, error)

func (*RfbServer) Shutdown

func (serv *RfbServer) Shutdown()

func (*RfbServer) Wait

func (serv *RfbServer) Wait()