rfb

package

Go to main page

Versions in this module

v1

v1.2.0

Mar 14, 2026

v1.1.1

May 8, 2023

Changes in this version

type EncodingType

+ const EncH264

type Option

+ func OptDisableClientMessageType(opt ...ClientMessageType) Option

+ func OptDisableServerMessageType(opt ...ServerMessageType) Option

type Options

+ DisableClientMessageType []ClientMessageType

+ DisableServerMessageType []ServerMessageType

v1.1.0

Jun 30, 2022

Changes in this version

+ type GetConn func(sess ISession) (io.ReadWriteCloser, error)

type ISession

+ Init func(...Option) error

+ NewEncoding func(EncodingType) IEncoding

+ Options func() Options

+ Start func()

+ type Message interface

+ Clone func() Message

+ Read func(ISession) (Message, error)

+ String func() string

+ Supported func(ISession) bool

+ Type func() MessageType

+ Write func(ISession) error

+ type MessageType uint8

+ type Option func(*Options)

+ func OptDesktopName(opt []byte) Option

+ func OptEncodings(opt ...IEncoding) Option

+ func OptGetConn(opt GetConn) Option

+ func OptHandlers(opt ...IHandler) Option

+ func OptHeight(opt int) Option

+ func OptMessages(opt ...Message) Option

+ func OptPixelFormat(opt PixelFormat) Option

+ func OptSecurityHandlers(opt ...ISecurityHandler) Option

+ func OptWidth(opt int) Option

+ type Options struct

+ ColorMap ColorMap

+ DesktopName []byte

+ DisableMessageType []MessageType

+ DrawCursor bool

+ Encodings []IEncoding

+ ErrorCh chan error

+ Exclusive bool

+ GetConn GetConn

+ Handlers []IHandler

+ Height uint16

+ Input chan Message

+ Messages []Message

+ Output chan Message

+ PixelFormat PixelFormat

+ QuitCh chan struct{}

+ SecurityHandlers []ISecurityHandler

+ Width uint16

type TargetConfig

+ func (that TargetConfig) GetNetwork() string

+ func (that TargetConfig) GetTimeout() time.Duration

v1.0.0

Jun 14, 2022

Changes in this version

+ const PixelFormatLen

+ const ProtoVersion33

+ const ProtoVersion37

+ const ProtoVersion38

+ const ProtoVersionLength

+ const ProtoVersionUnknown

+ var PixelFormat16bit = NewPixelFormat(16)

+ var PixelFormat32bit = NewPixelFormat(32)

+ var PixelFormat8bit = NewPixelFormat(8)

+ var PixelFormatAten = NewPixelFormatAten()

+ type ClientConfig struct

+ ColorMap ColorMap

+ DisableMessageType []ClientMessageType

+ DrawCursor bool

+ Encodings []IEncoding

+ ErrorCh chan error

+ Exclusive bool

+ Handlers []IHandler

+ Input chan ServerMessage

+ Messages []ServerMessage

+ Output chan ClientMessage

+ PixelFormat PixelFormat

+ QuitCh chan struct{}

+ SecurityHandlers []ISecurityHandler

+ type ClientMessage interface

+ Clone func() ClientMessage

+ Read func(ISession) (ClientMessage, error)

+ String func() string

+ Supported func(ISession) bool

+ Type func() ClientMessageType

+ Write func(ISession) error

+ type ClientMessageType uint8

+ const ClientCutText

+ const ClientFence

+ const EnableContinuousUpdates

+ const FramebufferUpdateRequest

+ const KeyEvent

+ const PointerEvent

+ const QEMUExtendedKeyEvent

+ const SetDesktopSize

+ const SetEncodings

+ const SetPixelFormat

+ func (i ClientMessageType) String() string

+ type Color struct

+ B uint16

+ G uint16

+ R uint16

+ func (that *Color) Read(session ISession) error

+ func (that *Color) Write(session ISession) error

+ type ColorMap [256]Color

+ type EncodingType int32

+ const EncAtenAST2100

+ const EncAtenASTJPEG

+ const EncAtenHermon

+ const EncAtenPilot3

+ const EncAtenYarkon

+ const EncClientRedirect

+ const EncCoRRE

+ const EncCompressionLevel1

+ const EncCompressionLevel10

+ const EncCompressionLevel2

+ const EncCompressionLevel3

+ const EncCompressionLevel4

+ const EncCompressionLevel5

+ const EncCompressionLevel6

+ const EncCompressionLevel7

+ const EncCompressionLevel8

+ const EncCompressionLevel9

+ const EncContinuousUpdatesPseudo

+ const EncCopyRect

+ const EncCursorPseudo

+ const EncCursorWithAlphaPseudo

+ const EncDesktopNamePseudo

+ const EncDesktopSizePseudo

+ const EncExtendedClipboardPseudo

+ const EncExtendedDesktopSizePseudo

+ const EncFencePseudo

+ const EncHexTile

+ const EncJPEG

+ const EncJPEGQualityLevelPseudo1

+ const EncJPEGQualityLevelPseudo10

+ const EncJPEGQualityLevelPseudo2

+ const EncJPEGQualityLevelPseudo3

+ const EncJPEGQualityLevelPseudo4

+ const EncJPEGQualityLevelPseudo5

+ const EncJPEGQualityLevelPseudo6

+ const EncJPEGQualityLevelPseudo7

+ const EncJPEGQualityLevelPseudo8

+ const EncJPEGQualityLevelPseudo9

+ const EncJRLE

+ const EncLastRectPseudo

+ const EncLedStatePseudo

+ const EncOffscreenCopyRect

+ const EncPointerPosPseudo

+ const EncQEMUExtendedKeyEventPseudo

+ const EncQEMUPointerMotionChangePseudo

+ const EncRRE

+ const EncRaw

+ const EncTRLE

+ const EncTight

+ const EncTightDiffComp

+ const EncTightPNGBase64

+ const EncTightPng

+ const EncUltra1

+ const EncUltra2

+ const EncVMWCursorPosition

+ const EncVMWCursorState

+ const EncVMWDefineCursor

+ const EncVMWFrameStamp

+ const EncVMWLEDState

+ const EncVMWServerCaps

+ const EncVMWServerPush2

+ const EncVMWTypematicInfo

+ const EncXCursorPseudo

+ const EncXvpPseudo

+ const EncZRLE

+ const EncZlib

+ const EncZlibHex

+ func (i EncodingType) String() string

+ type IEncoding interface

+ Clone func(...bool) IEncoding

+ Read func(ISession, *Rectangle) error

+ Supported func(ISession) bool

+ Type func() EncodingType

+ Write func(ISession, *Rectangle) error

+ type IHandler interface

+ Handle func(session ISession) error

+ type ISecurityHandler interface

+ Auth func(ISession) error

+ SubType func() SecuritySubType

+ Type func() SecurityType

+ type ISession interface

+ ColorMap func() ColorMap

+ Config func() interface{}

+ Conn func() io.ReadWriteCloser

+ DesktopName func() []byte

+ Encodings func() []IEncoding

+ Flush func() error

+ GetEncoding func(EncodingType) IEncoding

+ Height func() uint16

+ PixelFormat func() PixelFormat

+ ProtocolVersion func() string

+ SecurityHandler func() ISecurityHandler

+ SetColorMap func(ColorMap)

+ SetDesktopName func([]byte)

+ SetEncodings func([]EncodingType) error

+ SetHeight func(uint16)

+ SetPixelFormat func(PixelFormat) error

+ SetProtocolVersion func(string)

+ SetSecurityHandler func(ISecurityHandler) error

+ SetWidth func(uint16)

+ Swap func() *gmap.Map

+ Type func() SessionType

+ Wait func()

+ Width func() uint16

+ type Key uint32

+ const A

+ const AltLeft

+ const AltRight

+ const Ampersand

+ const Apostrophe

+ const AsciiCircum

+ const AsciiTilde

+ const Asterisk

+ const At

+ const B

+ const BackSpace

+ const Backslash

+ const Bar

+ const Begin

+ const BraceLeft

+ const BraceRight

+ const BracketLeft

+ const BracketRight

+ const Break

+ const C

+ const Cancel

+ const CapsLock

+ const Clear

+ const Colon

+ const Comma

+ const ControlLeft

+ const ControlRight

+ const D

+ const Delete

+ const Digit0

+ const Digit1

+ const Digit2

+ const Digit3

+ const Digit4

+ const Digit5

+ const Digit6

+ const Digit7

+ const Digit8

+ const Digit9

+ const Dollar

+ const Down

+ const E

+ const End

+ const Equal

+ const Escape

+ const Exclaim

+ const Execute

+ const F

+ const F1

+ const F10

+ const F11

+ const F12

+ const F2

+ const F3

+ const F4

+ const F5

+ const F6

+ const F7

+ const F8

+ const F9

+ const Find

+ const G

+ const Grave

+ const Greater

+ const H

+ const Help

+ const Home

+ const HyperLeft

+ const HyperRight

+ const I

+ const Insert

+ const J

+ const K

+ const Keypad0

+ const Keypad1

+ const Keypad2

+ const Keypad3

+ const Keypad4

+ const Keypad5

+ const Keypad6

+ const Keypad7

+ const Keypad8

+ const Keypad9

+ const KeypadAdd

+ const KeypadBegin

+ const KeypadDecimal

+ const KeypadDelete

+ const KeypadDivide

+ const KeypadDown

+ const KeypadEnd

+ const KeypadEnter

+ const KeypadEqual

+ const KeypadF1

+ const KeypadF2

+ const KeypadF3

+ const KeypadF4

+ const KeypadHome

+ const KeypadInsert

+ const KeypadLeft

+ const KeypadMultiply

+ const KeypadNext

+ const KeypadPageDown

+ const KeypadPageUp

+ const KeypadPrior

+ const KeypadRight

+ const KeypadSeparator

+ const KeypadSpace

+ const KeypadSubtract

+ const KeypadTab

+ const KeypadUp

+ const L

+ const Left

+ const Less

+ const Linefeed

