• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdenetwork API Reference
  • KDE Home
  • Contact Us
 

krfb

Classes | Macros | Typedefs | Enumerations | Functions | Variables
LibVNCServer API Reference

Classes

struct  _rfbClientRec
 
struct  _rfbExtensionData
 
struct  _rfbFileTransferData
 
struct  _rfbProtocolExtension
 
struct  _rfbScreenInfo
 
struct  _rfbSecurity
 
struct  _rfbStatList
 
struct  rfbColourMap
 
struct  rfbCursor
 
struct  rfbFontData
 

Macros

#define COND(cond)
 
#define FB_UPDATE_PENDING(cl)
 
#define IF_PTHREADS(x)
 
#define INIT_COND(cond)
 
#define INIT_MUTEX(mutex)
 
#define LOCK(mutex)
 
#define MUTEX(mutex)
 
#define rfbInitServer   rfbInitServerWithoutPthreadsAndZRLE
 
#define Swap16(s)   ((((s) & 0xff) << 8) | (((s) >> 8) & 0xff))
 
#define Swap16IfBE(s)   (rfbEndianTest ? (s) : Swap16(s))
 
#define Swap16IfLE(s)   (rfbEndianTest ? Swap16(s) : (s))
 
#define Swap24(l)
 
#define Swap24IfBE(l)   (rfbEndianTest ? (l) : Swap24(l))
 
#define Swap24IfLE(l)   (rfbEndianTest ? Swap24(l) : (l))
 
#define Swap32(l)
 
#define Swap32IfBE(l)   (rfbEndianTest ? (l) : Swap32(l))
 
#define Swap32IfLE(l)   (rfbEndianTest ? Swap32(l) : (l))
 
#define TINI_COND(cond)
 
#define TINI_MUTEX(mutex)
 
#define TSIGNAL(cond)
 
#define ULTRA_MAX_RECT_SIZE   (128*256)
 
#define ULTRA_MAX_SIZE(min)
 
#define UNLOCK(mutex)
 
#define WAIT(cond, mutex)   this_is_unsupported
 

Typedefs

typedef void(* ClientGoneHookPtr )(struct _rfbClientRec *cl)
 
typedef struct rfbClientIterator * rfbClientIteratorPtr
 
typedef struct _rfbClientRec * rfbClientPtr
 
typedef struct _rfbClientRec rfbClientRec
 
typedef struct rfbCursor rfbCursor
 
typedef struct rfbCursor * rfbCursorPtr
 
typedef void(* rfbDisplayFinishedHookPtr )(struct _rfbClientRec *cl, int result)
 
typedef void(* rfbDisplayHookPtr )(struct _rfbClientRec *cl)
 
typedef struct _rfbExtensionData rfbExtensionData
 
typedef struct _rfbFileTransferData rfbFileTransferData
 
typedef int(* rfbFileTransferPermitted )(struct _rfbClientRec *cl)
 
typedef struct rfbFontData rfbFontData
 
typedef struct rfbFontData * rfbFontDataPtr
 
typedef struct rfbCursor *(* rfbGetCursorProcPtr )(struct _rfbClientRec *pScreen)
 
typedef int(* rfbGetKeyboardLedStateHookPtr )(struct _rfbScreenInfo *screen)
 
typedef void(* rfbKbdAddEventProcPtr )(rfbBool down, rfbKeySym keySym, struct _rfbClientRec *cl)
 
typedef void(* rfbKbdReleaseAllKeysProcPtr )(struct _rfbClientRec *cl)
 
typedef void(* rfbLogProc )(const char *format,...)
 
typedef enum rfbNewClientAction(* rfbNewClientHookPtr )(struct _rfbClientRec *cl)
 
typedef rfbBool(* rfbPasswordCheckProcPtr )(struct _rfbClientRec *cl, const char *encryptedPassWord, int len)
 
typedef struct
_rfbProtocolExtension 
rfbProtocolExtension
 
typedef void(* rfbPtrAddEventProcPtr )(int buttonMask, int x, int y, struct _rfbClientRec *cl)
 
typedef struct _rfbScreenInfo rfbScreenInfo
 
typedef struct _rfbScreenInfo * rfbScreenInfoPtr
 
typedef struct _rfbSecurity rfbSecurityHandler
 
typedef void(* rfbSetServerInputProcPtr )(struct _rfbClientRec *cl, int status)
 
typedef void(* rfbSetSingleWindowProcPtr )(struct _rfbClientRec *cl, int x, int y)
 
typedef void(* rfbSetTextChat )(struct _rfbClientRec *cl, int length, char *string)
 
typedef rfbBool(* rfbSetTranslateFunctionProcPtr )(struct _rfbClientRec *cl)
 
typedef void(* rfbSetXCutTextProcPtr )(char *str, int len, struct _rfbClientRec *cl)
 
typedef struct _rfbStatList rfbStatList
 
