_rfbClientRec Struct Reference

#include <rfb.h>

Public Types
enum	{   RFB_PROTOCOL_VERSION, RFB_SECURITY_TYPE, RFB_AUTHENTICATION, RFB_INITIALISATION,   RFB_NORMAL }

Public Attributes
char *	afterEncBuf
int	afterEncBufLen
int	afterEncBufSize
uint8_t	authChallenge [CHALLENGESIZE]
char *	beforeEncBuf
int	beforeEncBufSize
int	bytesSent
void *	clientData
ClientGoneHookPtr	clientGoneHook
rfbBool	compStreamInitedLZO
int	copyDX
int	copyDY
sraRegionPtr	copyRegion
int	correMaxHeight
int	correMaxWidth
rfbBool	cursorWasChanged
rfbBool	cursorWasMoved
int	cursorX
int	cursorY
rfbBool	enableCursorPosUpdates
rfbBool	enableCursorShapeUpdates
rfbBool	enableKeyboardLedState
rfbBool	enableLastRectEncoding
rfbBool	enableServerIdentity
rfbBool	enableSupportedEncodings
rfbBool	enableSupportedMessages
rfbExtensionData *	extensions
rfbFileTransferData	fileTransfer
rfbPixelFormat	format
char *	host
int	lastKeyboardLedState
int	lastPtrButtons
int	lastPtrX
int	lastPtrY
char *	lzoWrkMem
sraRegionPtr	modifiedRegion
rfbBool	newFBSizePending
struct _rfbClientRec *	next
rfbBool	onHold
void *	paletteHelper
rfbBool	PalmVNC
int	preferredEncoding
struct _rfbClientRec *	prev
int	progressiveSliceY
int	protocolMajorVersion
int	protocolMinorVersion
int	rawBytesEquivalent
rfbBool	readyForSetColourMapEntries
sraRegionPtr	requestedRegion
rfbBool	reverseConnection
rfbScreenInfoPtr	scaledScreen
rfbScreenInfoPtr	screen
SOCKET	sock
struct timeval	startDeferring
struct timeval	startPtrDeferring
enum _rfbClientRec:: { ... }	state
struct _rfbStatList *	statEncList
struct _rfbStatList *	statMsgList
rfbTranslateFnType	translateFn
char *	translateLookupTable
int	ublen
char	updateBuf [UPDATE_BUF_SIZE]
rfbBool	useCopyRect
rfbBool	useNewFBSize
rfbBool	useRichCursorEncoding
rfbBool	viewOnly
char *	zrleBeforeBuf

Detailed Description

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

Member Enumeration Documentation

anonymous enum

Possible client states:

Enumerator
RFB_PROTOCOL_VERSION	establishing protocol version
RFB_SECURITY_TYPE	negotiating security (RFB v.3.7)
RFB_AUTHENTICATION	authenticating
RFB_INITIALISATION	sending initialisation messages
RFB_NORMAL	normal protocol messages

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

Member Data Documentation

char* _rfbClientRec::afterEncBuf

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

int _rfbClientRec::afterEncBufLen

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

int _rfbClientRec::afterEncBufSize

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

uint8_t _rfbClientRec::authChallenge[CHALLENGESIZE]

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

char* _rfbClientRec::beforeEncBuf

for thread safety for rfbSendFBUpdate()

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

int _rfbClientRec::beforeEncBufSize

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

int _rfbClientRec::bytesSent

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

void* _rfbClientRec::clientData

private data.

You should put any application client specific data into a struct and let clientData point to it. Don't forget to free the struct via clientGoneHook!

This is useful if the IO functions have to behave client specific.

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

ClientGoneHookPtr _rfbClientRec::clientGoneHook

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

rfbBool _rfbClientRec::compStreamInitedLZO

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

int _rfbClientRec::copyDX

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

int _rfbClientRec::copyDY

the translation by which the copy happens

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

sraRegionPtr _rfbClientRec::copyRegion

the destination region of the copy

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

int _rfbClientRec::correMaxHeight

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

int _rfbClientRec::correMaxWidth

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

rfbBool _rfbClientRec::cursorWasChanged

cursor shape update should be sent

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

rfbBool _rfbClientRec::cursorWasMoved

cursor position update should be sent

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

int _rfbClientRec::cursorX

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

int _rfbClientRec::cursorY

the coordinates of the cursor, if enableCursorShapeUpdates = FALSE

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

rfbBool _rfbClientRec::enableCursorPosUpdates

client supports cursor position updates

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

rfbBool _rfbClientRec::enableCursorShapeUpdates

client supports cursor shape updates

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

rfbBool _rfbClientRec::enableKeyboardLedState

client supports KeyboardState encoding

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

rfbBool _rfbClientRec::enableLastRectEncoding

client supports LastRect encoding

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

rfbBool _rfbClientRec::enableServerIdentity

client supports ServerIdentity encoding

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

rfbBool _rfbClientRec::enableSupportedEncodings

client supports SupportedEncodings encoding

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

rfbBool _rfbClientRec::enableSupportedMessages

client supports SupportedMessages encoding

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

rfbExtensionData* _rfbClientRec::extensions

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

rfbFileTransferData _rfbClientRec::fileTransfer

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

rfbPixelFormat _rfbClientRec::format

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

char* _rfbClientRec::host

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

int _rfbClientRec::lastKeyboardLedState

keep track of last value so we can send change events

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

int _rfbClientRec::lastPtrButtons

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

int _rfbClientRec::lastPtrX

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

int _rfbClientRec::lastPtrY

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

char* _rfbClientRec::lzoWrkMem

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

sraRegionPtr _rfbClientRec::modifiedRegion

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

rfbBool _rfbClientRec::newFBSizePending

framebuffer size was changed

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

struct _rfbClientRec* _rfbClientRec::next

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

rfbBool _rfbClientRec::onHold

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

void* _rfbClientRec::paletteHelper

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

rfbBool _rfbClientRec::PalmVNC

how did the client tell us it wanted the screen changed? Ultra style or palm style?

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

int _rfbClientRec::preferredEncoding

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

struct _rfbClientRec* _rfbClientRec::prev

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

int _rfbClientRec::progressiveSliceY

if progressive updating is on, this variable holds the current y coordinate of the progressive slice.

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

int _rfbClientRec::protocolMajorVersion

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

int _rfbClientRec::protocolMinorVersion

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

int _rfbClientRec::rawBytesEquivalent

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

rfbBool _rfbClientRec::readyForSetColourMapEntries

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

sraRegionPtr _rfbClientRec::requestedRegion

As part of the FramebufferUpdateRequest, a client can express interest in a subrectangle of the whole framebuffer.

This is stored in the requestedRegion member. In the normal case this is the whole framebuffer if the client is ready, empty if it's not.

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

rfbBool _rfbClientRec::reverseConnection

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

rfbScreenInfoPtr _rfbClientRec::scaledScreen

points to a scaled version of the screen buffer in cl->scaledScreenList

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

rfbScreenInfoPtr _rfbClientRec::screen

back pointer to the screen

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

SOCKET _rfbClientRec::sock

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

struct timeval _rfbClientRec::startDeferring

The following member represents the state of the "deferred update" timer.

• when the framebuffer is modified and the client is ready, in most cases it is more efficient to defer sending the update by a few milliseconds so that several changes to the framebuffer can be combined into a single update.

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

struct timeval _rfbClientRec::startPtrDeferring

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

enum { ... } _rfbClientRec::state

Possible client states:

struct _rfbStatList* _rfbClientRec::statEncList

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

struct _rfbStatList* _rfbClientRec::statMsgList

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

rfbTranslateFnType _rfbClientRec::translateFn

translateFn points to the translation function which is used to copy and translate a rectangle from the framebuffer to an output buffer.

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

char* _rfbClientRec::translateLookupTable

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

int _rfbClientRec::ublen

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

char _rfbClientRec::updateBuf[UPDATE_BUF_SIZE]

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

rfbBool _rfbClientRec::useCopyRect

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

rfbBool _rfbClientRec::useNewFBSize

client supports NewFBSize encoding

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

rfbBool _rfbClientRec::useRichCursorEncoding

rfbEncodingRichCursor is preferred

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

rfbBool _rfbClientRec::viewOnly

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

char* _rfbClientRec::zrleBeforeBuf

for threaded zrle

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

---

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

• libvncserver/rfb/rfb.h