LibVNCServer/LibVNCClient
Data Fields
rfbScreenInfoPtr Struct Reference

Per-screen (framebuffer) structure. More...

#include <rfb.h>

Data Fields

struct _rfbScreenInfo * scaledScreenNext
 this structure has children that are scaled versions of this screen More...
 
int scaledScreenRefCount
 
int width
 
int paddedWidthInBytes
 
int height
 
int depth
 
int bitsPerPixel
 
int sizeInBytes
 
rfbPixel blackPixel
 
rfbPixel whitePixel
 
void * screenData
 some screen specific data can be put into a struct where screenData points to. More...
 
rfbPixelFormat serverFormat
 
rfbColourMap colourMap
 set this if rfbServerFormat.trueColour==FALSE More...
 
const char * desktopName
 
char thisHost [255]
 
rfbBool autoPort
 
int port
 
rfbSocket listenSock
 
int maxSock
 
int maxFd
 
fd_set allFds
 
enum rfbSocketState socketState
 
rfbSocket inetdSock
 
rfbBool inetdInitDone
 
int udpPort
 
rfbSocket udpSock
 
struct _rfbClientRec * udpClient
 
rfbBool udpSockConnected
 
struct sockaddr_in udpRemoteAddr
 
int maxClientWait
 
rfbBool httpInitDone
 
rfbBool httpEnableProxyConnect
 
int httpPort
 
char * httpDir
 
rfbSocket httpListenSock
 
rfbSocket httpSock
 
rfbPasswordCheckProcPtr passwordCheck
 
void * authPasswdData
 
int authPasswdFirstViewOnly
 If rfbAuthPasswdData is given a list, this is the first view only password. More...
 
int maxRectsPerUpdate
 send only this many rectangles in one update More...
 
int deferUpdateTime
 this is the amount of milliseconds to wait at least before sending an update. More...
 
rfbBool alwaysShared
 
rfbBool neverShared
 
rfbBool dontDisconnect
 
struct _rfbClientRec * clientHead
 
struct _rfbClientRec * pointerClient
 "Mutex" for pointer events More...
 
int cursorX
 
int cursorY
 
int underCursorBufferLen
 
char * underCursorBuffer
 
rfbBool dontConvertRichCursorToXCursor
 
struct rfbCursorcursor
 
char * frameBuffer
 the frameBuffer has to be supplied by the serving process. More...
 
rfbKbdAddEventProcPtr kbdAddEvent
 
rfbKbdReleaseAllKeysProcPtr kbdReleaseAllKeys
 
rfbPtrAddEventProcPtr ptrAddEvent
 
rfbSetXCutTextProcPtr setXCutText
 
rfbGetCursorProcPtr getCursorPtr
 
rfbSetTranslateFunctionProcPtr setTranslateFunction
 
rfbSetSingleWindowProcPtr setSingleWindow
 
rfbSetServerInputProcPtr setServerInput
 
rfbFileTransferPermitted getFileTransferPermission
 
rfbSetTextChat setTextChat
 
rfbNewClientHookPtr newClientHook
 newClientHook is called just after a new client is created More...
 
rfbDisplayHookPtr displayHook
 displayHook is called just before a frame buffer update More...
 
rfbGetKeyboardLedStateHookPtr getKeyboardLedStateHook
 These hooks are called to pass keyboard state back to the client. More...
 
rfbBool ignoreSIGPIPE
 if TRUE, an ignoring signal handler is installed for SIGPIPE More...
 
int progressiveSliceHeight
 if not zero, only a slice of this height is processed every time an update should be sent. More...
 
in_addr_t listenInterface
 
int deferPtrUpdateTime
 
rfbBool handleEventsEagerly
 handle as many input events as possible (default off) More...
 
char * versionString
 rfbEncodingServerIdentity More...
 
int protocolMajorVersion
 What does the server tell the new clients which version it supports. More...
 
int protocolMinorVersion
 