typedef void(* rfbTranslateFnType )(char *table, rfbPixelFormat *in, rfbPixelFormat *out, char *iptr, char *optr, int bytesBetweenInputLines, int width, int height)
 
typedef rfbBool(* rfbXvpHookPtr )(struct _rfbClientRec *cl, uint8_t, uint8_t)
 
typedef void(* SelectionChangedHookPtr )(int _index)
 
typedef struct sraRegion * sraRegionPtr
 

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

enum rfbNewClientAction defaultNewClientHook (rfbClientPtr cl)
 
char * encodingName (uint32_t enc, char *buf, int len)
 
char * messageNameClient2Server (uint32_t type, char *buf, int len)
 
char * messageNameServer2Client (uint32_t type, char *buf, int len)
 
void rfbAuthNewClient (rfbClientPtr cl)
 
void rfbAuthProcessClientMessage (rfbClientPtr cl)
 
int rfbCheckFds (rfbScreenInfoPtr rfbScreen, long usec)
 
rfbBool rfbCheckPasswordByList (rfbClientPtr cl, const char *response, int len)
 
void rfbClientConnectionGone (rfbClientPtr cl)
 
void rfbClientConnFailed (rfbClientPtr cl, const char *reason)
 
rfbClientPtr rfbClientIteratorNext (rfbClientIteratorPtr iterator)
 
void rfbClientListInit (rfbScreenInfoPtr rfbScreen)
 
void rfbCloseClient (rfbClientPtr cl)
 
int rfbConnect (rfbScreenInfoPtr rfbScreen, char *host, int port)
 
int rfbConnectToTcpAddr (char *host, int port)
 
void rfbConvertLSBCursorBitmapOrMask (int width, int height, unsigned char *bitmap)
 
void rfbDecrClientRef (rfbClientPtr cl)
 
void rfbDefaultPtrAddEvent (int buttonMask, int x, int y, rfbClientPtr cl)
 
rfbBool rfbDisableExtension (rfbClientPtr cl, rfbProtocolExtension *extension)
 
void rfbDisconnectUDPSock (rfbScreenInfoPtr rfbScreen)
 
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 rfbDoNothingWithClient (rfbClientPtr cl)
 
int rfbDrawChar (rfbScreenInfoPtr rfbScreen, rfbFontDataPtr font, int x, int y, unsigned char c, 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)
 
void rfbDrawLine (rfbScreenInfoPtr s, int x1, int y1, int x2, int y2, rfbPixel col)
 
void rfbDrawPixel (rfbScreenInfoPtr s, int x, int y, rfbPixel col)
 
void rfbDrawString (rfbScreenInfoPtr rfbScreen, rfbFontDataPtr font, int x, int y, const char *string, rfbPixel colour)
 
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)
 
rfbBool rfbEnableExtension (rfbClientPtr cl, rfbProtocolExtension *extension, void *data)
 
void rfbFillRect (rfbScreenInfoPtr s, int x1, int y1, int x2, int y2, rfbPixel col)
 
void rfbFontBBox (rfbFontDataPtr font, unsigned char c, int *x1, int *y1, int *x2, int *y2)
 
void rfbFreeCursor (rfbCursorPtr cursor)
 
void rfbFreeFont (rfbFontDataPtr font)
 
rfbClientIteratorPtr rfbGetClientIterator (rfbScreenInfoPtr rfbScreen)
 
void * rfbGetExtensionClientData (rfbClientPtr cl, rfbProtocolExtension *extension)
 
struct _rfbProtocolExtension * rfbGetExtensionIterator ()
 
rfbScreenInfoPtr rfbGetScreen (int *argc, char **argv, int width, int height, int bitsPerSample, int samplesPerPixel, int bytesPerPixel)
 
void rfbGotXCutText (rfbScreenInfoPtr rfbScreen, char *str, int len)
 
void rfbHttpCheckFds (rfbScreenInfoPtr rfbScreen)
 
void rfbHttpInitSockets (rfbScreenInfoPtr rfbScreen)
 
void rfbHttpShutdownSockets (rfbScreenInfoPtr rfbScreen)
 
void rfbIncrClientRef (rfbClientPtr cl)
 
void rfbInitServer (rfbScreenInfoPtr rfbScreen)
 
void rfbInitSockets (rfbScreenInfoPtr rfbScreen)
 
rfbBool rfbIsActive (rfbScreenInfoPtr screenInfo)
 
int rfbListenOnTCPPort (int port, in_addr_t iface)
 
int rfbListenOnUDPPort (int port, in_addr_t iface)
 
rfbFontDataPtr rfbLoadConsoleFont (char *filename)
 
void rfbLogEnable (int enabled)
 
void rfbLogPerror (const char *str)
 
char * rfbMakeMaskForXCursor (int width, int height, char *cursorString)
 
char * rfbMakeMaskFromAlphaSource (int width, int height, unsigned char *alphaSource)
 
