com.android.build.gradle.external.cmake.server

Class ServerProtocolV1

java.lang.Object

com.android.build.gradle.external.cmake.server.ServerProtocolV1

All Implemented Interfaces:

Server

public class ServerProtocolV1
extends java.lang.Object
implements Server

Implementation of version 1 of Cmake server for Cmake versions 3.7.1. Cmake server or a long running mode which allows a client to configure and request buildsystem information generated by Cmake. More info: https://cmake.org/cmake/help/v3.7/manual/cmake-server.7.html

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
CacheResult	cache() Lists the cached configuration values after the project is configured.
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	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

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CMAKE_SERVER_HEADER_MSG

public static final java.lang.String CMAKE_SERVER_HEADER_MSG

See Also:

Constant Field Values

CMAKE_SERVER_FOOTER_MSG

public static final java.lang.String CMAKE_SERVER_FOOTER_MSG

See Also:

Constant Field Values

CMAKE_SERVER_C_COMPILER_PREFIX

public static final java.lang.String CMAKE_SERVER_C_COMPILER_PREFIX

See Also:

Constant Field Values

CMAKE_SERVER_CXX_COMPILER_PREFIX

public static final java.lang.String CMAKE_SERVER_CXX_COMPILER_PREFIX

See Also:

Constant Field Values

CMAKE_SERVER_C_COMPILER_SUFFIX

public static final java.lang.String CMAKE_SERVER_C_COMPILER_SUFFIX

See Also:

Constant Field Values

Method Detail

finalize

public void finalize()

Overrides:

finalize in class java.lang.Object

connect

public boolean connect()
                throws java.io.IOException

Description copied from interface: Server

Starts and connects to a Cmake server and sends a HelloRequest.

Specified by:

connect in interface Server

Returns:

true if connected successfully to Cmake server

Throws:

java.io.IOException - I/O failure

disconnect

public void disconnect()
                throws java.io.IOException

Description copied from interface: Server

Disconnected from the Cmake server.

Specified by:

disconnect in interface Server

Throws:

java.io.IOException - I/O failure

isConnected

public boolean isConnected()

Description copied from interface: Server

Returns the connection status to the Cmake server

Specified by:

isConnected in interface Server

Returns:

true if connected Cmake server

getSupportedVersion

public java.util.List<ProtocolVersion> getSupportedVersion()

Description copied from interface: Server

Cmake server returns a list of supported versions when a connection is established (via the HelloResult). This function returns the supported version to be sent for handshake.

Specified by:

getSupportedVersion in interface Server

Returns:

list of protocol versions supported by the server. The list is empty if the server does not support the Cmake server.

handshake

public HandshakeResult handshake(@NonNull
                                 HandshakeRequest handshakeRequest)
                          throws java.io.IOException

Description copied from interface: Server

One of the first request a client may send to the Cmake server.

Specified by:

handshake in interface Server

Parameters:

handshakeRequest - - a valid handshake request

Returns:

HandshakeResult

Throws:

java.io.IOException - I/O failure

configure

public ConfigureCommandResult configure(java.lang.String... cacheArguments)
                                 throws java.io.IOException

Description copied from interface: Server

Configures our project for build.

Specified by:

configure in interface Server

Parameters:

cacheArguments - list of strings to configure via the cache argument keys. These string are interpreted similar to cmake command line client.

Returns:

ConfigureCommandResult - this object holds the ConfigureResult and interactive messages returned by Cmake when configuring the project.

Throws:

java.io.IOException - I/O failure

compute

public ComputeResult compute()
                      throws java.io.IOException

Description copied from interface: Server

Computes, i.e., generates the build system files in the build directory. Ideally, this function should be called only if configure succeeds.

Specified by:

compute in interface Server

Returns:

ComputeResult

Throws:

java.io.IOException - I/O failure

codemodel

public CodeModel codemodel()
                    throws java.io.IOException

Description copied from interface: Server

Requests the project's code model once its configured successfully.

Specified by:

codemodel in interface Server

Returns:

CodeModel

Throws:

java.io.IOException - I/O failure

cache

public CacheResult cache()
                  throws java.io.IOException

Description copied from interface: Server

Lists the cached configuration values after the project is configured.

Specified by:

cache in interface Server

Returns:

CacheResult

Throws:

java.io.IOException - I/O failure

globalSettings

public GlobalSettings globalSettings()
                              throws java.io.IOException

Description copied from interface: Server

Request to get the state of Cmake (after a successful handshake).

Specified by:

globalSettings in interface Server

Returns:

global settings of Cmake's state

Throws:

java.io.IOException - I/O failure

getCCompilerExecutable

public java.lang.String getCCompilerExecutable()

Description copied from interface: Server

Returns the compiler executable used C files.

Specified by:

getCCompilerExecutable in interface Server

Returns:

full path to the compiler and compiler executable

getCppCompilerExecutable

public java.lang.String getCppCompilerExecutable()

Description copied from interface: Server

Returns the compiler executable used Cpp files.

Specified by:

getCppCompilerExecutable in interface Server

Returns:

full path to the compiler and compiler executable

getHelloResult

public HelloResult getHelloResult()