rfbBool permitFileTransfer
 command line authorization of file transfers More...
 
rfbDisplayFinishedHookPtr displayFinishedHook
 displayFinishedHook is called just after a frame buffer update More...
 
rfbXvpHookPtr xvpHook
 xvpHook is called to handle an xvp client message More...
 
char * sslkeyfile
 
char * sslcertfile
 
int ipv6port
 The port to listen on when using IPv6. More...
 
char * listen6Interface
 
rfbSocket listen6Sock
 
int http6Port
 
rfbSocket httpListen6Sock
 
rfbSetDesktopSizeHookPtr setDesktopSizeHook
 hook to let client set resolution More...
 
rfbNumberOfExtDesktopScreensPtr numberOfExtDesktopScreensHook
 Optional hooks to query ExtendedDesktopSize screen information. More...
 
rfbGetExtDesktopScreenPtr getExtDesktopScreenHook
 
float fdQuota
 This value between 0 and 1.0 defines which fraction of the maximum number of file descriptors LibVNCServer uses before denying new client connections. More...
 

Detailed Description

Per-screen (framebuffer) structure.

There can be as many as you wish, each serving different clients. However, you have to call rfbProcessEvents for each of these.

Definition at line 198 of file rfb.h.

Field Documentation

◆ allFds

fd_set allFds

Definition at line 236 of file rfb.h.

◆ alwaysShared

rfbBool alwaysShared

Definition at line 273 of file rfb.h.

◆ authPasswdData

void* authPasswdData

Definition at line 260 of file rfb.h.

◆ authPasswdFirstViewOnly

int authPasswdFirstViewOnly

If rfbAuthPasswdData is given a list, this is the first view only password.

Definition at line 263 of file rfb.h.

◆ autoPort

rfbBool autoPort

Definition at line 228 of file rfb.h.

◆ bitsPerPixel

int bitsPerPixel

Definition at line 208 of file rfb.h.

◆ blackPixel

rfbPixel blackPixel

Definition at line 211 of file rfb.h.

◆ clientHead

struct _rfbClientRec* clientHead

Definition at line 276 of file rfb.h.

◆ colourMap

rfbColourMap colourMap

set this if rfbServerFormat.trueColour==FALSE

Definition at line 224 of file rfb.h.

◆ cursor

struct rfbCursor* cursor

Definition at line 284 of file rfb.h.

◆ cursorX

int cursorX

Definition at line 281 of file rfb.h.

◆ cursorY

int cursorY

Definition at line 281 of file rfb.h.

◆ deferPtrUpdateTime

int deferPtrUpdateTime

Definition at line 324 of file rfb.h.

◆ deferUpdateTime

int deferUpdateTime

this is the amount of milliseconds to wait at least before sending an update.

Definition at line 269 of file rfb.h.

◆ depth

int depth

Definition at line 207 of file rfb.h.

◆ desktopName

const char* desktopName

Definition at line 225 of file rfb.h.

◆ displayFinishedHook

rfbDisplayFinishedHookPtr displayFinishedHook

displayFinishedHook is called just after a frame buffer update

Definition at line 340 of file rfb.h.

◆ displayHook

rfbDisplayHookPtr displayHook

displayHook is called just before a frame buffer update

Definition at line 305 of file rfb.h.

◆ dontConvertRichCursorToXCursor

rfbBool dontConvertRichCursorToXCursor

Definition at line 283 of file rfb.h.

◆ dontDisconnect

rfbBool dontDisconnect

Definition at line 275 of file rfb.h.

◆ fdQuota

float fdQuota

This value between 0 and 1.0 defines which fraction of the maximum number of file descriptors LibVNCServer uses before denying new client connections.

It is set to 0.5 per default.

Definition at line 362 of file rfb.h.

◆ frameBuffer

char* frameBuffer

the frameBuffer has to be supplied by the serving process.

The buffer will not be freed by

Definition at line 290 of file rfb.h.

