xrpl::build_info Namespace Reference

Versioning information for this build. More...

Functions
std::string const &	getVersionString ()
	Server version.
std::string const &	getFullVersionString ()
	Full server version string.
std::uint64_t	encodeSoftwareVersion (std::string_view versionStr)
	Encode an arbitrary server software version in a 64-bit integer.
std::uint64_t	getEncodedVersion ()
	Returns this server's version packed in a 64-bit integer.
bool	isXrpldVersion (std::uint64_t version)
	Check if the encoded software version is an xrpld software version.
bool	isNewerVersion (std::uint64_t version)
	Check if the version is newer than the local node's xrpld software version.

Variables
static constexpr std::uint64_t	kImplementationVersionIdentifier = 0x183B'0000'0000'0000LLU
static constexpr std::uint64_t	kImplementationVersionIdentifierMask = 0xFFFF'0000'0000'0000LLU

Detailed Description

Versioning information for this build.

Function Documentation

getVersionString()

std::string const & xrpl::build_info::getVersionString

(

)

Server version.

Follows the Semantic Versioning Specification: http://semver.org/

Definition at line 63 of file BuildInfo.cpp.

getFullVersionString()

std::string const & xrpl::build_info::getFullVersionString

(

)

Full server version string.

This includes the name of the server. It is used in the peer protocol hello message and also the headers of some HTTP replies.

Definition at line 77 of file BuildInfo.cpp.

encodeSoftwareVersion()

std::uint64_t xrpl::build_info::encodeSoftwareVersion

(

std::string_view

versionStr

)

Encode an arbitrary server software version in a 64-bit integer.

The general format is:

........-........-........-........-........-........-........-........ XXXXXXXX-XXXXXXXX-YYYYYYYY-YYYYYYYY-YYYYYYYY-YYYYYYYY-YYYYYYYY-YYYYYYYY

X: 16 bits identifying the particular implementation Y: 48 bits of data specific to the implementation

The xrpld-specific format (implementation ID is: 0x18 0x3B) is:

00011000-00111011-MMMMMMMM-mmmmmmmm-pppppppp-TTNNNNNN-00000000-00000000

M: 8-bit major version (0-255)
m: 8-bit minor version (0-255)
p: 8-bit patch version (0-255)
T: 11 if neither an RC nor a beta
   10 if an RC
   01 if a beta
N: 6-bit rc/beta number (1-63)

Parameters

the	version string

Returns

the encoded version in a 64-bit integer

Definition at line 87 of file BuildInfo.cpp.

getEncodedVersion()

std::uint64_t xrpl::build_info::getEncodedVersion

(

)

Returns this server's version packed in a 64-bit integer.

Definition at line 151 of file BuildInfo.cpp.

isXrpldVersion()

bool xrpl::build_info::isXrpldVersion

(

std::uint64_t

version

)

Check if the encoded software version is an xrpld software version.

Parameters

version

another node's encoded software version

Returns

true if the version is an xrpld software version, false otherwise

Definition at line 158 of file BuildInfo.cpp.

isNewerVersion()

bool xrpl::build_info::isNewerVersion

(

std::uint64_t

version

)

Check if the version is newer than the local node's xrpld software version.

Parameters

version

another node's encoded software version

Returns

true if the version is newer than the local node's xrpld software version, false otherwise.

Note

This function only understands version numbers that are generated by xrpld. Please see the encodeSoftwareVersion() function for detail.

Definition at line 164 of file BuildInfo.cpp.

Variable Documentation

kImplementationVersionIdentifier

std::uint64_t xrpl::build_info::kImplementationVersionIdentifier = 0x183B'0000'0000'0000LLU

staticconstexpr

Definition at line 83 of file BuildInfo.cpp.

kImplementationVersionIdentifierMask

std::uint64_t xrpl::build_info::kImplementationVersionIdentifierMask = 0xFFFF'0000'0000'0000LLU

staticconstexpr

Definition at line 84 of file BuildInfo.cpp.