+ const M

+ const Menu

+ const MetaLeft

+ const MetaRight

+ const Minus

+ const ModeSwitch

+ const N

+ const NumLock

+ const NumberSign

+ const O

+ const P

+ const PageDown

+ const PageUp

+ const ParenLeft

+ const ParenRight

+ const Pause

+ const Percent

+ const Period

+ const Plus

+ const Print

+ const Q

+ const Question

+ const QuoteDbl

+ const R

+ const Redo

+ const Return

+ const Right

+ const S

+ const ScrollLock

+ const Select

+ const Semicolon

+ const ShiftLeft

+ const ShiftLock

+ const ShiftRight

+ const Slash

+ const SmallA

+ const SmallB

+ const SmallC

+ const SmallD

+ const SmallE

+ const SmallF

+ const SmallG

+ const SmallH

+ const SmallI

+ const SmallJ

+ const SmallK

+ const SmallL

+ const SmallM

+ const SmallN

+ const SmallO

+ const SmallP

+ const SmallQ

+ const SmallR

+ const SmallS

+ const SmallT

+ const SmallU

+ const SmallV

+ const SmallW

+ const SmallX

+ const SmallY

+ const SmallZ

+ const Space

+ const SuperLeft

+ const SuperRight

+ const SysReq

+ const T

+ const Tab

+ const U

+ const Underscore

+ const Undo

+ const Up

+ const V

+ const W

+ const X

+ const Y

+ const Z

+ func (i Key) String() string

+ type Keys []Key

+ func IntToKeys(v int) Keys

+ type PixelFormat struct

+ BPP uint8

+ BigEndian uint8

+ BlueMax uint16

+ BlueShift uint8

+ Depth uint8

+ GreenMax uint16

+ GreenShift uint8

+ RedMax uint16

+ RedShift uint8

+ TrueColor uint8

+ func NewPixelFormat(bpp uint8) PixelFormat

+ func NewPixelFormatAten() PixelFormat

+ func (that PixelFormat) Order() binary.ByteOrder

+ func (that PixelFormat) String() string

+ type Rectangle struct

+ Enc IEncoding

+ EncType EncodingType

+ Height uint16

+ Width uint16

+ X uint16

+ Y uint16

+ func NewRectangle() *Rectangle

+ func (that *Rectangle) Clone() *Rectangle

+ func (that *Rectangle) Read(sess ISession) error

+ func (that *Rectangle) String() string

+ func (that *Rectangle) Write(sess ISession) error

+ type SecuritySubType uint32

+ const SecSubTypeUnknown

+ const SecSubTypeVeNCrypt01Plain

+ const SecSubTypeVeNCrypt01TLSNone

+ const SecSubTypeVeNCrypt01TLSPlain

+ const SecSubTypeVeNCrypt01TLSVNC

+ const SecSubTypeVeNCrypt01Unknown

+ const SecSubTypeVeNCrypt01X509None

+ const SecSubTypeVeNCrypt01X509Plain

+ const SecSubTypeVeNCrypt01X509VNC

+ const SecSubTypeVeNCrypt02Plain

+ const SecSubTypeVeNCrypt02TLSNone

+ const SecSubTypeVeNCrypt02TLSPlain

+ const SecSubTypeVeNCrypt02TLSVNC

+ const SecSubTypeVeNCrypt02Unknown

+ const SecSubTypeVeNCrypt02X509None

+ const SecSubTypeVeNCrypt02X509Plain

+ const SecSubTypeVeNCrypt02X509VNC

+ func (i SecuritySubType) String() string

+ type SecurityType uint8

+ const SecTypeNone

+ const SecTypeTight

+ const SecTypeUnknown

+ const SecTypeVNC

+ const SecTypeVeNCrypt

+ func (i SecurityType) String() string

+ type ServerConfig struct

+ ColorMap ColorMap

+ DesktopName []byte

+ DisableMessageType []ServerMessageType

+ Encodings []IEncoding

+ ErrorCh chan error

+ Handlers []IHandler

+ Height uint16

+ Input chan ClientMessage

+ Messages []ClientMessage

+ Output chan ServerMessage

+ PixelFormat PixelFormat

+ SecurityHandlers []ISecurityHandler

+ Width uint16

+ type ServerMessage interface

+ Clone func() ServerMessage

+ Read func(ISession) (ServerMessage, error)

+ String func() string

+ Supported func(ISession) bool

+ Type func() ServerMessageType

+ Write func(ISession) error

+ type ServerMessageType uint8

+ const Bell

+ const EndOfContinuousUpdates

+ const FramebufferUpdate

+ const ServerCutText

+ const ServerFence

+ const SetColorMapEntries

+ func (i ServerMessageType) String() string

+ type SessionType uint8

+ const CanvasSessionType

+ const ClientSessionType

+ const PlayerSessionType

+ const RecorderSessionType

+ const ServerSessionType

+ func (i SessionType) String() string

+ type TargetConfig struct

+ Host string

+ Network string

+ Password []byte

+ Port int

+ Timeout time.Duration

+ func (that TargetConfig) Addr() string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL