public interface Server
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.
|
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.
|
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
|
boolean connect() throws java.io.IOException
java.io.IOException
- I/O failurevoid disconnect() throws java.io.IOException
java.io.IOException
- I/O failureboolean isConnected()
@Nullable java.util.List<ProtocolVersion> getSupportedVersion()
@NonNull HandshakeResult handshake(@NonNull HandshakeRequest handshakeRequest) throws java.io.IOException
handshakeRequest
- - a valid handshake requestjava.io.IOException
- I/O failure@NonNull ConfigureCommandResult configure(@NonNull java.lang.String... cacheArguments) throws java.io.IOException
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 ComputeResult compute() throws java.io.IOException
java.io.IOException
- I/O failure@NonNull CodeModel codemodel() throws java.io.IOException
java.io.IOException
- I/O failure@NonNull CacheResult cache() throws java.io.IOException
java.io.IOException
- I/O failure@NonNull CmakeInputsResult cmakeInputs() throws java.io.IOException
java.io.IOException
- I/O failure@NonNull GlobalSettings globalSettings() throws java.io.IOException
java.io.IOException
- I/O failure@NonNull java.lang.String getCCompilerExecutable()
@NonNull java.lang.String getCppCompilerExecutable()
@NonNull java.lang.String getCmakePath()