LibVNCServer/LibVNCClient
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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
 
SOCKET listenSock
 
int maxSock
 
int maxFd
 
fd_set allFds
 
enum rfbSocketState socketState
 
SOCKET inetdSock
 
rfbBool inetdInitDone
 
int udpPort
 
SOCKET udpSock
 
struct _rfbClientRec * udpClient
 
rfbBool udpSockConnected
 
struct sockaddr_in udpRemoteAddr
 
int maxClientWait
 
rfbBool httpInitDone
 
rfbBool httpEnableProxyConnect
 
int httpPort
 
char * httpDir
 
SOCKET httpListenSock
 
SOCKET 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...
 
int ipv6port
 The port to listen on when using IPv6. More...
 
char * listen6Interface
 
SOCKET listen6Sock
 
int http6Port
 
SOCKET httpListen6Sock
 

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 235 of file rfb.h.

Field Documentation

fd_set allFds

Definition at line 273 of file rfb.h.

rfbBool alwaysShared

Definition at line 310 of file rfb.h.

void* authPasswdData

Definition at line 297 of file rfb.h.

int authPasswdFirstViewOnly

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

Definition at line 300 of file rfb.h.

rfbBool autoPort

Definition at line 265 of file rfb.h.

int bitsPerPixel

Definition at line 245 of file rfb.h.

rfbPixel blackPixel

Definition at line 248 of file rfb.h.

struct _rfbClientRec* clientHead

Definition at line 313 of file rfb.h.

rfbColourMap colourMap

set this if rfbServerFormat.trueColour==FALSE

Definition at line 261 of file rfb.h.

struct rfbCursor* cursor

Definition at line 321 of file rfb.h.

int cursorX

Definition at line 318 of file rfb.h.

int cursorY

Definition at line 318 of file rfb.h.

int deferPtrUpdateTime

Definition at line 361 of file rfb.h.

int deferUpdateTime

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

Definition at line 306 of file rfb.h.

int depth

Definition at line 244 of file rfb.h.

const char* desktopName

Definition at line 262 of file rfb.h.

rfbDisplayFinishedHookPtr displayFinishedHook

displayFinishedHook is called just after a frame buffer update

Definition at line 377 of file rfb.h.

rfbDisplayHookPtr displayHook

displayHook is called just before a frame buffer update

Definition at line 342 of file rfb.h.

rfbBool dontConvertRichCursorToXCursor

Definition at line 320 of file rfb.h.

rfbBool dontDisconnect

Definition at line 312 of file rfb.h.

char* frameBuffer

the frameBuffer has to be supplied by the serving process.

The buffer will not be freed by

Definition at line 327 of file rfb.h.

rfbGetCursorProcPtr getCursorPtr

Definition at line 332 of file rfb.h.

rfbFileTransferPermitted getFileTransferPermission

Definition at line 336 of file rfb.h.

rfbGetKeyboardLedStateHookPtr getKeyboardLedStateHook

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

Definition at line 345 of file rfb.h.

rfbBool handleEventsEagerly

handle as many input events as possible (default off)

Definition at line 364 of file rfb.h.

int height

Definition at line 243 of file rfb.h.

int http6Port

Definition at line 390 of file rfb.h.

char* httpDir

Definition at line 292 of file rfb.h.

rfbBool httpEnableProxyConnect

Definition at line 290 of file rfb.h.

rfbBool httpInitDone

Definition at line 289 of file rfb.h.

SOCKET httpListen6Sock

Definition at line 391 of file rfb.h.

SOCKET httpListenSock

Definition at line 293 of file rfb.h.

int httpPort

Definition at line 291 of file rfb.h.

SOCKET httpSock

Definition at line 294 of file rfb.h.

rfbBool ignoreSIGPIPE

if TRUE, an ignoring signal handler is installed for SIGPIPE

Definition at line 353 of file rfb.h.

rfbBool inetdInitDone

Definition at line 278 of file rfb.h.

SOCKET inetdSock

Definition at line 277 of file rfb.h.

int ipv6port

The port to listen on when using IPv6.

Definition at line 384 of file rfb.h.

rfbKbdAddEventProcPtr kbdAddEvent

Definition at line 328 of file rfb.h.

rfbKbdReleaseAllKeysProcPtr kbdReleaseAllKeys

Definition at line 329 of file rfb.h.

char* listen6Interface

Definition at line 385 of file rfb.h.

SOCKET listen6Sock

Definition at line 389 of file rfb.h.

in_addr_t listenInterface

Definition at line 360 of file rfb.h.

SOCKET listenSock

Definition at line 267 of file rfb.h.

int maxClientWait

Definition at line 286 of file rfb.h.

int maxFd

Definition at line 269 of file rfb.h.

int maxRectsPerUpdate

send only this many rectangles in one update

Definition at line 303 of file rfb.h.

int maxSock

Definition at line 268 of file rfb.h.

rfbBool neverShared

Definition at line 311 of file rfb.h.

rfbNewClientHookPtr newClientHook

newClientHook is called just after a new client is created

Definition at line 340 of file rfb.h.

int paddedWidthInBytes

Definition at line 242 of file rfb.h.

rfbPasswordCheckProcPtr passwordCheck

Definition at line 296 of file rfb.h.

rfbBool permitFileTransfer

command line authorization of file transfers

Definition at line 374 of file rfb.h.

struct _rfbClientRec* pointerClient

"Mutex" for pointer events

Definition at line 314 of file rfb.h.

int port

Definition at line 266 of file rfb.h.

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 358 of file rfb.h.

int protocolMajorVersion

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

Definition at line 370 of file rfb.h.

int protocolMinorVersion

Definition at line 371 of file rfb.h.

rfbPtrAddEventProcPtr ptrAddEvent

Definition at line 330 of file rfb.h.

struct _rfbScreenInfo* scaledScreenNext

this structure has children that are scaled versions of this screen

Definition at line 238 of file rfb.h.

int scaledScreenRefCount

Definition at line 239 of file rfb.h.

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 256 of file rfb.h.

rfbPixelFormat serverFormat

Definition at line 260 of file rfb.h.

rfbSetServerInputProcPtr setServerInput

Definition at line 335 of file rfb.h.

rfbSetSingleWindowProcPtr setSingleWindow

Definition at line 334 of file rfb.h.

rfbSetTextChat setTextChat

Definition at line 337 of file rfb.h.

rfbSetTranslateFunctionProcPtr setTranslateFunction

Definition at line 333 of file rfb.h.

rfbSetXCutTextProcPtr setXCutText

Definition at line 331 of file rfb.h.

int sizeInBytes

Definition at line 246 of file rfb.h.

enum rfbSocketState socketState

Definition at line 276 of file rfb.h.

char thisHost[255]

Definition at line 263 of file rfb.h.

struct _rfbClientRec* udpClient

Definition at line 282 of file rfb.h.

int udpPort

Definition at line 280 of file rfb.h.

struct sockaddr_in udpRemoteAddr

Definition at line 284 of file rfb.h.

SOCKET udpSock

Definition at line 281 of file rfb.h.

rfbBool udpSockConnected

Definition at line 283 of file rfb.h.

char* underCursorBuffer

Definition at line 319 of file rfb.h.

int underCursorBufferLen

Definition at line 318 of file rfb.h.

char* versionString

rfbEncodingServerIdentity

Definition at line 367 of file rfb.h.

rfbPixel whitePixel

Definition at line 249 of file rfb.h.

int width

Definition at line 241 of file rfb.h.

rfbXvpHookPtr xvpHook

xvpHook is called to handle an xvp client message

Definition at line 379 of file rfb.h.


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