void rfbMakeRichCursorFromXCursor (rfbScreenInfoPtr rfbScreen, rfbCursorPtr cursor)
 
rfbCursorPtr rfbMakeXCursor (int width, int height, char *cursorString, char *maskString)
 
void rfbMakeXCursorFromRichCursor (rfbScreenInfoPtr rfbScreen, rfbCursorPtr cursor)
 
void rfbMarkRectAsModified (rfbScreenInfoPtr rfbScreen, int x1, int y1, int x2, int y2)
 
void rfbMarkRegionAsModified (rfbScreenInfoPtr rfbScreen, sraRegionPtr modRegion)
 
rfbClientPtr rfbNewClient (rfbScreenInfoPtr rfbScreen, int sock)
 
void rfbNewClientConnection (rfbScreenInfoPtr rfbScreen, int sock)
 
void rfbNewFramebuffer (rfbScreenInfoPtr rfbScreen, char *framebuffer, int width, int height, int bitsPerSample, int samplesPerPixel, int bytesPerPixel)
 
rfbClientPtr rfbNewUDPClient (rfbScreenInfoPtr rfbScreen)
 
void rfbNewUDPConnection (rfbScreenInfoPtr rfbScreen, int sock)
 
void rfbPrintStats (rfbClientPtr cl)
 
rfbBool rfbProcessArguments (rfbScreenInfoPtr rfbScreen, int *argc, char *argv[])
 
void rfbProcessClientMessage (rfbClientPtr cl)
 
void rfbProcessClientSecurityType (rfbClientPtr cl)
 
rfbBool rfbProcessEvents (rfbScreenInfoPtr screenInfo, long usec)
 
rfbBool rfbProcessFileTransfer (rfbClientPtr cl, uint8_t contentType, uint8_t contentParam, uint32_t size, uint32_t length)
 
char * rfbProcessFileTransferReadBuffer (rfbClientPtr cl, uint32_t length)
 
rfbBool rfbProcessNewConnection (rfbScreenInfoPtr rfbScreen)
 
rfbBool rfbProcessSizeArguments (int *width, int *height, int *bpp, int *argc, char *argv[])
 
void rfbProcessUDPInput (rfbScreenInfoPtr rfbScreen)
 
void rfbPurgeArguments (int *argc, int *position, int count, char *argv[])
 
int rfbReadExact (rfbClientPtr cl, char *buf, int len)
 
int rfbReadExactTimeout (rfbClientPtr cl, char *buf, int len, int timeout)
 
void rfbRefuseOnHoldClient (rfbClientPtr cl)
 
void rfbRegisterProtocolExtension (rfbProtocolExtension *extension)
 
void rfbRegisterSecurityHandler (rfbSecurityHandler *handler)
 
void rfbRegisterTightVNCFileTransferExtension ()
 
void rfbReleaseClientIterator (rfbClientIteratorPtr iterator)
 
void rfbReleaseExtensionIterator ()
 
void rfbResetStats (rfbClientPtr cl)
 
rfbClientPtr rfbReverseConnection (rfbScreenInfoPtr rfbScreen, char *host, int port)
 
void rfbRunEventLoop (rfbScreenInfoPtr screenInfo, long usec, rfbBool runInBackground)
 
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 rfbScreenCleanup (rfbScreenInfoPtr screenInfo)
 
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 rfbSendBell (rfbScreenInfoPtr rfbScreen)
 
rfbBool rfbSendCopyRegion (rfbClientPtr cl, sraRegionPtr reg, int dx, int dy)
 
rfbBool rfbSendCursorPos (rfbClientPtr cl)
 
rfbBool rfbSendCursorShape (rfbClientPtr cl)
 
rfbBool rfbSendDirContent (rfbClientPtr cl, int length, char *buffer)
 
rfbBool rfbSendFileTransferChunk (rfbClientPtr cl)
 
rfbBool rfbSendFileTransferMessage (rfbClientPtr cl, uint8_t contentType, uint8_t contentParam, uint32_t size, uint32_t length, const char *buffer)
 
rfbBool rfbSendFramebufferUpdate (rfbClientPtr cl, sraRegionPtr updateRegion)
 
rfbBool rfbSendLastRectMarker (rfbClientPtr cl)
 
