Welcome to the LGProxy Documentation!

Introduction

LGProxy is a high-performance proxy for the Looking Glass application. It utilizes the Telescope Remote Framebuffer Library for transport over both commodity and RDMA capable networking hardware.

View our GitHub repository.

Developed by the Telescope Project Team.

Table of Contents

• Index

Getting Started

• System Requirements
  • Recommended Specifications
    • Client
      • Using DMABUF & RDMA (best case)
      • No DMABUF & TCP (worst case)
    • Host
      • Uncompressed, using RDMA (best case)
      • Compressed, using TCP (worst case)
  • Bandwidth Calculator
• Installing Dependencies
  • Build Dependencies
  • Fedora and derivatives
  • Ubuntu & Debian
    • All Versions
    • Ubuntu 20.04, Debian 10 and older
    • Ubuntu 21.10, Debian 11 and newer
• Building The Application
• Running The Application
  • Sink
  • Source
  • Setting the log level
    • LGProxy & LibTRF
    • Libfabric
• Running Looking Glass

Bug Reports

• Bug Report Format
• Known Bugs

Developers

• Telescope Project Team
  • Acknowledgements

API Documentation

• Function Documentation
  • Server Side Functions
    • lpHandleClientReq()
    • lpHandleCursorPos()
    • lpInitLgmpClient()
    • lpClientInitSession()
    • lpGetFrame()
    • lpgetCursor()
  • Client Side Functions
    • lpKeepLGMPSessionAlive()
    • lpInitHost()
    • lpSignalFrameDone()
    • lpRequestFrame()
    • lpUpdateCursorPos()
    • lpPostCursor()
    • lpInitShmFile()
    • lpShutdown()
    • lpReinitCursorThread()
    • lpCursorThread()
  • Utilities
    • lpPollMsg()
    • lpParseMemString()
    • lpParsePollString()
    • lpShouldTruncate()
    • lpSetLPLogLevel()
    • lpSetTRFLogLevel()
    • lpSetDefaultOpts()
    • lpCalcFrameSizeNeeded()
    • lpSendDisconnect()
    • lpSendVersion()
  • Type Definitions
    • T_STATE
      • T_STATE::T_RUNNING
      • T_STATE::T_ERR
      • T_STATE::T_STOP
    • LP_STATE
      • LP_STATE::LP_STATE_RUNNING
      • LP_STATE::LP_STATE_INVALID
      • LP_STATE::LP_STATE_STOP
      • LP_STATE::LP_STATE_RESTART
    • LG_RendererCursor
      • LG_RendererCursor::LG_CURSOR_COLOR
      • LG_RendererCursor::LG_CURSOR_MONOCHROME
      • LG_RendererCursor::LG_CURSOR_MASKED_COLOR
    • LPMemState
      • LPMemState::LP_MEM_UNREGISTERED
      • LPMemState::LP_MEM_REGISTERED_TEMP
      • LPMemState::LP_MEM_REGISTERED_PERM
      • LPMemState::LP_MEM_MAX
    • lpAllocContext()
    • lpDestroyContext()
    • LPClient
      • LPClient::lgmp_host
      • LPClient::host_q
      • LPClient::pointer_q
      • LPClient::client_ctx
      • LPClient::sub_channel
      • LPClient::thread_flags
      • LPClient::frame_memory
      • LPClient::pointer_memory
      • LPClient::cursor_shape
      • LPClient::frame_index
      • LPClient::pointer_index
      • LPClient::cursor_shape_index
      • LPClient::pointer_shape_valid
      • LPClient::sub_started
      • LPClient::cursor_thread
    • LPHost
      • LPHost::lgmp_client
      • LPHost::client_q
      • LPHost::pointer_q
      • LPHost::server_ctx
      • LPHost::client_ctx
      • LPHost::sub_channel
      • LPHost::thread_flags
    • LPUserOpts
      • LPUserOpts::poll_int
      • LPUserOpts::delete_exit
    • LPContext
      • LPContext::mem_state
      • LPContext::state
      • LPContext::shm
      • LPContext::ram
      • LPContext::ram_size
      • LPContext::format_valid
      • LPContext::shmFile
      • LPContext::lp_client
      • LPContext::lp_host
      • LPContext::opts
      • LPContext::dma_buf
  • LibTRF Wrapper Functions
    • lpTrfClientInit()
    • lpTrfServerInit()
  • Conversion Functions
    • lpLGToTrfFormat()
    • lpTrftoLGFormat()

Licensing

• Licenses
  • Telescope Libraries
    • Telescope Proxy For Looking Glass (LGProxy)
    • Telescope Remote Framebuffer Library (LibTRF)
  • External Libraries
    • Looking Glass
    • Looking Glass Memory Protocol (LGMP)