LibVNCClient API Reference

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	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

Detailed Description

Macro Definition Documentation

#define DEFAULT_SSH_CMD   "/usr/bin/ssh"

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

#define DEFAULT_TUNNEL_CMD   (DEFAULT_SSH_CMD " -f -L %L:localhost:%R %H sleep 20")

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

#define DEFAULT_VIA_CMD   (DEFAULT_SSH_CMD " -f -L %L:%H:%R %G sleep 20")

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

#define FLASH_PORT_OFFSET   5400

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

#define LISTEN_PORT_OFFSET   5500

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

#define rfbClientSwap16IfLE

(

s

)

(*(char *)&client->endianTest ? ((((s) & 0xff) << 8) | (((s) >> 8) & 0xff)) : (s))

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

#define rfbClientSwap32IfLE

(

l

)

Value:

(*(char *)&client->endianTest ? ((((l) & 0xff000000) >> 24) | \
                 (((l) & 0x00ff0000) >> 8)  | \
                 (((l) & 0x0000ff00) << 8)  | \
                 (((l) & 0x000000ff) << 24))  : (l))

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

#define rfbClientSwap64IfLE

(

l

)

Value:

(*(char *)&client->endianTest ? ((((l) & 0xff00000000000000ULL) >> 56) | \
                 (((l) & 0x00ff000000000000ULL) >> 40)  | \
                 (((l) & 0x0000ff0000000000ULL) >> 24)  | \
                 (((l) & 0x000000ff00000000ULL) >> 8)  | \
                 (((l) & 0x00000000ff000000ULL) << 8)  | \
                 (((l) & 0x0000000000ff0000ULL) << 24)  | \
                 (((l) & 0x000000000000ff00ULL) << 40)  | \
                 (((l) & 0x00000000000000ffULL) << 56))  : (l))

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

#define rfbCredentialTypeUser   2

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

#define rfbCredentialTypeX509   1

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

#define SERVER_PORT_OFFSET   5900

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

#define TUNNEL_PORT_OFFSET   5500

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

Typedef Documentation

typedef void(* BellProc)(struct _rfbClient *client)

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

typedef void(* FinishedFrameBufferUpdateProc)(struct _rfbClient *client)

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

typedef rfbCredential*(* GetCredentialProc)(struct _rfbClient *client, int credentialType)

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

typedef char*(* GetPasswordProc)(struct _rfbClient *client)

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

typedef void(* GotCopyRectProc)(struct _rfbClient *client, int src_x, int src_y, int w, int h, int dest_x, int dest_y)

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

typedef void(* GotCursorShapeProc)(struct _rfbClient *client, int xhot, int yhot, int width, int height, int bytesPerPixel)

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

typedef void(* GotFrameBufferUpdateProc)(struct _rfbClient *client, int x, int y, int w, int h)

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

typedef void(* GotXCutTextProc)(struct _rfbClient *client, const char *text, int textlen)

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

typedef rfbBool(* HandleCursorPosProc)(struct _rfbClient *client, int x, int y)

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

typedef void(* HandleKeyboardLedStateProc)(struct _rfbClient *client, int value, int pad)

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

typedef void(* HandleTextChatProc)(struct _rfbClient *client, int value, char *text)

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

typedef void(* HandleXvpMsgProc)(struct _rfbClient *client, uint8_t version, uint8_t opcode)

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

typedef rfbBool(* MallocFrameBufferProc)(struct _rfbClient *client)

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

typedef struct _rfbClient rfbClient

typedef struct rfbClientData rfbClientData

client data

typedef void(* rfbClientLogProc)(const char *format,...)

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

typedef struct _rfbClientProtocolExtension rfbClientProtocolExtension

typedef union _rfbCredential rfbCredential

For GetCredentialProc callback function to return.

typedef void(* SoftCursorLockAreaProc)(struct _rfbClient *client, int x, int y, int w, int h)

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

typedef void(* SoftCursorUnlockScreenProc)(struct _rfbClient *client)

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

Function Documentation

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

)

rfbClientCleanup() does not touch client->frameBuffer

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
	)

Variable Documentation

rfbBool errorMessageOnReadFailure

rfbClientLogProc rfbClientErr

rfbClientLogProc rfbClientLog

rfbBool rfbEnableClientLogging