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

krfb

  • sources
  • kde-4.14
  • kdenetwork
  • krfb
  • libvncserver
  • rfb
Classes | Macros | Typedefs | Enumerations | Functions | Variables
libvncserver/rfb/rfb.h File Reference
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "rfbproto.h"
Include dependency graph for libvncserver/rfb/rfb.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

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 UPDATE_BUF_SIZE   30000
 
#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]
 

Macro Definition Documentation

#define UPDATE_BUF_SIZE   30000

UPDATE_BUF_SIZE must be big enough to send at least one whole line of the framebuffer.

So for a max screen width of say 2K with 32-bit pixels this means 8K minimum.

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

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