Files
file	rfb.h

Data Structures
struct	rfbColourMap

struct	rfbSecurityHandler
	Security handling (RFB protocol version 3.7) More...

struct	rfbProtocolExtension
	Protocol extension handling. More...

struct	rfbExtensionData

struct	rfbScreenInfoPtr
	Per-screen (framebuffer) structure. More...

struct	rfbFileTransferData

struct	rfbStatList

struct	rfbClientPtr

struct	rfbCursorPtr

struct	rfbFontDataPtr

Macros
#define	rfbInitServer rfbInitServerWithoutPthreadsAndZRLE

#define	FB_UPDATE_PENDING(cl)
	This macro is used to test whether there is a framebuffer update needing to be sent to the client. More...

#define	Swap16(s) ((((s) & 0xff) << 8) \| (((s) >> 8) & 0xff))

#define	Swap24(l)

#define	Swap32(l)

#define	Swap16IfLE(s) (rfbEndianTest ? Swap16(s) : (s))

#define	Swap24IfLE(l) (rfbEndianTest ? Swap24(l) : (l))

#define	Swap32IfLE(l) (rfbEndianTest ? Swap32(l) : (l))

#define	Swap16IfBE(s) (rfbEndianTest ? (s) : Swap16(s))

#define	Swap24IfBE(l) (rfbEndianTest ? (l) : Swap24(l))

#define	Swap32IfBE(l) (rfbEndianTest ? (l) : Swap32(l))

#define	ULTRA_MAX_RECT_SIZE (128*256)

#define	ULTRA_MAX_SIZE(min)

Typedefs
typedef void(*	rfbKbdAddEventProcPtr) (rfbBool down, rfbKeySym keySym, struct _rfbClientRec *cl)

typedef void(*	rfbKbdReleaseAllKeysProcPtr) (struct _rfbClientRec *cl)

typedef void(*	rfbPtrAddEventProcPtr) (int buttonMask, int x, int y, struct _rfbClientRec *cl)

typedef void(*	rfbSetXCutTextProcPtr) (char str, int len, struct _rfbClientRec cl)

typedef rfbBool(*	rfbSetTranslateFunctionProcPtr) (struct _rfbClientRec *cl)

typedef rfbBool(*	rfbPasswordCheckProcPtr) (struct _rfbClientRec cl, const char encryptedPassWord, int len)

typedef enum rfbNewClientAction(*	rfbNewClientHookPtr) (struct _rfbClientRec *cl)

typedef void(*	rfbDisplayHookPtr) (struct _rfbClientRec *cl)

typedef void(*	rfbDisplayFinishedHookPtr) (struct _rfbClientRec *cl, int result)

typedef int(*	rfbGetKeyboardLedStateHookPtr) (struct _rfbScreenInfo *screen)
	support the capability to view the caps/num/scroll states of the X server More...

typedef rfbBool(*	rfbXvpHookPtr) (struct _rfbClientRec *cl, uint8_t, uint8_t)

typedef int(*	rfbSetDesktopSizeHookPtr) (int width, int height, int numScreens, struct rfbExtDesktopScreen extDesktopScreens, struct _rfbClientRec cl)

typedef int(*	rfbNumberOfExtDesktopScreensPtr) (struct _rfbClientRec *cl)

typedef rfbBool(*	rfbGetExtDesktopScreenPtr) (int seqnumber, struct rfbExtDesktopScreen extDesktopScreen, struct _rfbClientRec cl)

typedef void(*	rfbSetSingleWindowProcPtr) (struct _rfbClientRec *cl, int x, int y)
	If x==1 and y==1 then set the whole display else find the window underneath x and y and set the framebuffer to the dimensions of that window. More...

typedef void(*	rfbSetServerInputProcPtr) (struct _rfbClientRec *cl, int status)
	Status determines if the X11 server permits input from the local user status==0 or 1. More...

typedef int(*	rfbFileTransferPermitted) (struct _rfbClientRec *cl)
	Permit the server to allow or deny filetransfers. More...

typedef void(*	rfbSetTextChat) (struct _rfbClientRec cl, int length, char string)
	Handle the textchat messages. More...

typedef void(*	rfbTranslateFnType) (char table, rfbPixelFormat in, rfbPixelFormat out, char iptr, char *optr, int bytesBetweenInputLines, int width, int height)
	rfbTranslateFnType is the type of translation functions. More...

typedef struct sraRegion *	sraRegionPtr

typedef void(*	ClientGoneHookPtr) (struct _rfbClientRec *cl)

typedef void(*	ClientFramebufferUpdateRequestHookPtr) (struct _rfbClientRec cl, rfbFramebufferUpdateRequestMsg furMsg)

typedef struct _rfbSslCtx	rfbSslCtx

typedef struct _wsCtx	wsCtx

typedef struct rfbClientIterator *	rfbClientIteratorPtr

typedef void(*	SelectionChangedHookPtr) (int _index)
	this opens a modal select box. More...

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

Enumerations
enum	rfbNewClientAction { RFB_CLIENT_ACCEPT , RFB_CLIENT_ON_HOLD , RFB_CLIENT_REFUSE }

enum	rfbSocketState { RFB_SOCKET_INIT , RFB_SOCKET_READY , RFB_SOCKET_SHUTDOWN }

Functions
void	rfbInitSockets (rfbScreenInfoPtr rfbScreen)

void	rfbShutdownSockets (rfbScreenInfoPtr rfbScreen)

void	rfbDisconnectUDPSock (rfbScreenInfoPtr rfbScreen)

void	rfbCloseClient (rfbClientPtr cl)

int	rfbReadExact (rfbClientPtr cl, char *buf, int len)

int	rfbReadExactTimeout (rfbClientPtr cl, char *buf, int len, int timeout)

int	rfbPeekExactTimeout (rfbClientPtr cl, char *buf, int len, int timeout)

int	rfbWriteExact (rfbClientPtr cl, const char *buf, int len)

int	rfbCheckFds (rfbScreenInfoPtr rfbScreen, long usec)

rfbSocket	rfbConnect (rfbScreenInfoPtr rfbScreen, char *host, int port)

rfbSocket	rfbConnectToTcpAddr (char *host, int port)

rfbSocket	rfbListenOnTCPPort (int port, in_addr_t iface)

rfbSocket	rfbListenOnTCP6Port (int port, const char *iface)

rfbSocket	rfbListenOnUDPPort (int port, in_addr_t iface)

int	rfbStringToAddr (char string, in_addr_t addr)

rfbBool	rfbSetNonBlocking (rfbSocket sock)

void	rfbClientListInit (rfbScreenInfoPtr rfbScreen)

rfbClientIteratorPtr	rfbGetClientIterator (rfbScreenInfoPtr rfbScreen)

rfbClientPtr	rfbClientIteratorNext (rfbClientIteratorPtr iterator)

void	rfbReleaseClientIterator (rfbClientIteratorPtr iterator)

void	rfbIncrClientRef (rfbClientPtr cl)

void	rfbDecrClientRef (rfbClientPtr cl)

void	rfbNewClientConnection (rfbScreenInfoPtr rfbScreen, rfbSocket sock)

rfbClientPtr	rfbNewClient (rfbScreenInfoPtr rfbScreen, rfbSocket sock)

rfbClientPtr	rfbNewUDPClient (rfbScreenInfoPtr rfbScreen)