◆ getCursorPtr

rfbGetCursorProcPtr getCursorPtr

Definition at line 295 of file rfb.h.

◆ getExtDesktopScreenHook

rfbGetExtDesktopScreenPtr getExtDesktopScreenHook

Definition at line 358 of file rfb.h.

◆ getFileTransferPermission

rfbFileTransferPermitted getFileTransferPermission

Definition at line 299 of file rfb.h.

◆ getKeyboardLedStateHook

rfbGetKeyboardLedStateHookPtr getKeyboardLedStateHook

These hooks are called to pass keyboard state back to the client.

Definition at line 308 of file rfb.h.

◆ handleEventsEagerly

rfbBool handleEventsEagerly

handle as many input events as possible (default off)

Definition at line 327 of file rfb.h.

◆ height

int height

Definition at line 206 of file rfb.h.

◆ http6Port

int http6Port

Definition at line 351 of file rfb.h.

◆ httpDir

char* httpDir

Definition at line 255 of file rfb.h.

◆ httpEnableProxyConnect

rfbBool httpEnableProxyConnect

Definition at line 253 of file rfb.h.

◆ httpInitDone

rfbBool httpInitDone

Definition at line 252 of file rfb.h.

◆ httpListen6Sock

rfbSocket httpListen6Sock

Definition at line 352 of file rfb.h.

◆ httpListenSock

rfbSocket httpListenSock

Definition at line 256 of file rfb.h.

◆ httpPort

int httpPort

Definition at line 254 of file rfb.h.

◆ httpSock

rfbSocket httpSock

Definition at line 257 of file rfb.h.

◆ ignoreSIGPIPE

rfbBool ignoreSIGPIPE

if TRUE, an ignoring signal handler is installed for SIGPIPE

Definition at line 316 of file rfb.h.

◆ inetdInitDone

rfbBool inetdInitDone

Definition at line 241 of file rfb.h.

◆ inetdSock

rfbSocket inetdSock

Definition at line 240 of file rfb.h.

◆ ipv6port

int ipv6port

The port to listen on when using IPv6.

Definition at line 345 of file rfb.h.

◆ kbdAddEvent

rfbKbdAddEventProcPtr kbdAddEvent

Definition at line 291 of file rfb.h.

◆ kbdReleaseAllKeys

rfbKbdReleaseAllKeysProcPtr kbdReleaseAllKeys

Definition at line 292 of file rfb.h.

◆ listen6Interface

char* listen6Interface

Definition at line 346 of file rfb.h.

◆ listen6Sock

rfbSocket listen6Sock

Definition at line 350 of file rfb.h.

◆ listenInterface

in_addr_t listenInterface

Definition at line 323 of file rfb.h.

◆ listenSock

rfbSocket listenSock

Definition at line 230 of file rfb.h.

◆ maxClientWait

int maxClientWait

Definition at line 249 of file rfb.h.

◆ maxFd

int maxFd

Definition at line 232 of file rfb.h.

◆ maxRectsPerUpdate

int maxRectsPerUpdate

send only this many rectangles in one update

Definition at line 266 of file rfb.h.

◆ maxSock

int maxSock

Definition at line 231 of file rfb.h.

◆ neverShared

rfbBool neverShared

Definition at line 274 of file rfb.h.

◆ newClientHook

rfbNewClientHookPtr newClientHook

newClientHook is called just after a new client is created

Definition at line 303 of file rfb.h.

◆ numberOfExtDesktopScreensHook

rfbNumberOfExtDesktopScreensPtr numberOfExtDesktopScreensHook

Optional hooks to query ExtendedDesktopSize screen information.

If not set it is assumed only one screen is present spanning entire fb

Definition at line 357 of file rfb.h.

◆ paddedWidthInBytes

int paddedWidthInBytes

Definition at line 205 of file rfb.h.

◆ passwordCheck

rfbPasswordCheckProcPtr passwordCheck

Definition at line 259 of file rfb.h.

