Candela Technologies Logo
Network Testing and Emulation Solutions

Diagnose Problems with GUI on Windows

Goal: Learn how to diagnose problems running LANforge client on Windows.

The LANforge client (GUI) can encounter variety of difficulties depending on the amount of RAM and version of Java running on your desktop. Read this guide to learn steps to take to collect error messages and how to fix out of memory problems.
The LANforge client can be both the GUI running interactively, or in headless HTTP mode.
 
  1. Run the client from a CMD window

  2. Right click on LANforge GUI icon and select Open File Location screenshot
  3. You will see the folder wher the LANforge client is installed screenshot
  4. Right click on folder area to right of files, and select Run CMD here or Run PowerShell here. This might require that you Shift-Click on anything that might be selected in the directory to un-select it. screenshot
  5. You will see a terminal window open screenshot
  6. Start the client using the command .\lfclient.batENTER screenshot
    1. Double-clicking lfclient.bat in the Windows Explorer window will start the client in a CMD window, but the window will disappear when the client quit/exits/leaves.
  7. Be Aware of Quick Edit

    1. Quick Edit allows you to highlight text quickly with the mouse; it is a feature of both the CMD and PowerShell windows. CMD windows have the distinct drawback of halting execution while text is highlighted.
    2. Press ESC to clear text selection
    3. You can change the setting by clicking in the upper left corner, selecting Preferences, then look for Qui,ck Select. screenshot

      For more information see Windows Server 2016 Features

  8. Copy an Error

  9. Candelatech introduces features into LANforge quickly, and discovering a problem in the LANforge Client occasionally happens--and we want to hear when it does! You can help by copying the terminal output and emailing it to us (at support@candelatech.com).

    Various kinds of errors leave messages we can find in the terminal like when the LANforge client:

    1. ...will not start after double clicking the icon. This might be caused by a missing or mismatched version of the Java runtime, an error in the start-up script, or a program error.
    2. ...unexpectedly quits. Probably a program error.
    3. ...does not respond. Possibly a program error, caused often you will see many exceptions printed to the terminal.
  10. A Java exception is a rather long list of method calls (a stack trace) that starts with the exception message. Sometimes the exception message is IllegalArgumentException, sometimes it is null (a null pointer exception)

  11. Scroll the terminal window to see the top of the exception and highlight the exception message and as much of the stack trace as possible. Below is a picture of a condition where the LANforge client script has an error and will not start. screenshot
    1. Pressing Enter after highlighting the text copies the text into your clipboard.
    2. The laptop might not have an email client installed. In that case, open notepad.exe or wordpad.exe from via the Start menu, and paste your stack trace into your text editor. screenshot
    3. If your circumstances don't allow highlighting, copying and pasting, you can take a screen capture, usually by pressing Alt+PrtScr shortcut.
    4. When contacting us, please describe the steps you took to reach this error. We need to be able to reproduce the error in order to fix it.
  12. Out of Memory Conditions

  13. Candelatech provides a 32-bit and a 64-bit version of the LANforge client. We generally suggest people use the 64-bit client, because most recent laptops are running 64-bit operating systems. This is a common fix for running out of memory.

    For more information see LANforge Downloads

  14. When running a WiFi Capacity Test, the generated report consumes significantly more memory than a mere HTML or PDF version of the report does. If you have multiple WiFi Capacity Test reports open, we suggest you save them and close the report windows.
  15. Running tests for longer periods of time (like days) can also consume significant memory. By default, the LANforge client will only allocate up to two-thirds (2/3s) of the system memory it detects available at start-up. If there are programs like Chrome, Outlook and possibly Electron based applications open, those can be using most of your laptop's memory to begin with. You might need to exit other programs in Windows and restart the LANforge client in order allow it to have more memory.
  16. You can also edit the start-up script to configure the maximum memory permitted to the Java runtime. That is discussesd next.
  17. Edit the start-up script

  18. While it is possible to edit files with notepad.exe, that text editor has few conveniences. Please consider using Notepad++ if you don't already have a text editor available.

    For more information see Download Notepad++

  19. Right click on the lfclient.bat startup script, and select Edit with Notepadd++ screenshot
    1. The file opens in the editor at the top. You will want to jump to the end of the file. screenshot
    2. At the end of the file, notice the -Xmx option for the java program. You will edit this to the maximum amount of memory you want to allow the program. screenshot
    3. In this example, we've edited the start up script to request 2GB of memory. If you request more than the system will give you, the Java will give you an error and quit. screenshot

      For more information see Tuning Java Machines

  20. Email support@candelatech.com if you have questions or need help.


Candela  Technologies, 2417 Main Street, Suite 201, Ferndale, WA 98248, USA
www.candelatech.com | sales@candelatech.com | +1.360.380.1618
Facebook | LinkedIn | Blog