rfbBool rfbSendNewFBSize (rfbClientPtr cl, 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 rfbSendRectEncodingRaw (rfbClientPtr cl, int x, int y, int w, int h)
 
rfbBool rfbSendRectEncodingRRE (rfbClientPtr cl, int x, int y, int w, int h)
 
rfbBool rfbSendRectEncodingUltra (rfbClientPtr cl, int x, int y, int w, int h)
 
void rfbSendServerCutText (rfbScreenInfoPtr rfbScreen, char *str, int len)
 
rfbBool rfbSendSetColourMapEntries (rfbClientPtr cl, int firstColour, int nColours)
 
rfbBool rfbSendTextChatMessage (rfbClientPtr cl, uint32_t length, char *buffer)
 
rfbBool rfbSendUpdateBuf (rfbClientPtr cl)
 
rfbBool rfbSetClientColourMap (rfbClientPtr cl, int firstColour, int nColours)
 
void rfbSetClientColourMaps (rfbScreenInfoPtr rfbScreen, int firstColour, int nColours)
 
void rfbSetCursor (rfbScreenInfoPtr rfbScreen, rfbCursorPtr c)
 
rfbBool rfbSetNonBlocking (int sock)
 
void rfbSetProtocolVersion (rfbScreenInfoPtr rfbScreen, int major_, int minor_)
 
void rfbSetServerVersionIdentity (rfbScreenInfoPtr screen, char *fmt,...)
 
rfbBool rfbSetTranslateFunction (rfbClientPtr cl)
 
void rfbShutdownServer (rfbScreenInfoPtr rfbScreen, rfbBool disconnectClients)
 
void rfbShutdownSockets (rfbScreenInfoPtr rfbScreen)
 
void rfbStartOnHoldClient (rfbClientPtr cl)
 
int rfbStatGetEncodingCountRcvd (rfbClientPtr cl, uint32_t type)
 
int rfbStatGetEncodingCountSent (rfbClientPtr cl, uint32_t type)
 
int rfbStatGetMessageCountRcvd (rfbClientPtr cl, uint32_t type)
 
int rfbStatGetMessageCountSent (rfbClientPtr cl, uint32_t type)
 
int rfbStatGetRcvdBytes (rfbClientPtr cl)
 
int rfbStatGetRcvdBytesIfRaw (rfbClientPtr cl)
 
int rfbStatGetSentBytes (rfbClientPtr cl)
 
int rfbStatGetSentBytesIfRaw (rfbClientPtr cl)
 
rfbStatList * rfbStatLookupEncoding (rfbClientPtr cl, uint32_t type)
 
rfbStatList * rfbStatLookupMessage (rfbClientPtr cl, uint32_t type)
 
void rfbStatRecordEncodingRcvd (rfbClientPtr cl, uint32_t type, int byteCount, int byteIfRaw)
 
void rfbStatRecordEncodingSent (rfbClientPtr cl, uint32_t type, int byteCount, int byteIfRaw)
 
void rfbStatRecordEncodingSentAdd (rfbClientPtr cl, uint32_t type, int byteCount)
 
void rfbStatRecordMessageRcvd (rfbClientPtr cl, uint32_t type, int byteCount, int byteIfRaw)
 
void rfbStatRecordMessageSent (rfbClientPtr cl, uint32_t type, int byteCount, int byteIfRaw)
 
int rfbStringToAddr (char *string, in_addr_t *addr)
 
void rfbTranslateNone (char *table, rfbPixelFormat *in, rfbPixelFormat *out, char *iptr, char *optr, int bytesBetweenInputLines, int width, int height)
 
void rfbUnregisterProtocolExtension (rfbProtocolExtension *extension)
 
void rfbUnregisterSecurityHandler (rfbSecurityHandler *handler)
 
void rfbUnregisterTightVNCFileTransferExtension ()
 
rfbBool rfbUpdateClient (rfbClientPtr cl)
 
void rfbUsage (void)
 
void rfbWholeFontBBox (rfbFontDataPtr font, int *x1, int *y1, int *x2, int *y2)
 
int rfbWidthOfChar (rfbFontDataPtr font, unsigned char c)
 
int rfbWidthOfString (rfbFontDataPtr font, const char *string)
 
int rfbWriteExact (rfbClientPtr cl, const char *buf, int len)
 

Variables

rfbBool rfbEconomicTranslate
 
char rfbEndianTest
 
rfbLogProc rfbErr
 
rfbLogProc rfbLog
 
int rfbMaxClientWait
 
unsigned char rfbReverseByte [0x100]
 

Detailed Description

Macro Definition Documentation

#define COND (   cond)

Definition at line 92 of file libvncserver/rfb/rfb.h.

#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))
FALSE
#define FALSE
Definition: rfbproto.h:104
sraRgnEmpty
rfbBool sraRgnEmpty(const sraRegion *rgn)

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

Definition at line 634 of file libvncserver/rfb/rfb.h.

#define IF_PTHREADS (   x)

Definition at line 95 of file libvncserver/rfb/rfb.h.

#define INIT_COND (   cond)

Definition at line 93 of file libvncserver/rfb/rfb.h.

#define INIT_MUTEX (   mutex)

Definition at line 88 of file libvncserver/rfb/rfb.h.

#define LOCK (   mutex)

Definition at line 85 of file libvncserver/rfb/rfb.h.

#define MUTEX (   mutex)

Definition at line 87 of file libvncserver/rfb/rfb.h.

#define rfbInitServer   rfbInitServerWithoutPthreadsAndZRLE

Definition at line 114 of file libvncserver/rfb/rfb.h.

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

Definition at line 647 of file libvncserver/rfb/rfb.h.

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

Definition at line 665 of file libvncserver/rfb/rfb.h.

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

Definition at line 660 of file libvncserver/rfb/rfb.h.

#define Swap24 (   l)
Value:
((((l) & 0xff) << 16) | (((l) >> 16) & 0xff) | \
(((l) & 0x00ff00)))

Definition at line 649 of file libvncserver/rfb/rfb.h.

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

Definition at line 666 of file libvncserver/rfb/rfb.h.

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

Definition at line 661 of file libvncserver/rfb/rfb.h.

#define Swap32 (   l)
Value:
(((l) >> 24) | \
(((l) & 0x00ff0000) >> 8) | \
(((l) & 0x0000ff00) << 8) | \
((l) << 24))

Definition at line 652 of file libvncserver/rfb/rfb.h.

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

Definition at line 667 of file libvncserver/rfb/rfb.h.

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

Definition at line 662 of file libvncserver/rfb/rfb.h.

#define TINI_COND (   cond)

Definition at line 94 of file libvncserver/rfb/rfb.h.

#define TINI_MUTEX (   mutex)

Definition at line 89 of file libvncserver/rfb/rfb.h.

#define TSIGNAL (   cond)

Definition at line 90 of file libvncserver/rfb/rfb.h.

#define ULTRA_MAX_RECT_SIZE   (128*256)

Definition at line 778 of file libvncserver/rfb/rfb.h.

#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: libvncserver/rfb/rfb.h:778

Definition at line 779 of file libvncserver/rfb/rfb.h.

#define UNLOCK (   mutex)

Definition at line 86 of file libvncserver/rfb/rfb.h.

#define WAIT (   cond,
  mutex 
)    this_is_unsupported