◆ permitFileTransfer

rfbBool permitFileTransfer

command line authorization of file transfers

Definition at line 337 of file rfb.h.

◆ pointerClient

struct _rfbClientRec* pointerClient

"Mutex" for pointer events

Definition at line 277 of file rfb.h.

◆ port

int port

Definition at line 229 of file rfb.h.

◆ progressiveSliceHeight

int progressiveSliceHeight

if not zero, only a slice of this height is processed every time an update should be sent.

This should make working on a slow link more interactive.

Definition at line 321 of file rfb.h.

◆ protocolMajorVersion

int protocolMajorVersion

What does the server tell the new clients which version it supports.

Definition at line 333 of file rfb.h.

◆ protocolMinorVersion

int protocolMinorVersion

Definition at line 334 of file rfb.h.

◆ ptrAddEvent

rfbPtrAddEventProcPtr ptrAddEvent

Definition at line 293 of file rfb.h.

◆ scaledScreenNext

struct _rfbScreenInfo* scaledScreenNext

this structure has children that are scaled versions of this screen

Definition at line 201 of file rfb.h.

◆ scaledScreenRefCount

int scaledScreenRefCount

Definition at line 202 of file rfb.h.

◆ screenData

void* screenData

some screen specific data can be put into a struct where screenData points to.

You need this if you have more than one screen at the same time while using the same functions.

Definition at line 219 of file rfb.h.

◆ serverFormat

rfbPixelFormat serverFormat

Definition at line 223 of file rfb.h.

◆ setDesktopSizeHook

rfbSetDesktopSizeHookPtr setDesktopSizeHook

hook to let client set resolution

Definition at line 354 of file rfb.h.

◆ setServerInput

rfbSetServerInputProcPtr setServerInput

Definition at line 298 of file rfb.h.

◆ setSingleWindow

rfbSetSingleWindowProcPtr setSingleWindow

Definition at line 297 of file rfb.h.

◆ setTextChat

rfbSetTextChat setTextChat

Definition at line 300 of file rfb.h.

◆ setTranslateFunction

rfbSetTranslateFunctionProcPtr setTranslateFunction

Definition at line 296 of file rfb.h.

◆ setXCutText

rfbSetXCutTextProcPtr setXCutText

Definition at line 294 of file rfb.h.

◆ sizeInBytes

int sizeInBytes

Definition at line 209 of file rfb.h.

◆ socketState

enum rfbSocketState socketState

Definition at line 239 of file rfb.h.

◆ sslcertfile

char* sslcertfile

Definition at line 344 of file rfb.h.

◆ sslkeyfile

char* sslkeyfile

Definition at line 343 of file rfb.h.

◆ thisHost

char thisHost[255]

Definition at line 226 of file rfb.h.

◆ udpClient

struct _rfbClientRec* udpClient

Definition at line 245 of file rfb.h.

◆ udpPort

int udpPort

Definition at line 243 of file rfb.h.

◆ udpRemoteAddr

struct sockaddr_in udpRemoteAddr

Definition at line 247 of file rfb.h.

◆ udpSock

rfbSocket udpSock

Definition at line 244 of file rfb.h.

◆ udpSockConnected

rfbBool udpSockConnected

Definition at line 246 of file rfb.h.

◆ underCursorBuffer

char* underCursorBuffer

Definition at line 282 of file rfb.h.

◆ underCursorBufferLen

int underCursorBufferLen

Definition at line 281 of file rfb.h.

◆ versionString

char* versionString

rfbEncodingServerIdentity

Definition at line 330 of file rfb.h.

◆ whitePixel

rfbPixel whitePixel

Definition at line 212 of file rfb.h.

◆ width

int width

Definition at line 204 of file rfb.h.

◆ xvpHook

rfbXvpHookPtr xvpHook

xvpHook is called to handle an xvp client message

Definition at line 342 of file rfb.h.


The documentation for this struct was generated from the following file: