Class PageantLibrary


  • public final class PageantLibrary
    extends java.lang.Object
    The PageantLibrary encapsulates the shared memory access and provides a simple pipe abstraction.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static org.slf4j.Logger LOG  
      private static java.lang.String PAGEANT
      Pageant's "class" and "window name".
      private static int PAGEANT_ID
      Magic constant from Pageant; ID for the CopyStruct used in SendMessage.
    • Constructor Summary

      Constructors 
      Constructor Description
      PageantLibrary()  
    • Field Detail

      • LOG

        private static final org.slf4j.Logger LOG
      • PAGEANT

        private static final java.lang.String PAGEANT
        Pageant's "class" and "window name".
        See Also:
        Constant Field Values
    • Constructor Detail

      • PageantLibrary

        public PageantLibrary()
    • Method Detail

      • isPageantAvailable

        boolean isPageantAvailable()
        Determines whether Pageant is currently running.
        Returns:
        true if Pageant is running, false otherwise
      • createPipe

        PageantLibrary.Pipe createPipe​(java.lang.String name,
                                       int maxSize)
                                throws java.io.IOException
        Creates a new PageantLibrary.Pipe.
        Parameters:
        name - for the pipe
        maxSize - maximum size for messages
        Returns:
        the PageantLibrary.Pipe, or null if none created
        Throws:
        java.io.IOException - on errors
      • close

        private static void close​(LibraryHolder libs,
                                  com.sun.jna.platform.win32.WinNT.HANDLE file,
                                  com.sun.jna.Pointer memory,
                                  boolean silent)
                           throws java.io.IOException
        Throws:
        java.io.IOException