#include <rfbclient.h>

Data Fields
uint8_t *	frameBuffer
int	width
int	height
int	endianTest
AppData	appData
const char *	programName
char *	serverHost
int	serverPort
	if -1, then use file recorded by vncrec
rfbBool	listenSpecified
int	listenPort
int	flashPort
struct {
int x
int y
int w
int h
}	updateRect
char	buffer [RFB_BUFFER_SIZE]
int	sock
rfbBool	canUseCoRRE
rfbBool	canUseHextile
char *	desktopName
rfbPixelFormat	format
rfbServerInitMsg	si
char	buf [RFB_BUF_SIZE]
char *	bufoutptr
int	buffered
int	ultra_buffer_size
char *	ultra_buffer
int	raw_buffer_size
char *	raw_buffer
uint8_t *	rcSource
uint8_t *	rcMask
rfbClientData *	clientData
	private data pointer
rfbVNCRec *	vncRec
int	KeyboardLedStateEnabled
int	CurrentKeyboardLedState
int	canHandleNewFBSize
HandleTextChatProc	HandleTextChat
HandleKeyboardLedStateProc	HandleKeyboardLedState
HandleCursorPosProc	HandleCursorPos
SoftCursorLockAreaProc	SoftCursorLockArea
SoftCursorUnlockScreenProc	SoftCursorUnlockScreen
GotFrameBufferUpdateProc	GotFrameBufferUpdate
GetPasswordProc	GetPassword
	the pointer returned by GetPassword will be freed after use!
MallocFrameBufferProc	MallocFrameBuffer
GotXCutTextProc	GotXCutText
BellProc	Bell
GotCursorShapeProc	GotCursorShape
GotCopyRectProc	GotCopyRect
rfbSupportedMessages	supportedMessages
	Which messages are supported by the server This is a guess for most servers.
int	major
	negotiated protocol version
int	minor
uint32_t	authScheme
	The selected security types.
uint32_t	subAuthScheme
void *	tlsSession
	The TLS session for Anonymous TLS and VeNCrypt.
GetCredentialProc	GetCredential
	To support security types that requires user input (except VNC password authentication), for example VeNCrypt and MSLogon, this callback function must be set before the authentication.
uint32_t *	clientAuthSchemes
	The 0-terminated security types supported by the client.
char *	destHost
	When the server is a repeater, this specifies the final destination.
int	destPort
int	QoS_DSCP
	the QoS IP DSCP for this client
HandleXvpMsgProc	HandleXvpMsg
	hook to handle xvp server messages
int	listenSock
FinishedFrameBufferUpdateProc	FinishedFrameBufferUpdate
char *	listenAddress
int	listen6Sock
char *	listen6Address
int	listen6Port

Detailed Description

Examples:: ppmtest.c, SDLvncviewer.c, and vnc2mpg.c.

Definition at line 176 of file rfbclient.h.

Field Documentation

AppData appData

Examples:: vnc2mpg.c.

Definition at line 182 of file rfbclient.h.

uint32_t authScheme

The selected security types.

Definition at line 312 of file rfbclient.h.

BellProc Bell

Definition at line 293 of file rfbclient.h.

char buf[RFB_BUF_SIZE]

Definition at line 213 of file rfbclient.h.

char buffer[RFB_BUFFER_SIZE]

Definition at line 200 of file rfbclient.h.

int buffered

Definition at line 215 of file rfbclient.h.

char* bufoutptr

Definition at line 214 of file rfbclient.h.

int canHandleNewFBSize

Examples:: SDLvncviewer.c.

Definition at line 280 of file rfbclient.h.

rfbBool canUseCoRRE

Definition at line 205 of file rfbclient.h.

rfbBool canUseHextile

Definition at line 206 of file rfbclient.h.

uint32_t* clientAuthSchemes

The 0-terminated security types supported by the client.

Set by function SetClientAuthSchemes()

Definition at line 327 of file rfbclient.h.

rfbClientData* clientData

private data pointer

Definition at line 272 of file rfbclient.h.

int CurrentKeyboardLedState

Definition at line 278 of file rfbclient.h.

char* desktopName

Examples:: ppmtest.c, and SDLvncviewer.c.

Definition at line 207 of file rfbclient.h.

char* destHost

When the server is a repeater, this specifies the final destination.

Definition at line 330 of file rfbclient.h.

int destPort

Definition at line 331 of file rfbclient.h.

int endianTest

Definition at line 180 of file rfbclient.h.

FinishedFrameBufferUpdateProc FinishedFrameBufferUpdate

Definition at line 342 of file rfbclient.h.

int flashPort

Definition at line 188 of file rfbclient.h.

rfbPixelFormat format

