Data Fields

rfbScreenInfoPtr Struct Reference
[LibVNCServer API 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
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.
rfbPixelFormat serverFormat
rfbColourMap colourMap
 set this if rfbServerFormat.trueColour==FALSE
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.
int maxRectsPerUpdate
 send only this many rectangles in one update
int deferUpdateTime
 this is the amount of milliseconds to wait at least before sending an update.
rfbBool alwaysShared
rfbBool neverShared
rfbBool dontDisconnect
struct _rfbClientRec * clientHead
struct _rfbClientRec * pointerClient
 "Mutex" for pointer events
int cursorX
int cursorY
int underCursorBufferLen
char * underCursorBuffer
rfbBool dontConvertRichCursorToXCursor
struct rfbCursorcursor
char * frameBuffer
 the frameBuffer has to be supplied by the serving process.
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
rfbDisplayHookPtr displayHook
 displayHook is called just before a frame buffer update
rfbGetKeyboardLedStateHookPtr getKeyboardLedStateHook
 These hooks are called to pass keyboard state back to the client.
rfbBool ignoreSIGPIPE
 if TRUE, an ignoring signal handler is installed for SIGPIPE
int progressiveSliceHeight
 if not zero, only a slice of this height is processed every time an update should be sent.
in_addr_t listenInterface
int deferPtrUpdateTime
rfbBool handleEventsEagerly
 handle as many input events as possible (default off)
char * versionString
 rfbEncodingServerIdentity
int protocolMajorVersion
 What does the server tell the new clients which version it supports.
int protocolMinorVersion
rfbBool permitFileTransfer
 command line authorization of file transfers
rfbDisplayFinishedHookPtr displayFinishedHook
 displayFinishedHook is called just after a frame buffer update
rfbXvpHookPtr xvpHook
 xvpHook is called to handle an xvp client message
int ipv6port
 The port to listen on when using IPv6.
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.

Definition at line 310 of file rfb.h.

Definition at line 297 of file rfb.h.

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

Definition at line 300 of file rfb.h.

Definition at line 265 of file rfb.h.

Definition at line 245 of file rfb.h.

Definition at line 248 of file rfb.h.

struct _rfbClientRec* clientHead

Definition at line 313 of file rfb.h.

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.

Definition at line 361 of file rfb.h.

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.

displayFinishedHook is called just after a frame buffer update

Definition at line 377 of file rfb.h.

displayHook is called just before a frame buffer update

Definition at line 342 of file rfb.h.

Definition at line 320 of file rfb.h.

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.

Definition at line 336 of file rfb.h.

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

Definition at line 345 of file rfb.h.

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.

Definition at line 290 of file rfb.h.

Definition at line 289 of file rfb.h.

Definition at line 391 of file rfb.h.

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.

if TRUE, an ignoring signal handler is installed for SIGPIPE

Definition at line 353 of file rfb.h.

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.

Definition at line 328 of file rfb.h.

Definition at line 329 of file rfb.h.

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.

Definition at line 286 of file rfb.h.

int maxFd

Definition at line 269 of file rfb.h.

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.

Definition at line 311 of file rfb.h.

newClientHook is called just after a new client is created

Definition at line 340 of file rfb.h.

Definition at line 242 of file rfb.h.

Definition at line 296 of file rfb.h.

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.

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.

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

Definition at line 370 of file rfb.h.

Definition at line 371 of file rfb.h.

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.

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.

Definition at line 260 of file rfb.h.

Definition at line 335 of file rfb.h.

Definition at line 334 of file rfb.h.

Definition at line 337 of file rfb.h.

Definition at line 333 of file rfb.h.

Definition at line 331 of file rfb.h.

Definition at line 246 of file rfb.h.

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.

Definition at line 283 of file rfb.h.

Definition at line 319 of file rfb.h.

Definition at line 318 of file rfb.h.

rfbEncodingServerIdentity

Definition at line 367 of file rfb.h.

Definition at line 249 of file rfb.h.

int width

Definition at line 241 of file rfb.h.

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:
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines