_rfbScreenInfo Struct Reference

#include <rfb.h>

Public Attributes
fd_set	allFds
rfbBool	alwaysShared
void *	authPasswdData
int	authPasswdFirstViewOnly
rfbBool	autoPort
int	bitsPerPixel
rfbPixel	blackPixel
struct _rfbClientRec *	clientHead
rfbColourMap	colourMap
struct rfbCursor *	cursor
int	cursorX
int	cursorY
int	deferPtrUpdateTime
int	deferUpdateTime
int	depth
const char *	desktopName
rfbDisplayFinishedHookPtr	displayFinishedHook
rfbDisplayHookPtr	displayHook
rfbBool	dontConvertRichCursorToXCursor
rfbBool	dontDisconnect
char *	frameBuffer
rfbGetCursorProcPtr	getCursorPtr
rfbFileTransferPermitted	getFileTransferPermission
rfbGetKeyboardLedStateHookPtr	getKeyboardLedStateHook
rfbBool	handleEventsEagerly
int	height
char *	httpDir
rfbBool	httpEnableProxyConnect
rfbBool	httpInitDone
SOCKET	httpListenSock
int	httpPort
SOCKET	httpSock
rfbBool	ignoreSIGPIPE
rfbBool	inetdInitDone
SOCKET	inetdSock
rfbKbdAddEventProcPtr	kbdAddEvent
rfbKbdReleaseAllKeysProcPtr	kbdReleaseAllKeys
in_addr_t	listenInterface
SOCKET	listenSock
int	maxClientWait
int	maxFd
int	maxRectsPerUpdate
int	maxSock
rfbBool	neverShared
rfbNewClientHookPtr	newClientHook
int	paddedWidthInBytes
rfbPasswordCheckProcPtr	passwordCheck
rfbBool	permitFileTransfer
struct _rfbClientRec *	pointerClient
int	port
int	progressiveSliceHeight
int	protocolMajorVersion
int	protocolMinorVersion
rfbPtrAddEventProcPtr	ptrAddEvent
struct _rfbScreenInfo *	scaledScreenNext
int	scaledScreenRefCount
void *	screenData
rfbPixelFormat	serverFormat
rfbSetServerInputProcPtr	setServerInput
rfbSetSingleWindowProcPtr	setSingleWindow
rfbSetTextChat	setTextChat
rfbSetTranslateFunctionProcPtr	setTranslateFunction
rfbSetXCutTextProcPtr	setXCutText
int	sizeInBytes
enum rfbSocketState	socketState
char	thisHost [255]
struct _rfbClientRec *	udpClient
int	udpPort
struct sockaddr_in	udpRemoteAddr
SOCKET	udpSock
rfbBool	udpSockConnected
char *	underCursorBuffer
int	underCursorBufferLen
char *	versionString
rfbPixel	whitePixel
int	width
rfbXvpHookPtr	xvpHook

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 226 of file libvncserver/rfb/rfb.h.

Member Data Documentation

fd_set _rfbScreenInfo::allFds

Definition at line 264 of file libvncserver/rfb/rfb.h.

rfbBool _rfbScreenInfo::alwaysShared

Definition at line 301 of file libvncserver/rfb/rfb.h.

void* _rfbScreenInfo::authPasswdData

Definition at line 288 of file libvncserver/rfb/rfb.h.

int _rfbScreenInfo::authPasswdFirstViewOnly

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

Definition at line 291 of file libvncserver/rfb/rfb.h.

rfbBool _rfbScreenInfo::autoPort

Definition at line 256 of file libvncserver/rfb/rfb.h.

int _rfbScreenInfo::bitsPerPixel

Definition at line 236 of file libvncserver/rfb/rfb.h.

rfbPixel _rfbScreenInfo::blackPixel

Definition at line 239 of file libvncserver/rfb/rfb.h.

struct _rfbClientRec* _rfbScreenInfo::clientHead

Definition at line 304 of file libvncserver/rfb/rfb.h.

rfbColourMap _rfbScreenInfo::colourMap

set this if rfbServerFormat.trueColour==FALSE

Definition at line 252 of file libvncserver/rfb/rfb.h.

struct rfbCursor* _rfbScreenInfo::cursor

Definition at line 312 of file libvncserver/rfb/rfb.h.

int _rfbScreenInfo::cursorX

Definition at line 309 of file libvncserver/rfb/rfb.h.

int _rfbScreenInfo::cursorY

Definition at line 309 of file libvncserver/rfb/rfb.h.

int _rfbScreenInfo::deferPtrUpdateTime

Definition at line 352 of file libvncserver/rfb/rfb.h.

int _rfbScreenInfo::deferUpdateTime

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

Definition at line 297 of file libvncserver/rfb/rfb.h.

int _rfbScreenInfo::depth

Definition at line 235 of file libvncserver/rfb/rfb.h.

const char* _rfbScreenInfo::desktopName

Definition at line 253 of file libvncserver/rfb/rfb.h.

rfbDisplayFinishedHookPtr _rfbScreenInfo::displayFinishedHook

displayFinishedHook is called just after a frame buffer update

Definition at line 368 of file libvncserver/rfb/rfb.h.

rfbDisplayHookPtr _rfbScreenInfo::displayHook

displayHook is called just before a frame buffer update

Definition at line 333 of file libvncserver/rfb/rfb.h.

rfbBool _rfbScreenInfo::dontConvertRichCursorToXCursor

Definition at line 311 of file libvncserver/rfb/rfb.h.

rfbBool _rfbScreenInfo::dontDisconnect

Definition at line 303 of file libvncserver/rfb/rfb.h.

char* _rfbScreenInfo::frameBuffer

the frameBuffer has to be supplied by the serving process.

The buffer will not be freed by

Definition at line 318 of file libvncserver/rfb/rfb.h.

rfbGetCursorProcPtr _rfbScreenInfo::getCursorPtr

Definition at line 323 of file libvncserver/rfb/rfb.h.

rfbFileTransferPermitted _rfbScreenInfo::getFileTransferPermission

Definition at line 327 of file libvncserver/rfb/rfb.h.

rfbGetKeyboardLedStateHookPtr _rfbScreenInfo::getKeyboardLedStateHook

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

Definition at line 336 of file libvncserver/rfb/rfb.h.

rfbBool _rfbScreenInfo::handleEventsEagerly

handle as many input events as possible (default off)

Definition at line 355 of file libvncserver/rfb/rfb.h.

int _rfbScreenInfo::height

Definition at line 234 of file libvncserver/rfb/rfb.h.

char* _rfbScreenInfo::httpDir

Definition at line 283 of file libvncserver/rfb/rfb.h.

rfbBool _rfbScreenInfo::httpEnableProxyConnect

Definition at line 281 of file libvncserver/rfb/rfb.h.

rfbBool _rfbScreenInfo::httpInitDone

Definition at line 280 of file libvncserver/rfb/rfb.h.

SOCKET _rfbScreenInfo::httpListenSock

Definition at line 284 of file libvncserver/rfb/rfb.h.

int _rfbScreenInfo::httpPort

Definition at line 282 of file libvncserver/rfb/rfb.h.

SOCKET _rfbScreenInfo::httpSock

Definition at line 285 of file libvncserver/rfb/rfb.h.

rfbBool _rfbScreenInfo::ignoreSIGPIPE

if TRUE, an ignoring signal handler is installed for SIGPIPE

Definition at line 344 of file libvncserver/rfb/rfb.h.

rfbBool _rfbScreenInfo::inetdInitDone

Definition at line 269 of file libvncserver/rfb/rfb.h.

SOCKET _rfbScreenInfo::inetdSock

Definition at line 268 of file libvncserver/rfb/rfb.h.

rfbKbdAddEventProcPtr _rfbScreenInfo::kbdAddEvent

Definition at line 319 of file libvncserver/rfb/rfb.h.

rfbKbdReleaseAllKeysProcPtr _rfbScreenInfo::kbdReleaseAllKeys

Definition at line 320 of file libvncserver/rfb/rfb.h.

in_addr_t _rfbScreenInfo::listenInterface

Definition at line 351 of file libvncserver/rfb/rfb.h.

SOCKET _rfbScreenInfo::listenSock

Definition at line 258 of file libvncserver/rfb/rfb.h.

int _rfbScreenInfo::maxClientWait

Definition at line 277 of file libvncserver/rfb/rfb.h.

int _rfbScreenInfo::maxFd

Definition at line 260 of file libvncserver/rfb/rfb.h.

int _rfbScreenInfo::maxRectsPerUpdate

send only this many rectangles in one update

Definition at line 294 of file libvncserver/rfb/rfb.h.

int _rfbScreenInfo::maxSock

Definition at line 259 of file libvncserver/rfb/rfb.h.

rfbBool _rfbScreenInfo::neverShared

Definition at line 302 of file libvncserver/rfb/rfb.h.

rfbNewClientHookPtr _rfbScreenInfo::newClientHook

newClientHook is called just after a new client is created

Definition at line 331 of file libvncserver/rfb/rfb.h.

int _rfbScreenInfo::paddedWidthInBytes

Definition at line 233 of file libvncserver/rfb/rfb.h.

rfbPasswordCheckProcPtr _rfbScreenInfo::passwordCheck

Definition at line 287 of file libvncserver/rfb/rfb.h.

rfbBool _rfbScreenInfo::permitFileTransfer

command line authorization of file transfers

Definition at line 365 of file libvncserver/rfb/rfb.h.

struct _rfbClientRec* _rfbScreenInfo::pointerClient

"Mutex" for pointer events

Definition at line 305 of file libvncserver/rfb/rfb.h.

int _rfbScreenInfo::port

Definition at line 257 of file libvncserver/rfb/rfb.h.

int _rfbScreenInfo::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 349 of file libvncserver/rfb/rfb.h.

int _rfbScreenInfo::protocolMajorVersion

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

Definition at line 361 of file libvncserver/rfb/rfb.h.

int _rfbScreenInfo::protocolMinorVersion

Definition at line 362 of file libvncserver/rfb/rfb.h.

rfbPtrAddEventProcPtr _rfbScreenInfo::ptrAddEvent

Definition at line 321 of file libvncserver/rfb/rfb.h.

struct _rfbScreenInfo* _rfbScreenInfo::scaledScreenNext

this structure has children that are scaled versions of this screen

Definition at line 229 of file libvncserver/rfb/rfb.h.

int _rfbScreenInfo::scaledScreenRefCount

Definition at line 230 of file libvncserver/rfb/rfb.h.

void* _rfbScreenInfo::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 247 of file libvncserver/rfb/rfb.h.

rfbPixelFormat _rfbScreenInfo::serverFormat

Definition at line 251 of file libvncserver/rfb/rfb.h.

rfbSetServerInputProcPtr _rfbScreenInfo::setServerInput

Definition at line 326 of file libvncserver/rfb/rfb.h.

rfbSetSingleWindowProcPtr _rfbScreenInfo::setSingleWindow

Definition at line 325 of file libvncserver/rfb/rfb.h.

rfbSetTextChat _rfbScreenInfo::setTextChat

Definition at line 328 of file libvncserver/rfb/rfb.h.

rfbSetTranslateFunctionProcPtr _rfbScreenInfo::setTranslateFunction

Definition at line 324 of file libvncserver/rfb/rfb.h.

rfbSetXCutTextProcPtr _rfbScreenInfo::setXCutText

Definition at line 322 of file libvncserver/rfb/rfb.h.

int _rfbScreenInfo::sizeInBytes

Definition at line 237 of file libvncserver/rfb/rfb.h.

enum rfbSocketState _rfbScreenInfo::socketState

Definition at line 267 of file libvncserver/rfb/rfb.h.

char _rfbScreenInfo::thisHost[255]

Definition at line 254 of file libvncserver/rfb/rfb.h.

struct _rfbClientRec* _rfbScreenInfo::udpClient

Definition at line 273 of file libvncserver/rfb/rfb.h.

int _rfbScreenInfo::udpPort

Definition at line 271 of file libvncserver/rfb/rfb.h.

struct sockaddr_in _rfbScreenInfo::udpRemoteAddr

Definition at line 275 of file libvncserver/rfb/rfb.h.

SOCKET _rfbScreenInfo::udpSock

Definition at line 272 of file libvncserver/rfb/rfb.h.

rfbBool _rfbScreenInfo::udpSockConnected

Definition at line 274 of file libvncserver/rfb/rfb.h.

char* _rfbScreenInfo::underCursorBuffer

Definition at line 310 of file libvncserver/rfb/rfb.h.

int _rfbScreenInfo::underCursorBufferLen

Definition at line 309 of file libvncserver/rfb/rfb.h.

char* _rfbScreenInfo::versionString

rfbEncodingServerIdentity

Definition at line 358 of file libvncserver/rfb/rfb.h.

rfbPixel _rfbScreenInfo::whitePixel

Definition at line 240 of file libvncserver/rfb/rfb.h.

int _rfbScreenInfo::width

Definition at line 232 of file libvncserver/rfb/rfb.h.

rfbXvpHookPtr _rfbScreenInfo::xvpHook

xvpHook is called to handle an xvp client message

Definition at line 370 of file libvncserver/rfb/rfb.h.

---

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

• libvncserver/rfb/rfb.h