libvncserver/rfb/rfbclient.h File Reference

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/time.h>
#include <unistd.h>
#include "rfbproto.h"
#include "keysym.h"

Include dependency graph for libvncserver/rfb/rfbclient.h:

Go to the source code of this file.

Classes
struct	_rfbClient
struct	_rfbClientProtocolExtension
union	_rfbCredential
struct	AppData
struct	rfbClientData
struct	rfbVNCRec

Macros
#define	DEFAULT_SSH_CMD   "/usr/bin/ssh"
#define	DEFAULT_TUNNEL_CMD   (DEFAULT_SSH_CMD " -f -L %L:localhost:%R %H sleep 20")
#define	DEFAULT_VIA_CMD   (DEFAULT_SSH_CMD " -f -L %L:%H:%R %G sleep 20")
#define	FLASH_PORT_OFFSET   5400
#define	LISTEN_PORT_OFFSET   5500
#define	RFB_BUF_SIZE   8192
#define	RFB_BUFFER_SIZE   (640*480)
#define	rfbClientSwap16IfLE(s)   (*(char *)&client->endianTest ? ((((s) & 0xff) << 8) | (((s) >> 8) & 0xff)) : (s))
#define	rfbClientSwap32IfLE(l)
#define	rfbClientSwap64IfLE(l)
#define	rfbCredentialTypeUser   2
#define	rfbCredentialTypeX509   1
#define	SERVER_PORT_OFFSET   5900
#define	TUNNEL_PORT_OFFSET   5500

Typedefs
typedef void(*	BellProc )(struct _rfbClient *client)
typedef void(*	FinishedFrameBufferUpdateProc )(struct _rfbClient *client)
typedef rfbCredential *(*	GetCredentialProc )(struct _rfbClient *client, int credentialType)
typedef char *(*	GetPasswordProc )(struct _rfbClient *client)
typedef void(*	GotCopyRectProc )(struct _rfbClient *client, int src_x, int src_y, int w, int h, int dest_x, int dest_y)
typedef void(*	GotCursorShapeProc )(struct _rfbClient *client, int xhot, int yhot, int width, int height, int bytesPerPixel)
typedef void(*	GotFrameBufferUpdateProc )(struct _rfbClient *client, int x, int y, int w, int h)
typedef void(*	GotXCutTextProc )(struct _rfbClient *client, const char *text, int textlen)
typedef rfbBool(*	HandleCursorPosProc )(struct _rfbClient *client, int x, int y)
typedef void(*	HandleKeyboardLedStateProc )(struct _rfbClient *client, int value, int pad)
typedef void(*	HandleTextChatProc )(struct _rfbClient *client, int value, char *text)
typedef void(*	HandleXvpMsgProc )(struct _rfbClient *client, uint8_t version, uint8_t opcode)
typedef rfbBool(*	MallocFrameBufferProc )(struct _rfbClient *client)
typedef struct _rfbClient	rfbClient
typedef struct rfbClientData	rfbClientData
typedef void(*	rfbClientLogProc )(const char *format,...)
typedef struct _rfbClientProtocolExtension	rfbClientProtocolExtension
typedef union _rfbCredential	rfbCredential
typedef void(*	SoftCursorLockAreaProc )(struct _rfbClient *client, int x, int y, int w, int h)
typedef void(*	SoftCursorUnlockScreenProc )(struct _rfbClient *client)

Functions
int	AcceptTcpConnection (int listenSock)
int	ConnectClientToTcpAddr (unsigned int host, int port)
int	ConnectClientToTcpAddr6 (const char *hostname, int port)
int	ConnectClientToUnixSock (const char *sockFile)
rfbBool	ConnectToRFBRepeater (rfbClient *client, const char *repeaterHost, int repeaterPort, const char *destHost, int destPort)
rfbBool	ConnectToRFBServer (rfbClient *client, const char *hostname, int port)
int	FindFreeTcpPort (void)
rfbBool	HandleCursorShape (rfbClient *client, int xhot, int yhot, int width, int height, uint32_t enc)
rfbBool	HandleRFBServerMessage (rfbClient *client)
rfbBool	InitialiseRFBConnection (rfbClient *client)
int	ListenAtTcpPort (int port)
void	listenForIncomingConnections (rfbClient *viewer)
int	listenForIncomingConnectionsNoFork (rfbClient *viewer, int usec_timeout)
rfbBool	PermitServerInput (rfbClient *client, int enabled)
void	PrintPixelFormat (rfbPixelFormat *format)
rfbBool	ReadFromRFBServer (rfbClient *client, char *out, unsigned int n)
void	rfbClientCleanup (rfbClient *client)
void *	rfbClientGetClientData (rfbClient *client, void *tag)
void	rfbClientRegisterExtension (rfbClientProtocolExtension *e)
void	rfbClientSetClientData (rfbClient *client, void *tag, void *data)
rfbClient *	rfbGetClient (int bitsPerSample, int samplesPerPixel, int bytesPerPixel)
rfbBool	rfbInitClient (rfbClient *client, int *argc, char **argv)
rfbBool	SameMachine (int sock)
rfbBool	SendClientCutText (rfbClient *client, char *str, int len)
rfbBool	SendFramebufferUpdateRequest (rfbClient *client, int x, int y, int w, int h, rfbBool incremental)
rfbBool	SendIncrementalFramebufferUpdateRequest (rfbClient *client)
rfbBool	SendKeyEvent (rfbClient *client, uint32_t key, rfbBool down)
rfbBool	SendPointerEvent (rfbClient *client, int x, int y, int buttonMask)
rfbBool	SendScaleSetting (rfbClient *client, int scaleSetting)
rfbBool	SendXvpMsg (rfbClient *client, uint8_t version, uint8_t code)
void	SetClientAuthSchemes (rfbClient *client, const uint32_t *authSchemes, int size)
rfbBool	SetDSCP (int sock, int dscp)
rfbBool	SetFormatAndEncodings (rfbClient *client)
rfbBool	SetNonBlocking (int sock)
rfbBool	StringToIPAddr (const char *str, unsigned int *addr)
rfbBool	SupportsClient2Server (rfbClient *client, int messageType)
rfbBool	SupportsServer2Client (rfbClient *client, int messageType)
rfbBool	TextChatClose (rfbClient *client)
rfbBool	TextChatFinish (rfbClient *client)
rfbBool	TextChatOpen (rfbClient *client)
rfbBool	TextChatSend (rfbClient *client, char *text)
int	WaitForMessage (rfbClient *client, unsigned int usecs)
rfbBool	WriteToRFBServer (rfbClient *client, char *buf, int n)

Variables
rfbBool	errorMessageOnReadFailure
rfbClientLogProc	rfbClientErr
rfbClientLogProc	rfbClientLog
rfbBool	rfbEnableClientLogging

Macro Definition Documentation

#define RFB_BUF_SIZE   8192

Definition at line 199 of file libvncserver/rfb/rfbclient.h.

#define RFB_BUFFER_SIZE   (640*480)

Note that the CoRRE encoding uses this buffer and assumes it is big enough to hold 255 * 255 * 32 bits -> 260100 bytes.

640*480 = 307200 bytes. Hextile also assumes it is big enough to hold 16 * 16 * 32 bits. Tight encoding assumes BUFFER_SIZE is at least 16384 bytes.

Definition at line 183 of file libvncserver/rfb/rfbclient.h.