rfb

Documentation

Index

• type Conn
• type FrameBufferUpdateRequest
• type KeyEvent
• type LockableImage
• type PixelFormat
• type PointerEvent
• type Server
  • func NewServer(width, height int) *Server
  • func (s *Server) Serve(ln net.Listener) error

Types

type Conn

type Conn struct {

	// Feed is the channel to send new frames.
	Feed chan<- *LockableImage

	// Event is a readable channel of events from the client.
	// The value will be either a KeyEvent or PointerEvent.  The
	// channel is closed when the client disconnects.
	Event <-chan interface{}
	// contains filtered or unexported fields
}

type FrameBufferUpdateRequest

type FrameBufferUpdateRequest struct {
	IncrementalFlag     uint8
	X, Y, Width, Height uint16
}

6.4.3

type KeyEvent

type KeyEvent struct {
	DownFlag uint8
	Key      uint32
}

6.4.4

type LockableImage

type LockableImage struct {
	sync.RWMutex
	Img image.Image
}

type PixelFormat

type PixelFormat struct {
	BPP, Depth                      uint8
	BigEndian, TrueColour           uint8 // flags; 0 or non-zero
	RedMax, GreenMax, BlueMax       uint16
	RedShift, GreenShift, BlueShift uint8
}

type PointerEvent

type PointerEvent struct {
	ButtonMask uint8
	X, Y       uint16
}

6.4.5

type Server

type Server struct {

	// Conns is a channel of incoming connections.
	Conns <-chan *Conn
	// contains filtered or unexported fields
}

func NewServer

func NewServer(width, height int) *Server

func (*Server) Serve

func (s *Server) Serve(ln net.Listener) error