Definition at line 91 of file libvncserver/rfb/rfb.h.

Typedef Documentation

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

Definition at line 394 of file libvncserver/rfb/rfb.h.

typedef struct rfbClientIterator* rfbClientIteratorPtr

Definition at line 692 of file libvncserver/rfb/rfb.h.

typedef struct _rfbClientRec * rfbClientPtr
typedef struct _rfbClientRec rfbClientRec
typedef struct rfbCursor rfbCursor
typedef struct rfbCursor * rfbCursorPtr
typedef void(* rfbDisplayFinishedHookPtr)(struct _rfbClientRec *cl, int result)

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

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

Definition at line 142 of file libvncserver/rfb/rfb.h.

typedef struct _rfbExtensionData rfbExtensionData
typedef struct _rfbFileTransferData rfbFileTransferData
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 162 of file libvncserver/rfb/rfb.h.

typedef struct rfbFontData rfbFontData
typedef struct rfbFontData* rfbFontDataPtr
typedef struct rfbCursor*(* rfbGetCursorProcPtr)(struct _rfbClientRec *pScreen)

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

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

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

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

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

Definition at line 134 of file libvncserver/rfb/rfb.h.

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

Definition at line 135 of file libvncserver/rfb/rfb.h.

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

Definition at line 914 of file libvncserver/rfb/rfb.h.

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

Definition at line 141 of file libvncserver/rfb/rfb.h.

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

Definition at line 140 of file libvncserver/rfb/rfb.h.

typedef struct _rfbProtocolExtension rfbProtocolExtension

Protocol extension handling.

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

Definition at line 136 of file libvncserver/rfb/rfb.h.

typedef struct _rfbScreenInfo rfbScreenInfo

Per-screen (framebuffer) structure.

There can be as many as you wish, each serving different clients. However, you have to call rfbProcessEvents for each of these.

typedef struct _rfbScreenInfo * rfbScreenInfoPtr
typedef struct _rfbSecurity rfbSecurityHandler

Security handling (RFB protocol version 3.7)

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 157 of file libvncserver/rfb/rfb.h.

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 152 of file libvncserver/rfb/rfb.h.

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

Handle the textchat messages.

Definition at line 164 of file libvncserver/rfb/rfb.h.

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

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

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

Definition at line 137 of file libvncserver/rfb/rfb.h.

typedef struct _rfbStatList rfbStatList
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 378 of file libvncserver/rfb/rfb.h.

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

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

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 897 of file libvncserver/rfb/rfb.h.

typedef struct sraRegion* sraRegionPtr

Definition at line 388 of file libvncserver/rfb/rfb.h.

Enumeration Type Documentation

enum rfbNewClientAction
Enumerator
RFB_CLIENT_ACCEPT 
RFB_CLIENT_ON_HOLD 
RFB_CLIENT_REFUSE 

Definition at line 122 of file libvncserver/rfb/rfb.h.

enum rfbSocketState
Enumerator
RFB_SOCKET_INIT 
RFB_SOCKET_READY 
RFB_SOCKET_SHUTDOWN 

Definition at line 128 of file libvncserver/rfb/rfb.h.

Function Documentation

