public class ServerProtocolV1 extends java.lang.Object implements Server
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CMAKE_SERVER_C_COMPILER_PREFIX |
static java.lang.String |
CMAKE_SERVER_C_COMPILER_SUFFIX |
static java.lang.String |
CMAKE_SERVER_CXX_COMPILER_PREFIX |
static java.lang.String |
CMAKE_SERVER_FOOTER_MSG |
static java.lang.String |
CMAKE_SERVER_HEADER_MSG |
Modifier and Type | Method and Description |
---|---|
CacheResult |
cache()
Lists the cached configuration values after the project is configured.
|
CmakeInputsResult |
cmakeInputs()
Requests files used by CMake as part of the build system itself.
|
CodeModel |
codemodel()
Requests the project's code model once its configured successfully.
|
ComputeResult |
compute()
Computes, i.e., generates the build system files in the build directory.
|
ConfigureCommandResult |
configure(java.lang.String... cacheArguments)
Configures our project for build.
|
boolean |
connect()
Starts and connects to a Cmake server and sends a HelloRequest.
|
void |
disconnect()
Disconnected from the Cmake server.
|
void |
finalize() |
java.lang.String |
getCCompilerExecutable()
Returns the compiler executable used C files.
|
java.lang.String |
getCmakePath()
Returns to the path of the Cmake executable.
|
java.lang.String |
getCppCompilerExecutable()
Returns the compiler executable used Cpp files.
|
HelloResult |
getHelloResult() |
java.util.List<ProtocolVersion> |
getSupportedVersion()
Cmake server returns a list of supported versions when a connection is established (via the
HelloResult).
|
GlobalSettings |
globalSettings()
Request to get the state of Cmake (after a successful handshake).
|
HandshakeResult |
handshake(HandshakeRequest handshakeRequest)
One of the first request a client may send to the Cmake server.
|
boolean |
isConnected()
Returns the connection status to the Cmake server
|
public static final java.lang.String CMAKE_SERVER_HEADER_MSG
public static final java.lang.String CMAKE_SERVER_FOOTER_MSG
public static final java.lang.String CMAKE_SERVER_C_COMPILER_PREFIX
public static final java.lang.String CMAKE_SERVER_CXX_COMPILER_PREFIX
public static final java.lang.String CMAKE_SERVER_C_COMPILER_SUFFIX
public void finalize()
finalize
in class java.lang.Object
public boolean connect() throws java.io.IOException
Server
public void disconnect() throws java.io.IOException
Server
disconnect
in interface Server
java.io.IOException
- I/O failurepublic boolean isConnected()
Server
isConnected
in interface Server
@Nullable public java.util.List<ProtocolVersion> getSupportedVersion()
Server
getSupportedVersion
in interface Server
@NonNull public HandshakeResult handshake(@NonNull HandshakeRequest handshakeRequest) throws java.io.IOException
Server
@NonNull public ConfigureCommandResult configure(@NonNull java.lang.String... cacheArguments) throws java.io.IOException
Server
configure
in interface Server
cacheArguments
- list of strings to configure via the cache argument keys. These string
are interpreted similar to cmake command line client.java.io.IOException
- I/O failure@NonNull public ComputeResult compute() throws java.io.IOException
Server
@NonNull public CodeModel codemodel() throws java.io.IOException
Server
@NonNull public CacheResult cache() throws java.io.IOException
Server
@NonNull public GlobalSettings globalSettings() throws java.io.IOException
Server
globalSettings
in interface Server
java.io.IOException
- I/O failure@NonNull public CmakeInputsResult cmakeInputs() throws java.io.IOException
Server
cmakeInputs
in interface Server
java.io.IOException
- I/O failure@NonNull public java.lang.String getCCompilerExecutable()
Server
getCCompilerExecutable
in interface Server
@NonNull public java.lang.String getCppCompilerExecutable()
Server
getCppCompilerExecutable
in interface Server
@NonNull public java.lang.String getCmakePath()
Server
getCmakePath
in interface Server
@NonNull public HelloResult getHelloResult()