events

Documentation

Index

• Variables
• func CloseEventHandlers(hdlrs map[uint8]Event)
• type ClientCutText
  • func (c *ClientCutText) Code() uint8
  • func (c *ClientCutText) Handle(buf *buffer.ReadWriter, d *display.Display) error
• type Event
  • func GetDefaults() []Event
• type FrameBufferUpdate
  • func (f *FrameBufferUpdate) Code() uint8
  • func (f *FrameBufferUpdate) Handle(buf *buffer.ReadWriter, d *display.Display) error
• type KeyEvent
  • func (s *KeyEvent) Code() uint8
  • func (s *KeyEvent) Handle(buf *buffer.ReadWriter, d *display.Display) error
• type PointerEvent
  • func (s *PointerEvent) Code() uint8
  • func (s *PointerEvent) Handle(buf *buffer.ReadWriter, d *display.Display) error
• type SetEncodings
  • func (s *SetEncodings) Code() uint8
  • func (s *SetEncodings) Handle(buf *buffer.ReadWriter, d *display.Display) error
• type SetPixelFormat
  • func (s *SetPixelFormat) Code() uint8
  • func (s *SetPixelFormat) Handle(buf *buffer.ReadWriter, d *display.Display) error

Variables

var DefaultEvents = []Event{
	&SetEncodings{},
	&SetPixelFormat{},
	&FrameBufferUpdate{},
	&KeyEvent{},
	&PointerEvent{},
	&ClientCutText{},
}

DefaultEvents is a list of the default enabled event handlers.

Functions

func CloseEventHandlers

func CloseEventHandlers(hdlrs map[uint8]Event)

CloseEventHandlers will iterate each event handler in the map and if it provides a Close function it will execute it.

This does not exist anymore, but left for convenience should it be useful in the future. The Display object handles most of the state regarding an RFB session.

Types

type ClientCutText

type ClientCutText struct{}

ClientCutText handles new text in the client's cut buffer.

func (*ClientCutText) Code

func (c *ClientCutText) Code() uint8

Code returns the code.

func (*ClientCutText) Handle

func (c *ClientCutText) Handle(buf *buffer.ReadWriter, d *display.Display) error

Handle handles the event.

type Event

type Event interface {
	Code() uint8
	Handle(buf *buffer.ReadWriter, d *display.Display) error
}

Event is an inteface implemented by client message handlers.

func GetDefaults

func GetDefaults() []Event

GetDefaults returns a slice of the default event handlers.

type FrameBufferUpdate

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

FrameBufferUpdate handles framebuffer update events.

func (*FrameBufferUpdate) Code

func (f *FrameBufferUpdate) Code() uint8

Code returns the code.

func (*FrameBufferUpdate) Handle

func (f *FrameBufferUpdate) Handle(buf *buffer.ReadWriter, d *display.Display) error

Handle handles the event.

type KeyEvent

type KeyEvent struct{}

KeyEvent handles key events.

func (*KeyEvent) Code

func (s *KeyEvent) Code() uint8

Code returns the code.

func (*KeyEvent) Handle

func (s *KeyEvent) Handle(buf *buffer.ReadWriter, d *display.Display) error

Handle handles the event.

type PointerEvent

type PointerEvent struct{}

PointerEvent handles pointer events.

func (*PointerEvent) Code

func (s *PointerEvent) Code() uint8

Code returns the code.

func (*PointerEvent) Handle

func (s *PointerEvent) Handle(buf *buffer.ReadWriter, d *display.Display) error

Handle handles the event.

type SetEncodings

type SetEncodings struct{}

SetEncodings handles the client set-encodings event.

func (*SetEncodings) Code

func (s *SetEncodings) Code() uint8

Code returns the code.

func (*SetEncodings) Handle

func (s *SetEncodings) Handle(buf *buffer.ReadWriter, d *display.Display) error

Handle handles the event.

type SetPixelFormat

type SetPixelFormat struct{}

SetPixelFormat handles the client set-pixel-format event.

func (*SetPixelFormat) Code

func (s *SetPixelFormat) Code() uint8

Code returns the code.

func (*SetPixelFormat) Handle

func (s *SetPixelFormat) Handle(buf *buffer.ReadWriter, d *display.Display) error

Handle handles the event.