rfbClientPtr	rfbReverseConnection (rfbScreenInfoPtr rfbScreen, char *host, int port)

void	rfbClientConnectionGone (rfbClientPtr cl)

void	rfbProcessClientMessage (rfbClientPtr cl)

void	rfbClientConnFailed (rfbClientPtr cl, const char *reason)

void	rfbNewUDPConnection (rfbScreenInfoPtr rfbScreen, rfbSocket sock)

void	rfbProcessUDPInput (rfbScreenInfoPtr rfbScreen)

rfbBool	rfbSendFramebufferUpdate (rfbClientPtr cl, sraRegionPtr updateRegion)

rfbBool	rfbSendRectEncodingRaw (rfbClientPtr cl, int x, int y, int w, int h)

rfbBool	rfbSendUpdateBuf (rfbClientPtr cl)

void	rfbSendServerCutText (rfbScreenInfoPtr rfbScreen, char *str, int len)

rfbBool	rfbSendCopyRegion (rfbClientPtr cl, sraRegionPtr reg, int dx, int dy)

rfbBool	rfbSendLastRectMarker (rfbClientPtr cl)

rfbBool	rfbSendNewFBSize (rfbClientPtr cl, int w, int h)

rfbBool	rfbSendExtDesktopSize (rfbClientPtr cl, int w, int h)

rfbBool	rfbSendSetColourMapEntries (rfbClientPtr cl, int firstColour, int nColours)

void	rfbSendBell (rfbScreenInfoPtr rfbScreen)

char *	rfbProcessFileTransferReadBuffer (rfbClientPtr cl, uint32_t length)

rfbBool	rfbSendFileTransferChunk (rfbClientPtr cl)

rfbBool	rfbSendDirContent (rfbClientPtr cl, int length, char *buffer)

rfbBool	rfbSendFileTransferMessage (rfbClientPtr cl, uint8_t contentType, uint8_t contentParam, uint32_t size, uint32_t length, const char *buffer)

rfbBool	rfbProcessFileTransfer (rfbClientPtr cl, uint8_t contentType, uint8_t contentParam, uint32_t size, uint32_t length)

void	rfbGotXCutText (rfbScreenInfoPtr rfbScreen, char *str, int len)

void	rfbTranslateNone (char table, rfbPixelFormat in, rfbPixelFormat out, char iptr, char *optr, int bytesBetweenInputLines, int width, int height)

rfbBool	rfbSetTranslateFunction (rfbClientPtr cl)

rfbBool	rfbSetClientColourMap (rfbClientPtr cl, int firstColour, int nColours)

void	rfbSetClientColourMaps (rfbScreenInfoPtr rfbScreen, int firstColour, int nColours)

void	rfbHttpInitSockets (rfbScreenInfoPtr rfbScreen)

void	rfbHttpShutdownSockets (rfbScreenInfoPtr rfbScreen)

void	rfbHttpCheckFds (rfbScreenInfoPtr rfbScreen)

void	rfbAuthNewClient (rfbClientPtr cl)

void	rfbProcessClientSecurityType (rfbClientPtr cl)

void	rfbAuthProcessClientMessage (rfbClientPtr cl)

void	rfbRegisterSecurityHandler (rfbSecurityHandler *handler)

void	rfbUnregisterSecurityHandler (rfbSecurityHandler *handler)

rfbBool	rfbSendRectEncodingRRE (rfbClientPtr cl, int x, int y, int w, int h)

rfbBool	rfbSendRectEncodingCoRRE (rfbClientPtr cl, int x, int y, int w, int h)

rfbBool	rfbSendRectEncodingHextile (rfbClientPtr cl, int x, int y, int w, int h)

rfbBool	rfbSendRectEncodingUltra (rfbClientPtr cl, int x, int y, int w, int h)

rfbBool	rfbSendCursorShape (rfbClientPtr cl)

rfbBool	rfbSendCursorPos (rfbClientPtr cl)

void	rfbConvertLSBCursorBitmapOrMask (int width, int height, unsigned char *bitmap)

rfbCursorPtr	rfbMakeXCursor (int width, int height, char cursorString, char maskString)

char *	rfbMakeMaskForXCursor (int width, int height, char *cursorString)

char *	rfbMakeMaskFromAlphaSource (int width, int height, unsigned char *alphaSource)

void	rfbMakeXCursorFromRichCursor (rfbScreenInfoPtr rfbScreen, rfbCursorPtr cursor)

void	rfbMakeRichCursorFromXCursor (rfbScreenInfoPtr rfbScreen, rfbCursorPtr cursor)

void	rfbFreeCursor (rfbCursorPtr cursor)

void	rfbSetCursor (rfbScreenInfoPtr rfbScreen, rfbCursorPtr c)

void	rfbDefaultPtrAddEvent (int buttonMask, int x, int y, rfbClientPtr cl)
	cursor handling for the pointer More...

void	rfbResetStats (rfbClientPtr cl)

void	rfbPrintStats (rfbClientPtr cl)

int	rfbDrawChar (rfbScreenInfoPtr rfbScreen, rfbFontDataPtr font, int x, int y, unsigned char c, rfbPixel colour)

void	rfbDrawString (rfbScreenInfoPtr rfbScreen, rfbFontDataPtr font, int x, int y, const char *string, rfbPixel colour)

int	rfbDrawCharWithClip (rfbScreenInfoPtr rfbScreen, rfbFontDataPtr font, int x, int y, unsigned char c, int x1, int y1, int x2, int y2, rfbPixel colour, rfbPixel backColour)
	if colour==backColour, background is transparent More...

void	rfbDrawStringWithClip (rfbScreenInfoPtr rfbScreen, rfbFontDataPtr font, int x, int y, const char *string, int x1, int y1, int x2, int y2, rfbPixel colour, rfbPixel backColour)

int	rfbWidthOfString (rfbFontDataPtr font, const char *string)

int	rfbWidthOfChar (rfbFontDataPtr font, unsigned char c)

void	rfbFontBBox (rfbFontDataPtr font, unsigned char c, int x1, int y1, int x2, int y2)

void	rfbWholeFontBBox (rfbFontDataPtr font, int x1, int y1, int x2, int y2)
	this returns the smallest box enclosing any character of font. More...

rfbFontDataPtr	rfbLoadConsoleFont (char *filename)
	dynamically load a linux console font (4096 bytes, 256 glyphs a 8x16 More...

void	rfbFreeFont (rfbFontDataPtr font)
	free a dynamically loaded font More...

void	rfbFillRect (rfbScreenInfoPtr s, int x1, int y1, int x2, int y2, rfbPixel col)

void	rfbDrawPixel (rfbScreenInfoPtr s, int x, int y, rfbPixel col)

void	rfbDrawLine (rfbScreenInfoPtr s, int x1, int y1, int x2, int y2, rfbPixel col)

int	rfbSelectBox (rfbScreenInfoPtr rfbScreen, rfbFontDataPtr font, char **list, int x1, int y1, int x2, int y2, rfbPixel foreColour, rfbPixel backColour, int border, SelectionChangedHookPtr selChangedHook)

void	rfbUsage (void)

void	rfbPurgeArguments (int argc, int position, int count, char *argv[])

rfbBool	rfbProcessArguments (rfbScreenInfoPtr rfbScreen, int argc, char argv[])

rfbBool	rfbProcessSizeArguments (int width, int height, int bpp, int argc, char *argv[])

void	rfbLogEnable (int enabled)

void	rfbLogPerror (const char *str)

void	rfbScheduleCopyRect (rfbScreenInfoPtr rfbScreen, int x1, int y1, int x2, int y2, int dx, int dy)

void	rfbScheduleCopyRegion (rfbScreenInfoPtr rfbScreen, sraRegionPtr copyRegion, int dx, int dy)

void	rfbDoCopyRect (rfbScreenInfoPtr rfbScreen, int x1, int y1, int x2, int y2, int dx, int dy)

void	rfbDoCopyRegion (rfbScreenInfoPtr rfbScreen, sraRegionPtr copyRegion, int dx, int dy)

void	rfbMarkRectAsModified (rfbScreenInfoPtr rfbScreen, int x1, int y1, int x2, int y2)

void	rfbMarkRegionAsModified (rfbScreenInfoPtr rfbScreen, sraRegionPtr modRegion)

void	rfbDoNothingWithClient (rfbClientPtr cl)

enum rfbNewClientAction	defaultNewClientHook (rfbClientPtr cl)

void	rfbRegisterProtocolExtension (rfbProtocolExtension *extension)

void	rfbUnregisterProtocolExtension (rfbProtocolExtension *extension)

struct _rfbProtocolExtension *	rfbGetExtensionIterator (void)

void	rfbReleaseExtensionIterator (void)

rfbBool	rfbEnableExtension (rfbClientPtr cl, rfbProtocolExtension extension, void data)

rfbBool	rfbDisableExtension (rfbClientPtr cl, rfbProtocolExtension *extension)

void *	rfbGetExtensionClientData (rfbClientPtr cl, rfbProtocolExtension *extension)

rfbBool	rfbCheckPasswordByList (rfbClientPtr cl, const char *response, int len)
	to check against plain passwords More...

rfbScreenInfoPtr	rfbGetScreen (int argc, char *argv, int width, int height, int bitsPerSample, int samplesPerPixel, int bytesPerPixel)

void	rfbInitServer (rfbScreenInfoPtr rfbScreen)

void	rfbShutdownServer (rfbScreenInfoPtr rfbScreen, rfbBool disconnectClients)

void	rfbNewFramebuffer (rfbScreenInfoPtr rfbScreen, char *framebuffer, int width, int height, int bitsPerSample, int samplesPerPixel, int bytesPerPixel)

void	rfbScreenCleanup (rfbScreenInfoPtr screenInfo)

void	rfbSetServerVersionIdentity (rfbScreenInfoPtr screen, char *fmt,...)

void	rfbStartOnHoldClient (rfbClientPtr cl)

void	rfbRefuseOnHoldClient (rfbClientPtr cl)

void	rfbRunEventLoop (rfbScreenInfoPtr screenInfo, long usec, rfbBool runInBackground)

rfbBool	rfbProcessEvents (rfbScreenInfoPtr screenInfo, long usec)

rfbBool	rfbIsActive (rfbScreenInfoPtr screenInfo)

void	rfbRegisterTightVNCFileTransferExtension (void)
	Register the TightVNC-1.3.x file transfer extension. More...

void	rfbUnregisterTightVNCFileTransferExtension (void)
	Unregister the TightVNC-1.3.x file transfer extension. More...

char *	messageNameServer2Client (uint32_t type, char *buf, int len)

char *	messageNameClient2Server (uint32_t type, char *buf, int len)

char *	encodingName (uint32_t enc, char *buf, int len)

rfbStatList *	rfbStatLookupEncoding (rfbClientPtr cl, uint32_t type)

rfbStatList *	rfbStatLookupMessage (rfbClientPtr cl, uint32_t type)

void	rfbStatRecordEncodingSent (rfbClientPtr cl, uint32_t type, int byteCount, int byteIfRaw)

void	rfbStatRecordEncodingSentAdd (rfbClientPtr cl, uint32_t type, int byteCount)

void	rfbStatRecordEncodingRcvd (rfbClientPtr cl, uint32_t type, int byteCount, int byteIfRaw)

void	rfbStatRecordMessageSent (rfbClientPtr cl, uint32_t type, int byteCount, int byteIfRaw)

void	rfbStatRecordMessageRcvd (rfbClientPtr cl, uint32_t type, int byteCount, int byteIfRaw)

int	rfbStatGetSentBytes (rfbClientPtr cl)

int	rfbStatGetSentBytesIfRaw (rfbClientPtr cl)

int	rfbStatGetRcvdBytes (rfbClientPtr cl)

int	rfbStatGetRcvdBytesIfRaw (rfbClientPtr cl)

int	rfbStatGetMessageCountSent (rfbClientPtr cl, uint32_t type)

int	rfbStatGetMessageCountRcvd (rfbClientPtr cl, uint32_t type)

int	rfbStatGetEncodingCountSent (rfbClientPtr cl, uint32_t type)

int	rfbStatGetEncodingCountRcvd (rfbClientPtr cl, uint32_t type)

void	rfbSetProtocolVersion (rfbScreenInfoPtr rfbScreen, int major_, int minor_)
	Set which version you want to advertise 3.3, 3.6, 3.7 and 3.8 are currently supported. More...

rfbBool	rfbSendTextChatMessage (rfbClientPtr cl, uint32_t length, char *buffer)
	send a TextChat message to a client More...

rfbBool	rfbProcessNewConnection (rfbScreenInfoPtr rfbScreen)

rfbBool	rfbUpdateClient (rfbClientPtr cl)

Variables
char	rfbEndianTest

int	rfbMaxClientWait

rfbBool	rfbEconomicTranslate

unsigned char	rfbReverseByte [0x100]

rfbLogProc	rfbLog

rfbLogProc	rfbErr

Detailed Description

Macro Definition Documentation

◆ FB_UPDATE_PENDING

#define FB_UPDATE_PENDING ( cl )

Value:

     (((cl)->enableCursorShapeUpdates && (cl)->cursorWasChanged) ||        \
     (((cl)->enableCursorShapeUpdates == FALSE &&                          \
       ((cl)->cursorX != (cl)->screen->cursorX ||                          \
        (cl)->cursorY != (cl)->screen->cursorY))) ||                       \
     ((cl)->useNewFBSize && (cl)->newFBSizePending) ||                     \
     ((cl)->enableCursorPosUpdates && (cl)->cursorWasMoved) ||             \
     !sraRgnEmpty((cl)->copyRegion) || !sraRgnEmpty((cl)->modifiedRegion))

This macro is used to test whether there is a framebuffer update needing to be sent to the client.

Definition at line 721 of file rfb.h.

◆ rfbInitServer

#define rfbInitServer rfbInitServerWithoutPthreadsAndZRLE

Definition at line 83 of file rfb.h.

◆ Swap16

#define Swap16 ( s ) ((((s) & 0xff) << 8) | (((s) >> 8) & 0xff))

Definition at line 734 of file rfb.h.

◆ Swap16IfBE

#define Swap16IfBE ( s ) (rfbEndianTest ? (s) : Swap16(s))

Definition at line 752 of file rfb.h.

◆ Swap16IfLE

#define Swap16IfLE ( s ) (rfbEndianTest ? Swap16(s) : (s))

Definition at line 747 of file rfb.h.

◆ Swap24

#define Swap24 ( l )

Value:

((((l) & 0xff) << 16) | (((l) >> 16) & 0xff) | \

(((l) & 0x00ff00)))

Definition at line 736 of file rfb.h.

◆ Swap24IfBE

#define Swap24IfBE ( l ) (rfbEndianTest ? (l) : Swap24(l))

Definition at line 753 of file rfb.h.

◆ Swap24IfLE

#define Swap24IfLE ( l ) (rfbEndianTest ? Swap24(l) : (l))

Definition at line 748 of file rfb.h.

◆ Swap32

#define Swap32 ( l )

Value:

                   ((((l) >> 24) & 0x000000ff)| \
                   (((l) & 0x00ff0000) >> 8)  | \
                   (((l) & 0x0000ff00) << 8)  | \
                   (((l) & 0x000000ff) << 24))

Definition at line 739 of file rfb.h.

◆ Swap32IfBE

#define Swap32IfBE ( l ) (rfbEndianTest ? (l) : Swap32(l))

Definition at line 754 of file rfb.h.

◆ Swap32IfLE

#define Swap32IfLE ( l ) (rfbEndianTest ? Swap32(l) : (l))

Definition at line 749 of file rfb.h.

◆ ULTRA_MAX_RECT_SIZE

#define ULTRA_MAX_RECT_SIZE (128*256)

Definition at line 881 of file rfb.h.

◆ ULTRA_MAX_SIZE

#define ULTRA_MAX_SIZE ( min )

Value:

((( min * 2 ) > ULTRA_MAX_RECT_SIZE ) ? \

( min * 2 ) : ULTRA_MAX_RECT_SIZE )

ULTRA_MAX_RECT_SIZE

#define ULTRA_MAX_RECT_SIZE

Definition: rfb.h:881

Definition at line 882 of file rfb.h.

Typedef Documentation

◆ ClientFramebufferUpdateRequestHookPtr

typedef void(* ClientFramebufferUpdateRequestHookPtr) (struct _rfbClientRec *cl, rfbFramebufferUpdateRequestMsg *furMsg)

Definition at line 403 of file rfb.h.

◆ ClientGoneHookPtr

typedef void(* ClientGoneHookPtr) (struct _rfbClientRec *cl)

Definition at line 402 of file rfb.h.

◆ rfbClientIteratorPtr

typedef struct rfbClientIterator* rfbClientIteratorPtr

Definition at line 791 of file rfb.h.

◆ rfbDisplayFinishedHookPtr

typedef void(* rfbDisplayFinishedHookPtr) (struct _rfbClientRec *cl, int result)

Definition at line 115 of file rfb.h.

◆ rfbDisplayHookPtr

typedef void(* rfbDisplayHookPtr) (struct _rfbClientRec *cl)

Definition at line 114 of file rfb.h.

◆ rfbFileTransferPermitted

typedef int(* rfbFileTransferPermitted) (struct _rfbClientRec *cl)

Permit the server to allow or deny filetransfers.

This is defaulted to deny It is called when a client initiates a connection to determine if it is permitted.

Definition at line 137 of file rfb.h.

◆ rfbGetExtDesktopScreenPtr

typedef rfbBool(* rfbGetExtDesktopScreenPtr) (int seqnumber, struct rfbExtDesktopScreen *extDesktopScreen, struct _rfbClientRec *cl)

Definition at line 121 of file rfb.h.

◆ rfbGetKeyboardLedStateHookPtr

typedef int(* rfbGetKeyboardLedStateHookPtr) (struct _rfbScreenInfo *screen)

support the capability to view the caps/num/scroll states of the X server

Definition at line 117 of file rfb.h.

◆ rfbKbdAddEventProcPtr

typedef void(* rfbKbdAddEventProcPtr) (rfbBool down, rfbKeySym keySym, struct _rfbClientRec *cl)

Definition at line 103 of file rfb.h.

◆ rfbKbdReleaseAllKeysProcPtr

typedef void(* rfbKbdReleaseAllKeysProcPtr) (struct _rfbClientRec *cl)

Definition at line 104 of file rfb.h.

◆ rfbLogProc

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

Definition at line 1023 of file rfb.h.

◆ rfbNewClientHookPtr

typedef enum rfbNewClientAction(* rfbNewClientHookPtr) (struct _rfbClientRec *cl)

Definition at line 112 of file rfb.h.

◆ rfbNumberOfExtDesktopScreensPtr

typedef int(* rfbNumberOfExtDesktopScreensPtr) (struct _rfbClientRec *cl)

Definition at line 120 of file rfb.h.

◆ rfbPasswordCheckProcPtr

typedef rfbBool(* rfbPasswordCheckProcPtr) (struct _rfbClientRec *cl, const char *encryptedPassWord, int len)

Definition at line 112 of file rfb.h.

◆ rfbPtrAddEventProcPtr

typedef void(* rfbPtrAddEventProcPtr) (int buttonMask, int x, int y, struct _rfbClientRec *cl)

Definition at line 105 of file rfb.h.

◆ rfbSetDesktopSizeHookPtr

typedef int(* rfbSetDesktopSizeHookPtr) (int width, int height, int numScreens, struct rfbExtDesktopScreen *extDesktopScreens, struct _rfbClientRec *cl)

Definition at line 119 of file rfb.h.

◆ rfbSetServerInputProcPtr

typedef void(* rfbSetServerInputProcPtr) (struct _rfbClientRec *cl, int status)

Status determines if the X11 server permits input from the local user status==0 or 1.

Definition at line 132 of file rfb.h.

◆ rfbSetSingleWindowProcPtr

typedef void(* rfbSetSingleWindowProcPtr) (struct _rfbClientRec *cl, int x, int y)

If x==1 and y==1 then set the whole display else find the window underneath x and y and set the framebuffer to the dimensions of that window.

Definition at line 127 of file rfb.h.

◆ rfbSetTextChat

typedef void(* rfbSetTextChat) (struct _rfbClientRec *cl, int length, char *string)

Handle the textchat messages.

Definition at line 139 of file rfb.h.

◆ rfbSetTranslateFunctionProcPtr

typedef rfbBool(* rfbSetTranslateFunctionProcPtr) (struct _rfbClientRec *cl)

Definition at line 111 of file rfb.h.

◆ rfbSetXCutTextProcPtr

typedef void(* rfbSetXCutTextProcPtr) (char *str, int len, struct _rfbClientRec *cl)

Definition at line 106 of file rfb.h.

◆ rfbSslCtx

typedef struct _rfbSslCtx rfbSslCtx

Definition at line 426 of file rfb.h.

◆ rfbTranslateFnType

typedef void(* rfbTranslateFnType) (char *table, rfbPixelFormat *in, rfbPixelFormat *out, char *iptr, char *optr, int bytesBetweenInputLines, int width, int height)

rfbTranslateFnType is the type of translation functions.

Definition at line 386 of file rfb.h.

◆ rfbXvpHookPtr

typedef rfbBool(* rfbXvpHookPtr) (struct _rfbClientRec *cl, uint8_t, uint8_t)

Definition at line 118 of file rfb.h.

◆ SelectionChangedHookPtr

typedef void(* SelectionChangedHookPtr) (int _index)

this opens a modal select box.

list is an array of strings, the end marked with a NULL. It returns the index in the list or -1 if cancelled or something else wasn't kosher.

Definition at line 1006 of file rfb.h.

◆ sraRegionPtr

typedef struct sraRegion* sraRegionPtr

Definition at line 396 of file rfb.h.

◆ wsCtx

typedef struct _wsCtx wsCtx

Definition at line 427 of file rfb.h.

Enumeration Type Documentation

◆ rfbNewClientAction

enum rfbNewClientAction

Enumerator
RFB_CLIENT_ACCEPT
RFB_CLIENT_ON_HOLD
RFB_CLIENT_REFUSE

Definition at line 91 of file rfb.h.

◆ rfbSocketState

enum rfbSocketState

Enumerator
RFB_SOCKET_INIT
RFB_SOCKET_READY
RFB_SOCKET_SHUTDOWN

Definition at line 97 of file rfb.h.

Function Documentation

◆ defaultNewClientHook()

enum rfbNewClientAction defaultNewClientHook ( rfbClientPtr cl )

◆ encodingName()

char * encodingName	(	uint32_t	enc,
		char *	buf,
		int	len
	)

◆ messageNameClient2Server()

char * messageNameClient2Server	(	uint32_t	type,
		char *	buf,
		int	len
	)

◆ messageNameServer2Client()

char * messageNameServer2Client	(	uint32_t	type,
		char *	buf,
		int	len
	)

◆ rfbAuthNewClient()

void rfbAuthNewClient ( rfbClientPtr cl )

◆ rfbAuthProcessClientMessage()

void rfbAuthProcessClientMessage ( rfbClientPtr cl )

◆ rfbCheckFds()

int rfbCheckFds	(	rfbScreenInfoPtr	rfbScreen,
		long	usec
	)

◆ rfbCheckPasswordByList()

rfbBool rfbCheckPasswordByList	(	rfbClientPtr	cl,
		const char *	response,
		int	len
	)

to check against plain passwords

◆ rfbClientConnectionGone()

void rfbClientConnectionGone ( rfbClientPtr cl )

◆ rfbClientConnFailed()

void rfbClientConnFailed	(	rfbClientPtr	cl,
		const char *	reason
	)

◆ rfbClientIteratorNext()

rfbClientPtr rfbClientIteratorNext ( rfbClientIteratorPtr iterator )

◆ rfbClientListInit()

void rfbClientListInit ( rfbScreenInfoPtr rfbScreen )

◆ rfbCloseClient()

void rfbCloseClient ( rfbClientPtr cl )

Examples: example.c, pnmshow.c, and pnmshow24.c.

◆ rfbConnect()

rfbSocket rfbConnect	(	rfbScreenInfoPtr	rfbScreen,
		char *	host,
		int	port
	)

◆ rfbConnectToTcpAddr()

rfbSocket rfbConnectToTcpAddr	(	char *	host,
		int	port
	)

◆ rfbConvertLSBCursorBitmapOrMask()

void rfbConvertLSBCursorBitmapOrMask	(	int	width,
		int	height,
		unsigned char *	bitmap
	)

◆ rfbDecrClientRef()

void rfbDecrClientRef ( rfbClientPtr cl )

◆ rfbDefaultPtrAddEvent()

void rfbDefaultPtrAddEvent	(	int	buttonMask,
		int	x,
		int	y,
		rfbClientPtr	cl
	)

cursor handling for the pointer

Examples: example.c.

◆ rfbDisableExtension()

rfbBool rfbDisableExtension	(	rfbClientPtr	cl,
		rfbProtocolExtension *	extension
	)

◆ rfbDisconnectUDPSock()

void rfbDisconnectUDPSock ( rfbScreenInfoPtr rfbScreen )

◆ rfbDoCopyRect()

void rfbDoCopyRect	(	rfbScreenInfoPtr	rfbScreen,
		int	x1,
		int	y1,
		int	x2,
		int	y2,
		int	dx,
		int	dy
	)

Examples: vncev.c.

◆ rfbDoCopyRegion()

void rfbDoCopyRegion	(	rfbScreenInfoPtr	rfbScreen,
		sraRegionPtr	copyRegion,
		int	dx,
		int	dy
	)

◆ rfbDoNothingWithClient()

void rfbDoNothingWithClient ( rfbClientPtr cl )

◆ rfbDrawChar()

int rfbDrawChar	(	rfbScreenInfoPtr	rfbScreen,
		rfbFontDataPtr	font,
		int	x,
		int	y,
		unsigned char	c,
		rfbPixel	colour
	)

◆ rfbDrawCharWithClip()

int rfbDrawCharWithClip	(	rfbScreenInfoPtr	rfbScreen,
		rfbFontDataPtr	font,
		int	x,
		int	y,
		unsigned char	c,
		int	x1,
		int	y1,
		int	x2,
		int	y2,
		rfbPixel	colour,
		rfbPixel	backColour
	)

if colour==backColour, background is transparent

Examples: example.c, and fontsel.c.

◆ rfbDrawLine()

void rfbDrawLine	(	rfbScreenInfoPtr	s,
		int	x1,
		int	y1,
		int	x2,
		int	y2,
		rfbPixel	col
	)

◆ rfbDrawPixel()

void rfbDrawPixel	(	rfbScreenInfoPtr	s,
		int	x,
		int	y,
		rfbPixel	col
	)

◆ rfbDrawString()

void rfbDrawString	(	rfbScreenInfoPtr	rfbScreen,
		rfbFontDataPtr	font,
		int	x,
		int	y,
		const char *	string,
		rfbPixel	colour
	)

Examples: example.c, and vncev.c.

◆ rfbDrawStringWithClip()

void rfbDrawStringWithClip	(	rfbScreenInfoPtr	rfbScreen,
		rfbFontDataPtr	font,
		int	x,
		int	y,
		const char *	string,
		int	x1,
		int	y1,
		int	x2,
		int	y2,
		rfbPixel	colour,
		rfbPixel	backColour
	)

◆ rfbEnableExtension()

rfbBool rfbEnableExtension	(	rfbClientPtr	cl,
		rfbProtocolExtension *	extension,
		void *	data
	)

◆ rfbFillRect()

void rfbFillRect	(	rfbScreenInfoPtr	s,
		int	x1,
		int	y1,
		int	x2,
		int	y2,
		rfbPixel	col
	)

Examples: fontsel.c.

◆ rfbFontBBox()

void rfbFontBBox	(	rfbFontDataPtr	font,
		unsigned char	c,
		int *	x1,
		int *	y1,
		int *	x2,
		int *	y2
	)

Examples: example.c.

◆ rfbFreeCursor()

void rfbFreeCursor ( rfbCursorPtr cursor )

◆ rfbFreeFont()

void rfbFreeFont ( rfbFontDataPtr font )

free a dynamically loaded font

Examples: fontsel.c.

◆ rfbGetClientIterator()

rfbClientIteratorPtr rfbGetClientIterator ( rfbScreenInfoPtr rfbScreen )

◆ rfbGetExtensionClientData()

void * rfbGetExtensionClientData	(	rfbClientPtr	cl,
		rfbProtocolExtension *	extension
	)

◆ rfbGetExtensionIterator()

struct _rfbProtocolExtension * rfbGetExtensionIterator ( void )

◆ rfbGetScreen()

rfbScreenInfoPtr rfbGetScreen	(	int *	argc,
		char **	argv,
		int	width,
		int	height,
		int	bitsPerSample,
		int	samplesPerPixel,
		int	bytesPerPixel
	)

Examples: camera.c, example.c, filetransfer.c, fontsel.c, pnmshow.c, pnmshow24.c, and vncev.c.

Here is the caller graph for this function:

◆ rfbGotXCutText()

void rfbGotXCutText	(	rfbScreenInfoPtr	rfbScreen,
		char *	str,
		int	len
	)

◆ rfbHttpCheckFds()

void rfbHttpCheckFds ( rfbScreenInfoPtr rfbScreen )

◆ rfbHttpInitSockets()

void rfbHttpInitSockets ( rfbScreenInfoPtr rfbScreen )

◆ rfbHttpShutdownSockets()

void rfbHttpShutdownSockets ( rfbScreenInfoPtr rfbScreen )

◆ rfbIncrClientRef()

void rfbIncrClientRef ( rfbClientPtr cl )

◆ rfbInitServer()

void rfbInitServer ( rfbScreenInfoPtr rfbScreen )

Examples: camera.c, example.c, filetransfer.c, fontsel.c, pnmshow.c, pnmshow24.c, and vncev.c.

Here is the caller graph for this function:

◆ rfbInitSockets()

void rfbInitSockets ( rfbScreenInfoPtr rfbScreen )

◆ rfbIsActive()

rfbBool rfbIsActive ( rfbScreenInfoPtr screenInfo )

Examples: camera.c, example.c, and fontsel.c.

Here is the caller graph for this function:

◆ rfbListenOnTCP6Port()

rfbSocket rfbListenOnTCP6Port	(	int	port,
		const char *	iface
	)

◆ rfbListenOnTCPPort()

rfbSocket rfbListenOnTCPPort	(	int	port,
		in_addr_t	iface
	)

◆ rfbListenOnUDPPort()

rfbSocket rfbListenOnUDPPort	(	int	port,
		in_addr_t	iface
	)

◆ rfbLoadConsoleFont()

rfbFontDataPtr rfbLoadConsoleFont ( char * filename )

dynamically load a linux console font (4096 bytes, 256 glyphs a 8x16

Examples: fontsel.c.

◆ rfbLogEnable()

void rfbLogEnable ( int enabled )

◆ rfbLogPerror()

void rfbLogPerror ( const char * str )

◆ rfbMakeMaskForXCursor()

char * rfbMakeMaskForXCursor	(	int	width,
		int	height,
		char *	cursorString
	)

◆ rfbMakeMaskFromAlphaSource()

char * rfbMakeMaskFromAlphaSource	(	int	width,
		int	height,
		unsigned char *	alphaSource
	)

◆ rfbMakeRichCursorFromXCursor()

void rfbMakeRichCursorFromXCursor	(	rfbScreenInfoPtr	rfbScreen,
		rfbCursorPtr	cursor
	)

◆ rfbMakeXCursor()

rfbCursorPtr rfbMakeXCursor	(	int	width,
		int	height,
		char *	cursorString,
		char *	maskString
	)

Examples: example.c.

◆ rfbMakeXCursorFromRichCursor()

void rfbMakeXCursorFromRichCursor	(	rfbScreenInfoPtr	rfbScreen,
		rfbCursorPtr	cursor
	)

◆ rfbMarkRectAsModified()

void rfbMarkRectAsModified	(	rfbScreenInfoPtr	rfbScreen,
		int	x1,
		int	y1,
		int	x2,
		int	y2
	)

Examples: camera.c, and example.c.

Here is the caller graph for this function:

◆ rfbMarkRegionAsModified()

void rfbMarkRegionAsModified	(	rfbScreenInfoPtr	rfbScreen,
		sraRegionPtr	modRegion
	)

◆ rfbNewClient()

rfbClientPtr rfbNewClient	(	rfbScreenInfoPtr	rfbScreen,
		rfbSocket	sock
	)

◆ rfbNewClientConnection()

void rfbNewClientConnection	(	rfbScreenInfoPtr	rfbScreen,
		rfbSocket	sock
	)

◆ rfbNewFramebuffer()

void rfbNewFramebuffer	(	rfbScreenInfoPtr	rfbScreen,
		char *	framebuffer,
		int	width,
		int	height,
		int	bitsPerSample,
		int	samplesPerPixel,
		int	bytesPerPixel
	)

Examples: example.c.

◆ rfbNewUDPClient()

rfbClientPtr rfbNewUDPClient ( rfbScreenInfoPtr rfbScreen )

◆ rfbNewUDPConnection()

void rfbNewUDPConnection	(	rfbScreenInfoPtr	rfbScreen,
		rfbSocket	sock
	)

◆ rfbPeekExactTimeout()

int rfbPeekExactTimeout	(	rfbClientPtr	cl,
		char *	buf,
		int	len,
		int	timeout
	)

◆ rfbPrintStats()

void rfbPrintStats ( rfbClientPtr cl )

◆ rfbProcessArguments()

rfbBool rfbProcessArguments	(	rfbScreenInfoPtr	rfbScreen,
		int *	argc,
		char *	argv[]
	)

◆ rfbProcessClientMessage()

void rfbProcessClientMessage ( rfbClientPtr cl )

◆ rfbProcessClientSecurityType()

void rfbProcessClientSecurityType ( rfbClientPtr cl )

◆ rfbProcessEvents()

rfbBool rfbProcessEvents	(	rfbScreenInfoPtr	screenInfo,
		long	usec
	)

Examples: camera.c, example.c, fontsel.c, and vncev.c.

Here is the caller graph for this function:

◆ rfbProcessFileTransfer()

rfbBool rfbProcessFileTransfer	(	rfbClientPtr	cl,
		uint8_t	contentType,
		uint8_t	contentParam,
		uint32_t	size,
		uint32_t	length
	)

◆ rfbProcessFileTransferReadBuffer()

char * rfbProcessFileTransferReadBuffer	(	rfbClientPtr	cl,
		uint32_t	length
	)

◆ rfbProcessNewConnection()

rfbBool rfbProcessNewConnection ( rfbScreenInfoPtr rfbScreen )

◆ rfbProcessSizeArguments()

rfbBool rfbProcessSizeArguments	(	int *	width,
		int *	height,
		int *	bpp,
		int *	argc,
		char *	argv[]
	)

◆ rfbProcessUDPInput()

void rfbProcessUDPInput ( rfbScreenInfoPtr rfbScreen )

◆ rfbPurgeArguments()

void rfbPurgeArguments	(	int *	argc,
		int *	position,
		int	count,
		char *	argv[]
	)

◆ rfbReadExact()

int rfbReadExact	(	rfbClientPtr	cl,
		char *	buf,
		int	len
	)

◆ rfbReadExactTimeout()

int rfbReadExactTimeout	(	rfbClientPtr	cl,
		char *	buf,
		int	len,
		int	timeout
	)

◆ rfbRefuseOnHoldClient()

void rfbRefuseOnHoldClient ( rfbClientPtr cl )

◆ rfbRegisterProtocolExtension()

void rfbRegisterProtocolExtension ( rfbProtocolExtension * extension )

◆ rfbRegisterSecurityHandler()

void rfbRegisterSecurityHandler ( rfbSecurityHandler * handler )

◆ rfbRegisterTightVNCFileTransferExtension()

void rfbRegisterTightVNCFileTransferExtension ( void )

Register the TightVNC-1.3.x file transfer extension.

NB That TightVNC-2.x uses a different, incompatible file transfer protocol.

Examples: filetransfer.c.

Here is the caller graph for this function:

◆ rfbReleaseClientIterator()

void rfbReleaseClientIterator ( rfbClientIteratorPtr iterator )

◆ rfbReleaseExtensionIterator()

void rfbReleaseExtensionIterator ( void )

◆ rfbResetStats()

void rfbResetStats ( rfbClientPtr cl )

◆ rfbReverseConnection()

rfbClientPtr rfbReverseConnection	(	rfbScreenInfoPtr	rfbScreen,
		char *	host,
		int	port
	)

◆ rfbRunEventLoop()

void rfbRunEventLoop	(	rfbScreenInfoPtr	screenInfo,
		long	usec,
		rfbBool	runInBackground
	)

Examples: example.c, filetransfer.c, pnmshow.c, and pnmshow24.c.

Here is the caller graph for this function:

◆ rfbScheduleCopyRect()

void rfbScheduleCopyRect	(	rfbScreenInfoPtr	rfbScreen,
		int	x1,
		int	y1,
		int	x2,
		int	y2,
		int	dx,
		int	dy
	)

◆ rfbScheduleCopyRegion()

void rfbScheduleCopyRegion	(	rfbScreenInfoPtr	rfbScreen,
		sraRegionPtr	copyRegion,
		int	dx,
		int	dy
	)

◆ rfbScreenCleanup()

void rfbScreenCleanup ( rfbScreenInfoPtr screenInfo )

Examples: example.c, and fontsel.c.

◆ rfbSelectBox()

int rfbSelectBox	(	rfbScreenInfoPtr	rfbScreen,
		rfbFontDataPtr	font,
		char **	list,
		int	x1,
		int	y1,
		int	x2,
		int	y2,
		rfbPixel	foreColour,
		rfbPixel	backColour,
		int	border,
		SelectionChangedHookPtr	selChangedHook
	)

Examples: fontsel.c.

◆ rfbSendBell()

void rfbSendBell ( rfbScreenInfoPtr rfbScreen )

◆ rfbSendCopyRegion()

rfbBool rfbSendCopyRegion	(	rfbClientPtr	cl,
		sraRegionPtr	reg,
		int	dx,
		int	dy
	)

◆ rfbSendCursorPos()

rfbBool rfbSendCursorPos ( rfbClientPtr cl )

◆ rfbSendCursorShape()

rfbBool rfbSendCursorShape ( rfbClientPtr cl )

◆ rfbSendDirContent()

rfbBool rfbSendDirContent	(	rfbClientPtr	cl,
		int	length,
		char *	buffer
	)

◆ rfbSendExtDesktopSize()

rfbBool rfbSendExtDesktopSize	(	rfbClientPtr	cl,
		int	w,
		int	h
	)

◆ rfbSendFileTransferChunk()

rfbBool rfbSendFileTransferChunk ( rfbClientPtr cl )

◆ rfbSendFileTransferMessage()

rfbBool rfbSendFileTransferMessage	(	rfbClientPtr	cl,
		uint8_t	contentType,
		uint8_t	contentParam,
		uint32_t	size,
		uint32_t	length,
		const char *	buffer
	)

◆ rfbSendFramebufferUpdate()

rfbBool rfbSendFramebufferUpdate	(	rfbClientPtr	cl,
		sraRegionPtr	updateRegion
	)

◆ rfbSendLastRectMarker()

rfbBool rfbSendLastRectMarker ( rfbClientPtr cl )

◆ rfbSendNewFBSize()

rfbBool rfbSendNewFBSize	(	rfbClientPtr	cl,
		int	w,
		int	h
	)

◆ rfbSendRectEncodingCoRRE()

rfbBool rfbSendRectEncodingCoRRE	(	rfbClientPtr	cl,
		int	x,
		int	y,
		int	w,
		int	h
	)

◆ rfbSendRectEncodingHextile()

rfbBool rfbSendRectEncodingHextile	(	rfbClientPtr	cl,
		int	x,
		int	y,
		int	w,
		int	h
	)

◆ rfbSendRectEncodingRaw()

rfbBool rfbSendRectEncodingRaw	(	rfbClientPtr	cl,
		int	x,
		int	y,
		int	w,
		int	h
	)

◆ rfbSendRectEncodingRRE()

rfbBool rfbSendRectEncodingRRE	(	rfbClientPtr	cl,
		int	x,
		int	y,
		int	w,
		int	h
	)

◆ rfbSendRectEncodingUltra()

rfbBool rfbSendRectEncodingUltra	(	rfbClientPtr	cl,
		int	x,
		int	y,
		int	w,
		int	h
	)

◆ rfbSendServerCutText()

void rfbSendServerCutText	(	rfbScreenInfoPtr	rfbScreen,
		char *	str,
		int	len
	)

◆ rfbSendSetColourMapEntries()

rfbBool rfbSendSetColourMapEntries	(	rfbClientPtr	cl,
		int	firstColour,
		int	nColours
	)

◆ rfbSendTextChatMessage()

rfbBool rfbSendTextChatMessage	(	rfbClientPtr	cl,
		uint32_t	length,
		char *	buffer
	)

send a TextChat message to a client

◆ rfbSendUpdateBuf()

rfbBool rfbSendUpdateBuf ( rfbClientPtr cl )

◆ rfbSetClientColourMap()

rfbBool rfbSetClientColourMap	(	rfbClientPtr	cl,
		int	firstColour,
		int	nColours
	)

◆ rfbSetClientColourMaps()

void rfbSetClientColourMaps	(	rfbScreenInfoPtr	rfbScreen,
		int	firstColour,
		int	nColours
	)

◆ rfbSetCursor()

void rfbSetCursor	(	rfbScreenInfoPtr	rfbScreen,
		rfbCursorPtr	c
	)

◆ rfbSetNonBlocking()

rfbBool rfbSetNonBlocking ( rfbSocket sock )

◆ rfbSetProtocolVersion()

void rfbSetProtocolVersion	(	rfbScreenInfoPtr	rfbScreen,
		int	major_,
		int	minor_
	)

Set which version you want to advertise 3.3, 3.6, 3.7 and 3.8 are currently supported.

◆ rfbSetServerVersionIdentity()

void rfbSetServerVersionIdentity	(	rfbScreenInfoPtr	screen,
		char *	fmt,
			...
	)

◆ rfbSetTranslateFunction()

rfbBool rfbSetTranslateFunction ( rfbClientPtr cl )

◆ rfbShutdownServer()

void rfbShutdownServer	(	rfbScreenInfoPtr	rfbScreen,
		rfbBool	disconnectClients
	)

Examples: example.c.

◆ rfbShutdownSockets()

void rfbShutdownSockets ( rfbScreenInfoPtr rfbScreen )

◆ rfbStartOnHoldClient()

void rfbStartOnHoldClient ( rfbClientPtr cl )

◆ rfbStatGetEncodingCountRcvd()

int rfbStatGetEncodingCountRcvd	(	rfbClientPtr	cl,
		uint32_t	type
	)

◆ rfbStatGetEncodingCountSent()

int rfbStatGetEncodingCountSent	(	rfbClientPtr	cl,
		uint32_t	type
	)

◆ rfbStatGetMessageCountRcvd()

int rfbStatGetMessageCountRcvd	(	rfbClientPtr	cl,
		uint32_t	type
	)

◆ rfbStatGetMessageCountSent()

int rfbStatGetMessageCountSent	(	rfbClientPtr	cl,
		uint32_t	type
	)

◆ rfbStatGetRcvdBytes()

int rfbStatGetRcvdBytes ( rfbClientPtr cl )

◆ rfbStatGetRcvdBytesIfRaw()

int rfbStatGetRcvdBytesIfRaw ( rfbClientPtr cl )

◆ rfbStatGetSentBytes()

int rfbStatGetSentBytes ( rfbClientPtr cl )

◆ rfbStatGetSentBytesIfRaw()

int rfbStatGetSentBytesIfRaw ( rfbClientPtr cl )

◆ rfbStatLookupEncoding()

rfbStatList * rfbStatLookupEncoding	(	rfbClientPtr	cl,
		uint32_t	type
	)

◆ rfbStatLookupMessage()

rfbStatList * rfbStatLookupMessage	(	rfbClientPtr	cl,
		uint32_t	type
	)

◆ rfbStatRecordEncodingRcvd()

void rfbStatRecordEncodingRcvd	(	rfbClientPtr	cl,
		uint32_t	type,
		int	byteCount,
		int	byteIfRaw
	)

◆ rfbStatRecordEncodingSent()

void rfbStatRecordEncodingSent	(	rfbClientPtr	cl,
		uint32_t	type,
		int	byteCount,
		int	byteIfRaw
	)

◆ rfbStatRecordEncodingSentAdd()

void rfbStatRecordEncodingSentAdd	(	rfbClientPtr	cl,
		uint32_t	type,
		int	byteCount
	)

◆ rfbStatRecordMessageRcvd()

void rfbStatRecordMessageRcvd	(	rfbClientPtr	cl,
		uint32_t	type,
		int	byteCount,
		int	byteIfRaw
	)

◆ rfbStatRecordMessageSent()

void rfbStatRecordMessageSent	(	rfbClientPtr	cl,
		uint32_t	type,
		int	byteCount,
		int	byteIfRaw
	)

◆ rfbStringToAddr()

int rfbStringToAddr	(	char *	string,
		in_addr_t *	addr
	)

◆ rfbTranslateNone()

void rfbTranslateNone	(	char *	table,
		rfbPixelFormat *	in,
		rfbPixelFormat *	out,
		char *	iptr,
		char *	optr,
		int	bytesBetweenInputLines,
		int	width,
		int	height
	)

◆ rfbUnregisterProtocolExtension()

void rfbUnregisterProtocolExtension ( rfbProtocolExtension * extension )

◆ rfbUnregisterSecurityHandler()

void rfbUnregisterSecurityHandler ( rfbSecurityHandler * handler )

◆ rfbUnregisterTightVNCFileTransferExtension()

void rfbUnregisterTightVNCFileTransferExtension ( void )

Unregister the TightVNC-1.3.x file transfer extension.

NB That TightVNC-2.x uses a different, incompatible file transfer protocol.

◆ rfbUpdateClient()

rfbBool rfbUpdateClient ( rfbClientPtr cl )

◆ rfbUsage()

void rfbUsage ( void )

◆ rfbWholeFontBBox()

void rfbWholeFontBBox	(	rfbFontDataPtr	font,
		int *	x1,
		int *	y1,
		int *	x2,
		int *	y2
	)

this returns the smallest box enclosing any character of font.

◆ rfbWidthOfChar()

int rfbWidthOfChar	(	rfbFontDataPtr	font,
		unsigned char	c
	)

◆ rfbWidthOfString()

int rfbWidthOfString	(	rfbFontDataPtr	font,
		const char *	string
	)

◆ rfbWriteExact()

int rfbWriteExact	(	rfbClientPtr	cl,
		const char *	buf,
		int	len
	)

Variable Documentation

◆ rfbEconomicTranslate

rfbBool rfbEconomicTranslate

extern

◆ rfbEndianTest

char rfbEndianTest

extern

◆ rfbErr

rfbLogProc rfbErr

Examples: fontsel.c.

Definition at line 1024 of file rfb.h.

◆ rfbLog

rfbLogProc rfbLog

extern

Examples: fontsel.c, pnmshow.c, pnmshow24.c, and vncev.c.

◆ rfbMaxClientWait

int rfbMaxClientWait

extern

◆ rfbReverseByte

unsigned char rfbReverseByte[0x100]

extern

Files

Data Structures

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ FB_UPDATE_PENDING

◆ rfbInitServer

◆ Swap16

◆ Swap16IfBE

◆ Swap16IfLE

◆ Swap24

◆ Swap24IfBE

◆ Swap24IfLE

◆ Swap32

◆ Swap32IfBE

◆ Swap32IfLE

◆ ULTRA_MAX_RECT_SIZE

◆ ULTRA_MAX_SIZE

Typedef Documentation

◆ ClientFramebufferUpdateRequestHookPtr

◆ ClientGoneHookPtr

◆ rfbClientIteratorPtr

◆ rfbDisplayFinishedHookPtr

◆ rfbDisplayHookPtr

◆ rfbFileTransferPermitted

◆ rfbGetExtDesktopScreenPtr

◆ rfbGetKeyboardLedStateHookPtr

◆ rfbKbdAddEventProcPtr

◆ rfbKbdReleaseAllKeysProcPtr

◆ rfbLogProc

◆ rfbNewClientHookPtr

◆ rfbNumberOfExtDesktopScreensPtr

◆ rfbPasswordCheckProcPtr

◆ rfbPtrAddEventProcPtr

◆ rfbSetDesktopSizeHookPtr

◆ rfbSetServerInputProcPtr

◆ rfbSetSingleWindowProcPtr

◆ rfbSetTextChat

◆ rfbSetTranslateFunctionProcPtr

◆ rfbSetXCutTextProcPtr

◆ rfbSslCtx

◆ rfbTranslateFnType

◆ rfbXvpHookPtr

◆ SelectionChangedHookPtr

◆ sraRegionPtr

◆ wsCtx

Enumeration Type Documentation

◆ rfbNewClientAction

◆ rfbSocketState

Function Documentation

◆ defaultNewClientHook()

◆ encodingName()

◆ messageNameClient2Server()

◆ messageNameServer2Client()

◆ rfbAuthNewClient()

◆ rfbAuthProcessClientMessage()

◆ rfbCheckFds()

◆ rfbCheckPasswordByList()

◆ rfbClientConnectionGone()

◆ rfbClientConnFailed()

◆ rfbClientIteratorNext()

◆ rfbClientListInit()

◆ rfbCloseClient()

◆ rfbConnect()

◆ rfbConnectToTcpAddr()

◆ rfbConvertLSBCursorBitmapOrMask()

◆ rfbDecrClientRef()

◆ rfbDefaultPtrAddEvent()

◆ rfbDisableExtension()

◆ rfbDisconnectUDPSock()

◆ rfbDoCopyRect()

◆ rfbDoCopyRegion()

◆ rfbDoNothingWithClient()

◆ rfbDrawChar()

◆ rfbDrawCharWithClip()

◆ rfbDrawLine()