enum rfbNewClientAction defaultNewClientHook ( rfbClientPtr  cl)
char* encodingName ( uint32_t  enc,
char *  buf,
int  len 
)
char* messageNameClient2Server ( uint32_t  type,
char *  buf,
int  len 
)
char* messageNameServer2Client ( uint32_t  type,
char *  buf,
int  len 
)
void rfbAuthNewClient ( rfbClientPtr  cl)
void rfbAuthProcessClientMessage ( rfbClientPtr  cl)
int rfbCheckFds ( rfbScreenInfoPtr  rfbScreen,
long  usec 
)
rfbBool rfbCheckPasswordByList ( rfbClientPtr  cl,
const char *  response,
int  len 
)

to check against plain passwords

void rfbClientConnectionGone ( rfbClientPtr  cl)
void rfbClientConnFailed ( rfbClientPtr  cl,
const char *  reason 
)
rfbClientPtr rfbClientIteratorNext ( rfbClientIteratorPtr  iterator)
void rfbClientListInit ( rfbScreenInfoPtr  rfbScreen)
void rfbCloseClient ( rfbClientPtr  cl)
int rfbConnect ( rfbScreenInfoPtr  rfbScreen,
char *  host,
int  port 
)
int rfbConnectToTcpAddr ( char *  host,
int  port 
)
void rfbConvertLSBCursorBitmapOrMask ( int  width,
int  height,
unsigned char *  bitmap 
)
void rfbDecrClientRef ( rfbClientPtr  cl)
void rfbDefaultPtrAddEvent ( int  buttonMask,
int  x,
int  y,
rfbClientPtr  cl 
)

cursor handling for the pointer

rfbBool rfbDisableExtension ( rfbClientPtr  cl,
rfbProtocolExtension *  extension 
)
void rfbDisconnectUDPSock ( rfbScreenInfoPtr  rfbScreen)
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 rfbDoNothingWithClient ( rfbClientPtr  cl)
int rfbDrawChar ( rfbScreenInfoPtr  rfbScreen,
rfbFontDataPtr  font,
int  x,
int  y,
unsigned char  c,
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

void rfbDrawLine ( rfbScreenInfoPtr  s,
int  x1,
int  y1,
int  x2,
int  y2,
rfbPixel  col 
)
void rfbDrawPixel ( rfbScreenInfoPtr  s,
int  x,
int  y,
rfbPixel  col 
)
void rfbDrawString ( rfbScreenInfoPtr  rfbScreen,
rfbFontDataPtr  font,
int  x,
int  y,
const char *  string,
rfbPixel  colour 
)
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 
)
rfbBool rfbEnableExtension ( rfbClientPtr  cl,
rfbProtocolExtension *  extension,
void *  data 
)
void rfbFillRect ( rfbScreenInfoPtr  s,
int  x1,
int  y1,
int  x2,
int  y2,
rfbPixel  col 
)
void rfbFontBBox ( rfbFontDataPtr  font,
unsigned char  c,
int *  x1,
int *  y1,
int *  x2,
int *  y2 
)
void rfbFreeCursor ( rfbCursorPtr  cursor)
void rfbFreeFont ( rfbFontDataPtr  font)

free a dynamically loaded font

rfbClientIteratorPtr rfbGetClientIterator ( rfbScreenInfoPtr  rfbScreen)
void* rfbGetExtensionClientData ( rfbClientPtr  cl,
rfbProtocolExtension *  extension 
)
struct _rfbProtocolExtension* rfbGetExtensionIterator ( )
rfbScreenInfoPtr rfbGetScreen ( int *  argc,
char **  argv,
int  width,
int  height,
int  bitsPerSample,
int  samplesPerPixel,
int  bytesPerPixel 
)
void rfbGotXCutText ( rfbScreenInfoPtr  rfbScreen,
char *  str,
int  len 
)
void rfbHttpCheckFds ( rfbScreenInfoPtr  rfbScreen)
void rfbHttpInitSockets ( rfbScreenInfoPtr  rfbScreen)
void rfbHttpShutdownSockets ( rfbScreenInfoPtr  rfbScreen)
void rfbIncrClientRef ( rfbClientPtr  cl)
void rfbInitServer ( rfbScreenInfoPtr  rfbScreen)
void rfbInitSockets ( rfbScreenInfoPtr  rfbScreen)
rfbBool rfbIsActive ( rfbScreenInfoPtr  screenInfo)
int rfbListenOnTCPPort ( int  port,
in_addr_t  iface 
)
int rfbListenOnUDPPort ( int  port,
in_addr_t  iface 
)
rfbFontDataPtr rfbLoadConsoleFont ( char *  filename)

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

