LibVNCServer/LibVNCClient
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Public Types | Data Fields
rfbClientPtr Struct Reference

#include <rfb.h>

Public Types

enum  {
  RFB_PROTOCOL_VERSION, RFB_SECURITY_TYPE, RFB_AUTHENTICATION, RFB_INITIALISATION,
  RFB_NORMAL, RFB_INITIALISATION_SHARED
}
 Possible client states: More...
 

Data Fields

rfbScreenInfoPtr screen
 back pointer to the screen More...
 
rfbScreenInfoPtr scaledScreen
 points to a scaled version of the screen buffer in cl->scaledScreenList More...
 
rfbBool PalmVNC
 how did the client tell us it wanted the screen changed? Ultra style or palm style? More...
 
void * clientData
 private data. More...
 
ClientGoneHookPtr clientGoneHook
 
SOCKET sock
 
char * host
 
int protocolMajorVersion
 
int protocolMinorVersion
 
enum rfbClientRec:: { ... }  state
 Possible client states: More...
 
rfbBool reverseConnection
 
rfbBool onHold
 
rfbBool readyForSetColourMapEntries
 
rfbBool useCopyRect
 
int preferredEncoding
 
int correMaxWidth
 
int correMaxHeight
 
rfbBool viewOnly
 
uint8_t authChallenge [CHALLENGESIZE]
 
sraRegionPtr copyRegion
 the destination region of the copy More...
 
int copyDX
 
int copyDY
 the translation by which the copy happens More...
 
sraRegionPtr modifiedRegion
 
sraRegionPtr requestedRegion
 As part of the FramebufferUpdateRequest, a client can express interest in a subrectangle of the whole framebuffer. More...
 
struct timeval startDeferring
 The following member represents the state of the "deferred update" timer. More...
 
struct timeval startPtrDeferring
 
int lastPtrX
 
int lastPtrY
 
int lastPtrButtons
 
rfbTranslateFnType translateFn
 translateFn points to the translation function which is used to copy and translate a rectangle from the framebuffer to an output buffer. More...
 
char * translateLookupTable
 
rfbPixelFormat format
 
char updateBuf [UPDATE_BUF_SIZE]
 
int ublen
 
struct _rfbStatList * statEncList
 
struct _rfbStatList * statMsgList
 
int rawBytesEquivalent
 
int bytesSent
 
rfbBool compStreamInitedLZO
 
char * lzoWrkMem
 
rfbFileTransferData fileTransfer
 
int lastKeyboardLedState
 keep track of last value so we can send change events More...
 
rfbBool enableSupportedMessages
 client supports SupportedMessages encoding More...
 
rfbBool enableSupportedEncodings
 client supports SupportedEncodings encoding More...
 
rfbBool enableServerIdentity
 client supports ServerIdentity encoding More...
 
rfbBool enableKeyboardLedState
 client supports KeyboardState encoding More...
 
rfbBool enableLastRectEncoding
 client supports LastRect encoding More...
 
rfbBool enableCursorShapeUpdates
 client supports cursor shape updates More...
 
rfbBool enableCursorPosUpdates
 client supports cursor position updates More...
 
rfbBool useRichCursorEncoding
 rfbEncodingRichCursor is preferred More...
 
rfbBool cursorWasChanged
 cursor shape update should be sent More...
 
rfbBool cursorWasMoved
 cursor position update should be sent More...
 
int cursorX
 
int cursorY
 the coordinates of the cursor, if enableCursorShapeUpdates = FALSE More...
 
rfbBool useNewFBSize
 client supports NewFBSize encoding More...
 
rfbBool newFBSizePending
 framebuffer size was changed More...
 
struct _rfbClientRec * prev
 
struct _rfbClientRec * next
 
int progressiveSliceY
 if progressive updating is on, this variable holds the current y coordinate of the progressive slice. More...
 
rfbExtensionDataextensions
 
char * zrleBeforeBuf
 for threaded zrle More...
 
void * paletteHelper
 
char * beforeEncBuf
 for thread safety for rfbSendFBUpdate() More...
 
int beforeEncBufSize
 
char * afterEncBuf
 
int afterEncBufSize
 
int afterEncBufLen
 

Detailed Description

Definition at line 441 of file 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

RFB_INITIALISATION_SHARED 

sending initialisation messages with implicit shared-flag already true

Definition at line 498 of file rfb.h.

Field Documentation

char* afterEncBuf

Definition at line 681 of file rfb.h.

int afterEncBufLen

Definition at line 683 of file rfb.h.

int afterEncBufSize

Definition at line 682 of file rfb.h.

uint8_t authChallenge[CHALLENGESIZE]

Definition at line 521 of file rfb.h.

char* beforeEncBuf

for thread safety for rfbSendFBUpdate()

Definition at line 679 of file rfb.h.

int beforeEncBufSize

Definition at line 680 of file rfb.h.

int bytesSent

Definition at line 592 of file rfb.h.

void* 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 458 of file rfb.h.

ClientGoneHookPtr clientGoneHook

Definition at line 459 of file rfb.h.

rfbBool compStreamInitedLZO

Definition at line 615 of file rfb.h.

int copyDX

Definition at line 547 of file rfb.h.

int copyDY

the translation by which the copy happens

Definition at line 547 of file rfb.h.

sraRegionPtr copyRegion

the destination region of the copy

Definition at line 546 of file rfb.h.

int correMaxHeight

Definition at line 516 of file rfb.h.

int correMaxWidth

Definition at line 516 of file rfb.h.

rfbBool cursorWasChanged

cursor shape update should be sent

Definition at line 629 of file rfb.h.

rfbBool cursorWasMoved

cursor position update should be sent

Definition at line 630 of file rfb.h.

int cursorX

Definition at line 631 of file rfb.h.

int cursorY

the coordinates of the cursor, if enableCursorShapeUpdates = FALSE

Definition at line 631 of file rfb.h.

rfbBool enableCursorPosUpdates

client supports cursor position updates

Definition at line 627 of file rfb.h.

rfbBool enableCursorShapeUpdates

client supports cursor shape updates

Definition at line 626 of file rfb.h.

rfbBool enableKeyboardLedState

client supports KeyboardState encoding

Definition at line 624 of file rfb.h.

rfbBool enableLastRectEncoding

client supports LastRect encoding

Definition at line 625 of file rfb.h.

rfbBool enableServerIdentity

client supports ServerIdentity encoding

Definition at line 623 of file rfb.h.

rfbBool enableSupportedEncodings

client supports SupportedEncodings encoding

Definition at line 622 of file rfb.h.

rfbBool enableSupportedMessages

client supports SupportedMessages encoding

Definition at line 621 of file rfb.h.

rfbExtensionData* extensions

Definition at line 665 of file rfb.h.

rfbFileTransferData fileTransfer

Definition at line 618 of file rfb.h.

Definition at line 575 of file rfb.h.

char* host

Definition at line 462 of file rfb.h.

int lastKeyboardLedState

keep track of last value so we can send change events

Definition at line 620 of file rfb.h.

int lastPtrButtons

Definition at line 568 of file rfb.h.

int lastPtrX

Definition at line 566 of file rfb.h.

int lastPtrY

Definition at line 567 of file rfb.h.

char* lzoWrkMem

Definition at line 616 of file rfb.h.

sraRegionPtr modifiedRegion

Definition at line 549 of file rfb.h.

rfbBool newFBSizePending

framebuffer size was changed

Definition at line 635 of file rfb.h.

struct _rfbClientRec* next

Definition at line 638 of file rfb.h.

rfbBool onHold

Definition at line 512 of file rfb.h.

void* paletteHelper

Definition at line 669 of file rfb.h.

rfbBool PalmVNC

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

Definition at line 449 of file rfb.h.

int preferredEncoding

Definition at line 515 of file rfb.h.

struct _rfbClientRec* prev

Definition at line 637 of file rfb.h.

int progressiveSliceY

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

Definition at line 663 of file rfb.h.

int protocolMajorVersion

Definition at line 465 of file rfb.h.

int protocolMinorVersion

Definition at line 466 of file rfb.h.

int rawBytesEquivalent

Definition at line 591 of file rfb.h.

rfbBool readyForSetColourMapEntries

Definition at line 513 of file rfb.h.

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

rfbBool reverseConnection

Definition at line 511 of file rfb.h.

rfbScreenInfoPtr scaledScreen

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

Definition at line 447 of file rfb.h.

rfbScreenInfoPtr screen

back pointer to the screen

Definition at line 444 of file rfb.h.

SOCKET sock

Definition at line 461 of file rfb.h.

struct timeval 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 564 of file rfb.h.

struct timeval startPtrDeferring

Definition at line 565 of file rfb.h.

enum { ... } state

Possible client states:

struct _rfbStatList* statEncList

Definition at line 589 of file rfb.h.

struct _rfbStatList* statMsgList

Definition at line 590 of file rfb.h.

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

char* translateLookupTable

Definition at line 574 of file rfb.h.

int ublen

Definition at line 586 of file rfb.h.

char updateBuf[UPDATE_BUF_SIZE]

Definition at line 585 of file rfb.h.

rfbBool useCopyRect

Definition at line 514 of file rfb.h.

rfbBool useNewFBSize

client supports NewFBSize encoding

Definition at line 634 of file rfb.h.

rfbBool useRichCursorEncoding

rfbEncodingRichCursor is preferred

Definition at line 628 of file rfb.h.

rfbBool viewOnly

Definition at line 518 of file rfb.h.

char* zrleBeforeBuf

for threaded zrle

Definition at line 668 of file rfb.h.


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