Examples:: ppmtest.c, SDLvncviewer.c, and vnc2mpg.c.

Definition at line 208 of file rfbclient.h.

uint8_t* frameBuffer

Examples:: ppmtest.c, SDLvncviewer.c, and vnc2mpg.c.

Definition at line 177 of file rfbclient.h.

GetCredentialProc GetCredential

To support security types that requires user input (except VNC password authentication), for example VeNCrypt and MSLogon, this callback function must be set before the authentication.

Otherwise, it implicates that the caller application does not support it and related security types should be bypassed.

Definition at line 323 of file rfbclient.h.

GetPasswordProc GetPassword

the pointer returned by GetPassword will be freed after use!

Definition at line 290 of file rfbclient.h.

GotCopyRectProc GotCopyRect

Definition at line 296 of file rfbclient.h.

GotCursorShapeProc GotCursorShape

Definition at line 295 of file rfbclient.h.

GotFrameBufferUpdateProc GotFrameBufferUpdate

Examples:: ppmtest.c, SDLvncviewer.c, and vnc2mpg.c.

Definition at line 288 of file rfbclient.h.

GotXCutTextProc GotXCutText

Examples:: SDLvncviewer.c.

Definition at line 292 of file rfbclient.h.

int h

Examples:: SDLvncviewer.c.

Definition at line 191 of file rfbclient.h.

HandleCursorPosProc HandleCursorPos

Definition at line 285 of file rfbclient.h.

HandleKeyboardLedStateProc HandleKeyboardLedState

Examples:: SDLvncviewer.c.

Definition at line 284 of file rfbclient.h.

HandleTextChatProc HandleTextChat

Examples:: SDLvncviewer.c.

Definition at line 283 of file rfbclient.h.

HandleXvpMsgProc HandleXvpMsg

hook to handle xvp server messages

Definition at line 337 of file rfbclient.h.

int height

Examples:: ppmtest.c, SDLvncviewer.c, and vnc2mpg.c.

Definition at line 178 of file rfbclient.h.

int KeyboardLedStateEnabled

Definition at line 277 of file rfbclient.h.

char* listen6Address

Definition at line 347 of file rfbclient.h.

int listen6Port

Examples:: SDLvncviewer.c.

Definition at line 348 of file rfbclient.h.

int listen6Sock

Definition at line 346 of file rfbclient.h.

char* listenAddress

Definition at line 344 of file rfbclient.h.

int listenPort

Examples:: SDLvncviewer.c.

Definition at line 188 of file rfbclient.h.

int listenSock

Definition at line 340 of file rfbclient.h.

rfbBool listenSpecified

Definition at line 187 of file rfbclient.h.

int major

negotiated protocol version

Definition at line 309 of file rfbclient.h.

MallocFrameBufferProc MallocFrameBuffer

Examples:: SDLvncviewer.c, and vnc2mpg.c.

Definition at line 291 of file rfbclient.h.

int minor

Definition at line 309 of file rfbclient.h.

const char* programName

Definition at line 184 of file rfbclient.h.

int QoS_DSCP

the QoS IP DSCP for this client

Definition at line 334 of file rfbclient.h.

char* raw_buffer

Definition at line 229 of file rfbclient.h.

int raw_buffer_size

Definition at line 228 of file rfbclient.h.

uint8_t * rcMask

Definition at line 269 of file rfbclient.h.

uint8_t* rcSource

Definition at line 269 of file rfbclient.h.

char* serverHost

Definition at line 185 of file rfbclient.h.

int serverPort

if -1, then use file recorded by vncrec

Examples:: vnc2mpg.c.

Definition at line 186 of file rfbclient.h.

rfbServerInitMsg si

Definition at line 209 of file rfbclient.h.

int sock

Definition at line 204 of file rfbclient.h.

SoftCursorLockAreaProc SoftCursorLockArea

Definition at line 286 of file rfbclient.h.

SoftCursorUnlockScreenProc SoftCursorUnlockScreen

Definition at line 287 of file rfbclient.h.

uint32_t subAuthScheme

Definition at line 312 of file rfbclient.h.

rfbSupportedMessages supportedMessages

Which messages are supported by the server This is a *guess* for most servers.

(If we can even detect the type of server)

If the server supports the "rfbEncodingSupportedMessages" then this will be updated when the encoding is received to accurately reflect the servers capabilities.

Definition at line 306 of file rfbclient.h.

void* tlsSession

The TLS session for Anonymous TLS and VeNCrypt.

Definition at line 315 of file rfbclient.h.

char* ultra_buffer

Definition at line 226 of file rfbclient.h.

int ultra_buffer_size

Definition at line 225 of file rfbclient.h.

struct { ... } updateRect