void rfbLogEnable ( int  enabled)
void rfbLogPerror ( const char *  str)
char* rfbMakeMaskForXCursor ( int  width,
int  height,
char *  cursorString 
)
char* rfbMakeMaskFromAlphaSource ( int  width,
int  height,
unsigned char *  alphaSource 
)
void rfbMakeRichCursorFromXCursor ( rfbScreenInfoPtr  rfbScreen,
rfbCursorPtr  cursor 
)
rfbCursorPtr rfbMakeXCursor ( int  width,
int  height,
char *  cursorString,
char *  maskString 
)
void rfbMakeXCursorFromRichCursor ( rfbScreenInfoPtr  rfbScreen,
rfbCursorPtr  cursor 
)
void rfbMarkRectAsModified ( rfbScreenInfoPtr  rfbScreen,
int  x1,
int  y1,
int  x2,
int  y2 
)
void rfbMarkRegionAsModified ( rfbScreenInfoPtr  rfbScreen,
sraRegionPtr  modRegion 
)
rfbClientPtr rfbNewClient ( rfbScreenInfoPtr  rfbScreen,
int  sock 
)
void rfbNewClientConnection ( rfbScreenInfoPtr  rfbScreen,
int  sock 
)
void rfbNewFramebuffer ( rfbScreenInfoPtr  rfbScreen,
char *  framebuffer,
int  width,
int  height,
int  bitsPerSample,
int  samplesPerPixel,
int  bytesPerPixel 
)
rfbClientPtr rfbNewUDPClient ( rfbScreenInfoPtr  rfbScreen)
void rfbNewUDPConnection ( rfbScreenInfoPtr  rfbScreen,
int  sock 
)
void rfbPrintStats ( rfbClientPtr  cl)
rfbBool rfbProcessArguments ( rfbScreenInfoPtr  rfbScreen,
int *  argc,
char *  argv[] 
)
void rfbProcessClientMessage ( rfbClientPtr  cl)
void rfbProcessClientSecurityType ( rfbClientPtr  cl)
rfbBool rfbProcessEvents ( rfbScreenInfoPtr  screenInfo,
long  usec 
)
rfbBool rfbProcessFileTransfer ( rfbClientPtr  cl,
uint8_t  contentType,
uint8_t  contentParam,
uint32_t  size,
uint32_t  length 
)
char * rfbProcessFileTransferReadBuffer ( rfbClientPtr  cl,
uint32_t  length 
)
rfbBool rfbProcessNewConnection ( rfbScreenInfoPtr  rfbScreen)
rfbBool rfbProcessSizeArguments ( int *  width,
int *  height,
int *  bpp,
int *  argc,
char *  argv[] 
)
void rfbProcessUDPInput ( rfbScreenInfoPtr  rfbScreen)
void rfbPurgeArguments ( int *  argc,
int *  position,
int  count,
char *  argv[] 
)
int rfbReadExact ( rfbClientPtr  cl,
char *  buf,
int  len 
)
int rfbReadExactTimeout ( rfbClientPtr  cl,
char *  buf,
int  len,
int  timeout 
)
void rfbRefuseOnHoldClient ( rfbClientPtr  cl)
void rfbRegisterProtocolExtension ( rfbProtocolExtension *  extension)
void rfbRegisterSecurityHandler ( rfbSecurityHandler *  handler)
void rfbRegisterTightVNCFileTransferExtension ( )
void rfbReleaseClientIterator ( rfbClientIteratorPtr  iterator)
void rfbReleaseExtensionIterator ( )
void rfbResetStats ( rfbClientPtr  cl)
rfbClientPtr rfbReverseConnection ( rfbScreenInfoPtr  rfbScreen,
char *  host,
int  port 
)
void rfbRunEventLoop ( rfbScreenInfoPtr  screenInfo,
long  usec,
rfbBool  runInBackground 
)
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 rfbScreenCleanup ( rfbScreenInfoPtr  screenInfo)
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 rfbSendBell ( rfbScreenInfoPtr  rfbScreen)
rfbBool rfbSendCopyRegion ( rfbClientPtr  cl,
sraRegionPtr  reg,
int  dx,
int  dy 
)
rfbBool rfbSendCursorPos ( rfbClientPtr  cl)
rfbBool rfbSendCursorShape ( rfbClientPtr  cl)
rfbBool rfbSendDirContent ( rfbClientPtr  cl,
int  length,
char *  buffer 
)
rfbBool rfbSendFileTransferChunk ( rfbClientPtr  cl)
rfbBool rfbSendFileTransferMessage ( rfbClientPtr  cl,
uint8_t  contentType,
uint8_t  contentParam,
uint32_t  size,
uint32_t  length,
const char *  buffer 
)
rfbBool rfbSendFramebufferUpdate ( rfbClientPtr  cl,
sraRegionPtr  updateRegion 
)
rfbBool rfbSendLastRectMarker ( rfbClientPtr  cl)
rfbBool rfbSendNewFBSize ( rfbClientPtr  cl,
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 rfbSendRectEncodingRaw ( rfbClientPtr  cl,
int  x,
int  y,
int  w,
int  h 
)
rfbBool rfbSendRectEncodingRRE ( rfbClientPtr  cl,
int  x,
int  y,
int  w,
int  h 
)
rfbBool rfbSendRectEncodingUltra ( rfbClientPtr  cl,
int  x,
int  y,
int  w,
int  h 
)
void rfbSendServerCutText ( rfbScreenInfoPtr  rfbScreen,
char *  str,
int  len 
)
rfbBool rfbSendSetColourMapEntries ( rfbClientPtr  cl,
int  firstColour,
int  nColours 
)
rfbBool rfbSendTextChatMessage ( rfbClientPtr  cl,
uint32_t  length,
char *  buffer 
)

send a TextChat message to a client

rfbBool rfbSendUpdateBuf ( rfbClientPtr  cl)
rfbBool rfbSetClientColourMap ( rfbClientPtr  cl,
int  firstColour,
int  nColours 
)
void rfbSetClientColourMaps ( rfbScreenInfoPtr  rfbScreen,
int  firstColour,
int  nColours 
)
void rfbSetCursor ( rfbScreenInfoPtr  rfbScreen,
rfbCursorPtr  c 
)
rfbBool rfbSetNonBlocking ( int  sock)
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.

void rfbSetServerVersionIdentity ( rfbScreenInfoPtr  screen,
char *  fmt,
  ... 
)
rfbBool rfbSetTranslateFunction ( rfbClientPtr  cl)
void rfbShutdownServer ( rfbScreenInfoPtr  rfbScreen,
rfbBool  disconnectClients 
)
void rfbShutdownSockets ( rfbScreenInfoPtr  rfbScreen)
void rfbStartOnHoldClient ( rfbClientPtr  cl)
int rfbStatGetEncodingCountRcvd ( rfbClientPtr  cl,
uint32_t  type 
)
int rfbStatGetEncodingCountSent ( rfbClientPtr  cl,
uint32_t  type 
)
int rfbStatGetMessageCountRcvd ( rfbClientPtr  cl,
uint32_t  type 
)
int rfbStatGetMessageCountSent ( rfbClientPtr  cl,
uint32_t  type 
)
int rfbStatGetRcvdBytes ( rfbClientPtr  cl)
int rfbStatGetRcvdBytesIfRaw ( rfbClientPtr  cl)
int rfbStatGetSentBytes ( rfbClientPtr  cl)
int rfbStatGetSentBytesIfRaw ( rfbClientPtr  cl)
rfbStatList* rfbStatLookupEncoding ( rfbClientPtr  cl,
uint32_t  type 
)
rfbStatList* rfbStatLookupMessage ( rfbClientPtr  cl,
uint32_t  type 
)
void rfbStatRecordEncodingRcvd ( rfbClientPtr  cl,
uint32_t  type,
int  byteCount,
int  byteIfRaw 
)
void rfbStatRecordEncodingSent ( rfbClientPtr  cl,
uint32_t  type,
int  byteCount,
int  byteIfRaw 
)
void rfbStatRecordEncodingSentAdd ( rfbClientPtr  cl,
uint32_t  type,
int  byteCount 
)
void rfbStatRecordMessageRcvd ( rfbClientPtr  cl,
uint32_t  type,
int  byteCount,
int  byteIfRaw 
)
void rfbStatRecordMessageSent ( rfbClientPtr  cl,
uint32_t  type,
int  byteCount,
int  byteIfRaw 
)
int rfbStringToAddr ( char *  string,
in_addr_t *  addr 
)
void rfbTranslateNone ( char *  table,
rfbPixelFormat *  in,
rfbPixelFormat *  out,
char *  iptr,
char *  optr,
int  bytesBetweenInputLines,
int  width,
int  height 
)
void rfbUnregisterProtocolExtension ( rfbProtocolExtension *  extension)
void rfbUnregisterSecurityHandler ( rfbSecurityHandler *  handler)
void rfbUnregisterTightVNCFileTransferExtension ( )
rfbBool rfbUpdateClient ( rfbClientPtr  cl)
void rfbUsage ( void  )
void rfbWholeFontBBox ( rfbFontDataPtr  font,
int *  x1,
int *  y1,
int *  x2,
int *  y2 
)

this returns the smallest box enclosing any character of font.

int rfbWidthOfChar ( rfbFontDataPtr  font,
unsigned char  c 
)
int rfbWidthOfString ( rfbFontDataPtr  font,
const char *  string 
)
int rfbWriteExact ( rfbClientPtr  cl,
const char *  buf,
int  len 
)

Variable Documentation

rfbBool rfbEconomicTranslate
char rfbEndianTest
rfbLogProc rfbErr
rfbLogProc rfbLog
int rfbMaxClientWait
unsigned char rfbReverseByte[0x100]
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:29:41 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

krfb

Skip menu "krfb"
  • Main Page
  • Namespace List
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages

kdenetwork API Reference

Skip menu "kdenetwork API Reference"
  • kget
  • kopete
  •   kopete
  •   libkopete
  • krdc
  • krfb

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal