(index ("rfb-server" 0) ("rfb-connect" 253) ("rfb-close" 622) ("read-client-message" 736) ("framebuffer-update-rectangle" 1674) ("framebuffer-update-rectangles" 1950) ("set-colour-map-entries" 2116) ("bell" 2311) ("server-cut-text" 2405) ("read-server-message" 2537) ("set-pixel-format" 3748) ("set-encoding-type" 3997) ("framebuffer-update-request" 4137) ("key-event" 4376) ("pointer-event" 4516) ("client-cut-text" 4659) ("encoding-type" 4791) ("encoding-type-name" 5389) ("register-encoding-type" 5531) ("rfb-session?" 6096) ("rfb-session-encoding-type" 6218) ("rfb-session-pixel-format" 6218) ("rfb-session-width" 6218) ("rfb-session-height" 6218) ("rfb-session-shared?" 6218) ("rfb-session-name" 6218) ("rfb-session-input-port" 6218) ("rfb-session-output-port" 6218) ("pixel-format" 6891) ("pixel-format?" 7253) ("pixel-format-bits-per-pixel" 7378) ("pixel-format-depth" 7378) ("pixel-format-big-endian?" 7378) ("pixel-format-true-color?" 7378) ("pixel-format-red-max" 7378) ("pixel-format-green-max" 7378) ("pixel-format-blue-max" 7378) ("pixel-format-red-shift" 7378) ("pixel-format-green-shift" 7378) ("pixel-format-blue-shift" 7378) ("pixel-format-bits-per-pixel" 7378) ("convert-to-pixel-format" 8340) ("rectangle" 8524) ("copy-rectangle" 8714))
(def (sig (procedure "(rfb-server #!key (port 5900) access (name \"rfb\"))" (id rfb-server))) (p "Creates a TCP socket and waits for clients to connect on the given port. Returns an " (tt "rfb-session") " object if a connection could be established."))
(def (sig (procedure "(rfb-connect HOSTNAME #!key (port 5900) shared)" (id rfb-connect))) (p "Connects to an RFB server on the given host and port. If " (tt "shared") " is given and true, then this requests a non-exclusive connection, where other clients are allowed to share this session. Returns an " (tt "rfb-session") " when the connection could be established."))
(def (sig (procedure "(rfb-close RFBSESSION)" (id rfb-close))) (p "Closes an RFB client- or server connection."))
(def (sig (procedure "(read-client-message RFBSESSION)" (id read-client-message))) (p "Waits for a message from an RFB client and returns an s-expression representing the message or end-of-file if the connection was closed.") (p "Client messages may be any of the following:") (table (tr (th "Message") (th "Meaning")) "\n" (tr (td "(SetPixelFormat PIXELFORMAT)") (td "Client request to change the pixel format to the one given in the contained pixel-format object")) "\n" (tr (td "(SetEncodingType INTEGER ...)") (td "Client request to change the current encoding type")) "\n" (tr (td "(FramebufferUpdateRequest INCREMENTAL? X Y W H)") (td "Client request for changes covering the designated area")) "\n" (tr (td "(KeyEvent DOWN? KEYCODE)") (td "Key-up/down event")) "\n" (tr (td "(PointerEvent BUTTONMASK X Y)") (td "Mouse and/or Mousebutton event")) "\n" (tr (td "(ClientCutText STRING)") (td "Request to copy string to clipboard"))))
(def (sig (procedure "(framebuffer-update-rectangle RFBSESSION RECTANGLE)" (id framebuffer-update-rectangle))) (p "Sends a " (tt "FramebufferUpdateRequest") " to the client. " (tt "RECTANGLE") " should be a rectangle object as returned by " (tt "rectangle") " (see below)."))
(def (sig (procedure "(framebuffer-update-rectangles RFBSESSION RECTANGLELIST)" (id framebuffer-update-rectangles))) (p "Sends a list of rectangles to the client."))
(def (sig (procedure "(set-colour-map-entries RFBSESSION U16VECTOR #!optional (first 0))" (id set-colour-map-entries))) (p "Sends a request to change an entry in the colour map of the client."))
(def (sig (procedure "(bell RFBSESSION)" (id bell))) (p "Asks the client to ring the bell."))
(def (sig (procedure "(server-cut-text RFBSESSION STRING)" (id server-cut-text))) (p "Copies a string to the client's clipboard."))
(def (sig (procedure "(read-server-message RFBSESSION)" (id read-server-message))) (p "Waits for a message from an RFB server and resturns an s-expression representing the message or end-of-file if the connection was closed.") (p "Server messages may be any of the following:") (table (tr (th "Message") (th "Meaning")) "\n" (tr (td "(FramebufferUpdate RECT ...)") (td "Sends a list of rectangles to be updated, see brlow for a description of RECT")) "\n" (tr (td "(SetColourMapEntries INDEX U16VECTOR)") (td "Server request to change the entries in the colour-map to the RGB values given in the vector, starting at colour-index INDEX")) "\n" (tr (td "(Bell)") (td "Server request to the ring bell")) "\n" (tr (td "(ServerCutText STRING)") (td "Text pasted from clipboard"))) (p "A RECT sent via a framebuffer update request has one of the following forms:") (dl (dt (tt "(Raw #(X Y W H U8VECTOR))")) (dd "A bitmap in \"Raw\" encoding with given position, shape and data") (dt (tt "(CopyRect #(X Y W H X2 Y2))")) (dd "A request to copy the bitmap with the given position and size to position X2/Y2")) (p "Other encoding types can be handled using the " (tt "register-encoding-type") " procedure (see below)."))
(def (sig (procedure "(set-pixel-format RFBSESSION PIXELFORMAT)" (id set-pixel-format))) (p "Requests to change the pixel format to " (tt "PIXELFORMAT") ", which should be a pixel-format object as returned by " (tt "pixel-format") " (see below)."))
(def (sig (procedure "(set-encoding-type RFBSESSION INTEGER)" (id set-encoding-type))) (p "Requests to change the default encoding type."))
(def (sig (procedure "(framebuffer-update-request RFBSESSION X Y W H #!optional (incremental #t))" (id framebuffer-update-request))) (p "Requests an update for the given framebuffer area, optionally asking only for incremental changes."))
(def (sig (procedure "(key-event RFBSESSION KEYCODE #!optional (down #t))" (id key-event))) (p "Sends a key-up/down event to the server."))
(def (sig (procedure "(pointer-event RFBSESSION BUTTONMASK X Y)" (id pointer-event))) (p "Sends a mouse move or button event to the server."))
(def (sig (procedure "(client-cut-text RFBSESSION STRING)" (id client-cut-text))) (p "Copies a string to the server's clipboard."))
(def (sig (procedure "(encoding-type SYMBOL)" (id encoding-type))) (p "Returns the integer code of the encoding type designated by " (tt "SYMBOL") ". Predefined encoding type names are:") (table (tr (th "Name") (th "Encoding type")) "\n" (tr (td "Raw") (td "0")) "\n" (tr (td "CopyRect") (td "1")) "\n" (tr (td "RRE") (td "02")) "\n" (tr (td "Hextile") (td "5")) "\n" (tr (td "TRLE") (td "15")) "\n" (tr (td "ZRLE") (td "16")) "\n" (tr (td "Cursor") (td "-239")) "\n" (tr (td "DesktopSize") (td "-223"))) (p "Other encoding types can be defined by " (tt "register-encoding-type") " (see below)."))
(def (sig (procedure "(encoding-type-name INTEGER)" (id encoding-type-name))) (p "Returns the name associated with the encoding type code."))
(def (sig (procedure "(register-encoding-type INTEGER SYMBOL DECODER)" (id register-encoding-type))) (p "Defines a custom encoding type with the given code and name. " (tt "DECODER") " should be a procedure and will be called in an RFB client when a server sends data of this type. The procedure should take a single argument, the port from which the data should be read.  The returned value will be added to a " (tt "(FramebufferUpdate ...)") "  message expression and returned when the server message is translated in a call to " (tt "read-server-message") "."))
(def (sig (procedure "(rfb-session? X)" (id rfb-session?))) (p "Returns true if " (tt "X") " is an rfb session object."))
(def (sig (procedure "(rfb-session-encoding-type RFBSESSION)" (id rfb-session-encoding-type)) (procedure "(rfb-session-pixel-format RFBSESSION)" (id rfb-session-pixel-format)) (procedure "(rfb-session-width RFBSESSION)" (id rfb-session-width)) (procedure "(rfb-session-height RFBSESSION)" (id rfb-session-height)) (procedure "(rfb-session-shared? RFBSESSION)" (id rfb-session-shared?)) (procedure "(rfb-session-name RFBSESSION)" (id rfb-session-name)) (procedure "(rfb-session-input-port RFBSESSION)" (id rfb-session-input-port)) (procedure "(rfb-session-output-port RFBSESSION)" (id rfb-session-output-port))) (p "Accessors for the components of an RFB session object."))
(def (sig (procedure "(pixel-format #!key (bits-per-pixel 32) (depth 24) (big-endian X) (true-color #t) (red-max 255) (green-max 255) (blue-max 255) (red-shift 16) (green-shift 8) (blue-shift 0))" (id pixel-format))) (p "Returns a pixel-format object representing the given pixel format. The endinanness defaults to the endianness this process is running on."))
(def (sig (procedure "(pixel-format? X)" (id pixel-format?))) (p "Returns true, if " (tt "X") " is a pixel-format object."))
(def (sig (procedure "(pixel-format-bits-per-pixel PIXELFORMAT)" (id pixel-format-bits-per-pixel)) (procedure "(pixel-format-depth PIXELFORMAT)" (id pixel-format-depth)) (procedure "(pixel-format-big-endian? PIXELFORMAT)" (id pixel-format-big-endian?)) (procedure "(pixel-format-true-color? PIXELFORMAT)" (id pixel-format-true-color?)) (procedure "(pixel-format-red-max PIXELFORMAT)" (id pixel-format-red-max)) (procedure "(pixel-format-green-max PIXELFORMAT)" (id pixel-format-green-max)) (procedure "(pixel-format-blue-max PIXELFORMAT)" (id pixel-format-blue-max)) (procedure "(pixel-format-red-shift PIXELFORMAT)" (id pixel-format-red-shift)) (procedure "(pixel-format-green-shift PIXELFORMAT)" (id pixel-format-green-shift)) (procedure "(pixel-format-blue-shift PIXELFORMAT)" (id pixel-format-blue-shift)) (procedure "(pixel-format-bits-per-pixel PIXELFORMAT)" (id pixel-format-bits-per-pixel))) (p "Accessors for the components of a pixel-format object."))
(def (sig (procedure "(convert-to-pixel-format RECTANGLE PIXELFORMAT)" (id convert-to-pixel-format))) (p "Returns a new rectangle with its data converted to the given pixel format."))
(def (sig (procedure "(rectangle X Y W H U32VECTOR #!optional (encoding (encoding-type 'Raw)))" (id rectangle))) (p "Returns an rectangle object representing the given frame-buffer area."))
(def (sig (procedure "(copy-rectangle X Y W H X2 Y2)" (id copy-rectangle))) (p "Returns a rectangle object representing a copy of the framebuffer area with the given position and size."))
